MIRA
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
PathFollowBaseTask< T > Class Template Referenceabstract

#include <navigation/tasks/PathFollowTask.h>

Inheritance diagram for PathFollowBaseTask< T >:
Inheritance graph
[legend]

Public Member Functions

 PathFollowBaseTask ()
 Creates a path follow task with precision = goalTolerance = 0.1m and rotation tolerance 10 degrees. More...
 
 PathFollowBaseTask (float iPrecision, float iGoalTransTolerance, Anglef iGoalOrientTolerance)
 Creates a task with given precision and a tolerance. More...
 
template<typename Reflector >
void reflect (Reflector &r)
 The reflect method. More...
 
virtual bool reachedPosition (const typename T::value_type &pos) const
 
virtual bool reachedOrientation (const typename T::value_type &pos) const
 
virtual bool reached (const typename T::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

points
 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
 

Constructor & Destructor Documentation

◆ PathFollowBaseTask() [1/2]

PathFollowBaseTask ( )
inline

Creates a path follow task with precision = goalTolerance = 0.1m and rotation tolerance 10 degrees.

◆ PathFollowBaseTask() [2/2]

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

Creates a task with given precision and a tolerance.

Parameters
[in]iPrecisionThe precision for following the path (max. distance from path) [m].
[in]iGoalToleranceThe tolerance in for reaching the goal point [m].

Member Function Documentation

◆ reflect()

void reflect ( Reflector &  r)
inline

The reflect method.

◆ reachedPosition()

virtual bool reachedPosition ( const typename T::value_type &  pos) const
inlinevirtual

◆ reachedOrientation()

virtual bool reachedOrientation ( const typename T::value_type &  pos) const
inlinevirtual

◆ reached()

virtual bool reached ( const typename T::value_type &  pos) const
inlinevirtual

◆ reflectTolerance() [1/2]

void reflectTolerance ( Reflector &  r)
inlineinherited

◆ reflectTolerance() [2/2]

void reflectTolerance ( PropertySerializer r)
inlineinherited

Member Data Documentation

◆ points

T points

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: