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

Sub task that has the purpose to reach a given orientation with at least the given variance. More...

#include <navigation/tasks/OrientationTask.h>

Inheritance diagram for OrientationTask:
Inheritance graph
[legend]

Public Member Functions

 OrientationTask ()
 Create orientation task with orientation 0 and variance 0. More...
 
 OrientationTask (float p, float t, const std::string &f="/GlobalFrame")
 Create orientation task with given orientation and variance. More...
 
template<typename Reflector >
void reflectTolerance (Reflector &r)
 
void reflectTolerance (PropertySerializer &r)
 
template<typename Reflector >
void reflect (Reflector &r)
 The reflect method. More...
 
bool reached (float p) const
 Calculates if the task is reached for the current orientation p. More...
 
Class const & getClass () const
 

Static Public Member Functions

static PseudoClass const & CLASS ()
 

Public Attributes

Anglef phi
 The requested orientation. More...
 
float tolerance
 The requested tolerance. More...
 
std::string frameID
 The frame the angle is related to. More...
 

Protected Member Functions

virtual Class const & internalGetClass () const=0
 

Detailed Description

Sub task that has the purpose to reach a given orientation with at least the given variance.

Constructor & Destructor Documentation

◆ OrientationTask() [1/2]

OrientationTask ( )
inline

Create orientation task with orientation 0 and variance 0.

◆ OrientationTask() [2/2]

OrientationTask ( float  p,
float  t,
const std::string &  f = "/GlobalFrame" 
)
inline

Create orientation task with given orientation and variance.

Parameters
[in]pThe requested orientation in [rad].
[in]tThe requested variance in [rad].
[in]fThe frame id the angle is related to.

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.

◆ reached()

bool reached ( float  p) const
inline

Calculates if the task is reached for the current orientation p.

Member Data Documentation

◆ phi

Anglef phi

The requested orientation.

◆ tolerance

float tolerance

The requested tolerance.

◆ frameID

std::string frameID

The frame the angle is related to.


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