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

#include <navigation/tasks/PathFollowTask.h>

Inheritance diagram for PathFollowBaseTaskCommon:
Inheritance graph
[legend]

Public Member Functions

 PathFollowBaseTaskCommon ()
 Creates a path follow task with precision = goalTolerance = 0.1m and rotation tolerance 10 degrees. More...
 
 PathFollowBaseTaskCommon (float iPrecision, float iGoalTransTolerance, Anglef iGoalOrientTolerance)
 Creates a task with given precision and a tolerance. More...
 
template<typename Reflector >
void reflectTolerance (Reflector &r)
 
void reflectTolerance (PropertySerializer &r)
 
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

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

◆ PathFollowBaseTaskCommon() [1/2]

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

◆ PathFollowBaseTaskCommon() [2/2]

PathFollowBaseTaskCommon ( 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

◆ reflectTolerance() [1/2]

void reflectTolerance ( Reflector &  r)
inline

◆ reflectTolerance() [2/2]

void reflectTolerance ( PropertySerializer r)
inline

◆ reflect()

void reflect ( Reflector &  r)
inline

The reflect method.

Member Data Documentation

◆ precision

float precision

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

◆ goalTranslationTolerance

float goalTranslationTolerance

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

◆ goalOrientationTolerance

float goalOrientationTolerance

The tolerance for reaching the goal point [rad].

◆ frame

std::string frame

The coordinate frame, the points are specified in.


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