Task for restricting the permitted movement to an area. More...
#include <navigation/tasks/RestrictAreaTask.h>
Inheritance diagram for RestrictAreaTask:
Public Member Functions | |
| RestrictAreaTask () | |
| Default constructor. More... | |
| RestrictAreaTask (Polygon2f area, const std::string &f="/GlobalFrame") | |
| Creates a task that limits the movement to a polygon. More... | |
| RestrictAreaTask (std::vector< Polygon2f > areas, const std::string &f="/GlobalFrame") | |
| Creates a task that limits the movement to a union of a vector of polygons. More... | |
| template<typename Reflector > | |
| void | reflect (Reflector &r) |
| The reflect method. More... | |
| Class const & | getClass () const |
Static Public Member Functions | |
| static PseudoClass const & | CLASS () |
Public Attributes | |
| std::vector< Polygon2f > | restrictingAreas |
| The restricted area. More... | |
| std::string | frameID |
| The frame the restricted area is related to. More... | |
Protected Member Functions | |
| virtual Class const & | internalGetClass () const=0 |
Detailed Description
Task for restricting the permitted movement to an area.
Constructor & Destructor Documentation
◆ RestrictAreaTask() [1/3]
|
inline |
Default constructor.
◆ RestrictAreaTask() [2/3]
|
inline |
Creates a task that limits the movement to a polygon.
- Parameters
-
[in] area The restricting area [in] f The frame ID.
◆ RestrictAreaTask() [3/3]
|
inline |
Creates a task that limits the movement to a union of a vector of polygons.
- Parameters
-
[in] areas The restricting area [in] f The frame ID.
Member Function Documentation
◆ reflect()
|
inline |
The reflect method.
Member Data Documentation
◆ restrictingAreas
| std::vector<Polygon2f> restrictingAreas |
The restricted area.
◆ frameID
| std::string frameID |
The frame the restricted area is related to.
The documentation for this class was generated from the following file:
- include/navigation/tasks/RestrictAreaTask.h
