hermite  0.0.1
Public Member Functions | List of all members
hermite::Pose< D > Class Template Reference

A pose object. More...

#include <pose.hpp>

Public Member Functions

 Pose ()
 Default constructor. More...
 
 Pose (const double time, const Vector< D > pos, const Vector< D > vel)
 Constructor. More...
 
 Pose (const Pose< D > &other)
 Copy constructor.
 
Pose< D > & operator= (const Pose< D > &other)
 Assignment operator.
 
 ~Pose ()=default
 Destructor.
 
Vector< D > getPos () const
 Gets position vector. More...
 
Vector< D > getVel () const
 Gets velocity vector. More...
 
double getTime () const
 Gets time. More...
 
void setPos (const Vector< D > &pos)
 Sets position vector. More...
 
void setVel (const Vector< D > &vel)
 Sets velocity vector. More...
 
void setTime (const double &time)
 Sets time. More...
 

Detailed Description

template<std::size_t D>
class hermite::Pose< D >

A pose object.

Poses in multiple dimensions can use multiple Pose objects.

It is recommended to create a pose using makePose().

Constructor & Destructor Documentation

◆ Pose() [1/2]

template<std::size_t D>
hermite::Pose< D >::Pose ( )
inline

Default constructor.

Initializes all values to zero

◆ Pose() [2/2]

template<std::size_t D>
hermite::Pose< D >::Pose ( const double  time,
const Vector< D >  pos,
const Vector< D >  vel 
)
inline

Constructor.

Parameters
timeTime to reach this pose
posPosition vector
velVelocity vector

Member Function Documentation

◆ getPos()

template<std::size_t D>
Vector<D> hermite::Pose< D >::getPos ( ) const
inline

Gets position vector.

Returns
Position vector

◆ getTime()

template<std::size_t D>
double hermite::Pose< D >::getTime ( ) const
inline

Gets time.

Returns
time

◆ getVel()

template<std::size_t D>
Vector<D> hermite::Pose< D >::getVel ( ) const
inline

Gets velocity vector.

Returns
Velocity vector

◆ setPos()

template<std::size_t D>
void hermite::Pose< D >::setPos ( const Vector< D > &  pos)
inline

Sets position vector.

Parameters
posPosition vector

◆ setTime()

template<std::size_t D>
void hermite::Pose< D >::setTime ( const double &  time)
inline

Sets time.

Parameters
timeTime

◆ setVel()

template<std::size_t D>
void hermite::Pose< D >::setVel ( const Vector< D > &  vel)
inline

Sets velocity vector.

Parameters
velVelocity vector

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