MIRA
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
PathFollowTask Class Referenceabstract

Task for precise following a predefined path, that is given as control points. More...

#include <navigation/tasks/PathFollowTask.h>

Inheritance diagram for PathFollowTask:
Inheritance graph
[legend]

Public Types

typedef PathFollowBaseTask< std::vector< Pose2 > > Base
 

Public Member Functions

 PathFollowTask ()
 
 PathFollowTask (float iPrecision, float iGoalTransTolerance, Anglef iGoalOrientTolerance)
 
bool reachedPosition (const Pose2 &pos) const
 
bool reached (const Point2f &pos) const
 
bool reachedOrientation (const Pose2 &pos) const
 
bool reached (float orientation) const
 
void reflect (Reflector &r)
 The reflect method. More...
 
virtual bool reachedPosition (const typename std::vector< Pose2 > ::value_type &pos) const
 
virtual bool reachedOrientation (const typename std::vector< Pose2 > ::value_type &pos) const
 
virtual bool reached (const typename std::vector< Pose2 > ::value_type &pos) const
 
template<typename Reflector >
void reflectTolerance (Reflector &r)
 
void reflectTolerance (PropertySerializer &r)
 
Class const & getClass () const
 

Static Public Member Functions

static PseudoClass const & CLASS ()
 

Public Attributes

std::vector< Pose2points
 The control points of the path (the last point is the goal point). More...
 
float precision
 The precision for following the path (max. distance from path) [m]. More...
 
float goalTranslationTolerance
 The tolerance in for reaching the goal point [m]. More...
 
float goalOrientationTolerance
 The tolerance for reaching the goal point [rad]. More...
 
std::string frame
 The coordinate frame, the points are specified in. More...
 

Protected Member Functions

virtual Class const & internalGetClass () const=0
 

Detailed Description

Task for precise following a predefined path, that is given as control points.

Member Typedef Documentation

◆ Base

typedef PathFollowBaseTask<std::vector<Pose2> > Base

Constructor & Destructor Documentation

◆ PathFollowTask() [1/2]

PathFollowTask ( )
inline

◆ PathFollowTask() [2/2]

PathFollowTask ( float  iPrecision,
float  iGoalTransTolerance,
Anglef  iGoalOrientTolerance 
)
inline

Member Function Documentation

◆ reachedPosition() [1/2]

bool reachedPosition ( const Pose2 pos) const
inline

◆ reached() [1/3]

bool reached ( const Point2f pos) const
inline

◆ reachedOrientation() [1/2]

bool reachedOrientation ( const Pose2 pos) const
inline

◆ reached() [2/3]

bool reached ( float  orientation) const
inline

◆ reflect()

void reflect ( Reflector &  r)
inlineinherited

The reflect method.

◆ reachedPosition() [2/2]

virtual bool reachedPosition ( const typename std::vector< Pose2 > ::value_type &  pos) const
inlinevirtualinherited

◆ reachedOrientation() [2/2]

virtual bool reachedOrientation ( const typename std::vector< Pose2 > ::value_type &  pos) const
inlinevirtualinherited

◆ reached() [3/3]

virtual bool reached ( const typename std::vector< Pose2 > ::value_type &  pos) const
inlinevirtualinherited

◆ reflectTolerance() [1/2]

void reflectTolerance ( Reflector &  r)
inlineinherited

◆ reflectTolerance() [2/2]

void reflectTolerance ( PropertySerializer r)
inlineinherited

Member Data Documentation

◆ points

std::vector< Pose2 > points
inherited

The control points of the path (the last point is the goal point).

◆ precision

float precision
inherited

The precision for following the path (max. distance from path) [m].

◆ goalTranslationTolerance

float goalTranslationTolerance
inherited

The tolerance in for reaching the goal point [m].

◆ goalOrientationTolerance

float goalOrientationTolerance
inherited

The tolerance for reaching the goal point [rad].

◆ frame

std::string frame
inherited

The coordinate frame, the points are specified in.


The documentation for this class was generated from the following file: