stateObservation::kine::internal::KinematicsInternal< T > Class Template Reference

#include <state-observation/tools/rigid-body-kinematics.hpp>

Collaboration diagram for stateObservation::kine::internal::KinematicsInternal< T >:

Classes

struct  Flags
 

Public Member Functions

 KinematicsInternal ()
 
 KinematicsInternal (const CheckedVector3 &position, const CheckedVector3 &linVel, const CheckedVector3 &linAcc, const Orientation &orientation, const CheckedVector3 &angVel, const CheckedVector3 &angAcc)
 constructor of a Kinematics object given each variable independently. More...
 
void reset ()
 
T & fromVector (const Vector &v, typename Flags::Byte=Flags::all)
 
template<typename t = Quaternion>
T & setZero (typename Flags::Byte=Flags::all)
 
Vector toVector (typename Flags::Byte) const
 
Vector toVector () const
 

Static Public Member Functions

static T zeroKinematics (typename Flags::Byte=Flags::all)
 returns an object corresponding to zero kinematics on the desired variables. More...
 

Public Attributes

CheckedVector3 position
 
Orientation orientation
 
CheckedVector3 linVel
 
CheckedVector3 angVel
 
CheckedVector3 linAcc
 
CheckedVector3 angAcc
 

Constructor & Destructor Documentation

◆ KinematicsInternal() [1/2]

◆ KinematicsInternal() [2/2]

template<class T >
stateObservation::kine::internal::KinematicsInternal< T >::KinematicsInternal ( const CheckedVector3 position,
const CheckedVector3 linVel,
const CheckedVector3 linAcc,
const Orientation orientation,
const CheckedVector3 angVel,
const CheckedVector3 angAcc 
)

constructor of a Kinematics object given each variable independently.

Parameters
positionthe position composing the kinematics
linVelthe linear velocity composing the kinematics
linAccthe linear acceleration composing the kinematics
orientationthe orientation composing the kinematics
angVelthe angular velocity composing the kinematics
angAccthe angular acceleration composing the kinematics

Member Function Documentation

◆ fromVector()

template<class T >
T& stateObservation::kine::internal::KinematicsInternal< T >::fromVector ( const Vector v,
typename Flags::Byte  = Flags::all 
)

Fills from vector the flags show which parts of the kinematics to be loaded from the vector the order of the vector is position orientation (quaternion) linevel angvel linAcc angAcc use the flags to define the structure of the vector

◆ reset()

template<class T >
void stateObservation::kine::internal::KinematicsInternal< T >::reset ( )
inline

◆ setZero()

template<class T >
template<typename t = Quaternion>
T& stateObservation::kine::internal::KinematicsInternal< T >::setZero ( typename Flags::Byte  = Flags::all)

initializes at zero all the flagged fields the typename allows to set if the prefered type for rotation is a Matrix3 or a Quaternion (Quaternion by default)

◆ toVector() [1/2]

template<class T >
Vector stateObservation::kine::internal::KinematicsInternal< T >::toVector ( ) const
inline

◆ toVector() [2/2]

template<class T >
Vector stateObservation::kine::internal::KinematicsInternal< T >::toVector ( typename Flags::Byte  ) const
inline

converts the object to a vector the order of the vector is position orientation (quaternion) linevel angvel linAcc angAcc use the flags to define the structure of the vector

◆ zeroKinematics()

template<class T >
static T stateObservation::kine::internal::KinematicsInternal< T >::zeroKinematics ( typename Flags::Byte  = Flags::all)
inlinestatic

returns an object corresponding to zero kinematics on the desired variables.

Parameters
Flagsdefines of which variables the new object must be filled.
Returns
Kinematics

Member Data Documentation

◆ angAcc

◆ angVel

◆ linAcc

◆ linVel

◆ orientation

◆ position


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