Sub task that has the purpose of limiting the direction the robot drives. More...
#include <navigation/tasks/PreferredDirectionTask.h>
Inheritance diagram for PreferredDirectionTask:
Public Types | |
| enum | Direction { BOTH = 0, BACKWARD = -1, FORWARD = 1 } |
| There are three possible directions that can be allowed. More... | |
Public Member Functions | |
| PreferredDirectionTask (Direction iDirection=FORWARD, float iWrongDirectionCost=1.0f) | |
| Creates a direction task with a given allowed direction and a cost for not driving in that direction. 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 | |
| Direction | direction |
| The preferred direction. More... | |
| float | wrongDirectionCost |
| Costs for driving into not-preferred direction. More... | |
Protected Member Functions | |
| virtual Class const & | internalGetClass () const=0 |
Detailed Description
Sub task that has the purpose of limiting the direction the robot drives.
Member Enumeration Documentation
◆ Direction
| enum Direction |
Constructor & Destructor Documentation
◆ PreferredDirectionTask()
|
inline |
Creates a direction task with a given allowed direction and a cost for not driving in that direction.
If cost is 0 also driving in the wrong direction is allowed. If cost is 1 driving in wrong direction is totally forbidden.
- Parameters
-
[in] iDirection The requested direction. [in] iWrongDirectionCost The costs.
Member Function Documentation
◆ reflect()
|
inline |
The reflect method.
Member Data Documentation
◆ direction
| Direction direction |
The preferred direction.
◆ wrongDirectionCost
| float wrongDirectionCost |
Costs for driving into not-preferred direction.
The documentation for this class was generated from the following file:
- include/navigation/tasks/PreferredDirectionTask.h
