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

Task for docking to a given position with a given orientation. More...

#include <navigation/tasks/DockingTask.h>

Inheritance diagram for DockingTask:
Inheritance graph
[legend]

Public Member Functions

EIGEN_MAKE_ALIGNED_OPERATOR_NEW DockingTask ()
 Creates a task with both tolerances 0. More...
 
 DockingTask (const Pose2 &p, const Pose2 &t, const std::string &g)
 Creates a task with given pose and a tolerance. 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

Pose2 pose
 The requested pose. More...
 
Pose2 tolerance
 The requested tolerance. More...
 
std::string goalFrame
 Frame of the goal. More...
 

Protected Member Functions

virtual Class const & internalGetClass () const=0
 

Detailed Description

Task for docking to a given position with a given orientation.

Constructor & Destructor Documentation

◆ DockingTask() [1/2]

EIGEN_MAKE_ALIGNED_OPERATOR_NEW DockingTask ( )
inline

Creates a task with both tolerances 0.

◆ DockingTask() [2/2]

DockingTask ( const Pose2 p,
const Pose2 t,
const std::string &  g 
)
inline

Creates a task with given pose and a tolerance.

Parameters
[in]pThe requested pose.
[in]tThe requested tolerance.
[in]gThe frame of the goal

Member Function Documentation

◆ reflect()

void reflect ( Reflector &  r)
inline

The reflect method.

Member Data Documentation

◆ pose

Pose2 pose

The requested pose.

◆ tolerance

Pose2 tolerance

The requested tolerance.

◆ goalFrame

std::string goalFrame

Frame of the goal.


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