trap::algorithms::Ramp2D< ValueUnit, TimeUnit > Class Template Reference

#include <ramp_2d.hpp>

Public Types
using	Vector2D = fang::math::Vector2D< ValueUnit >

Public Member Functions
	Ramp2D (const Vector2D &initialValue, double rampSpeed)
void	setTarget (const Vector2D &target)
Vector2D	getTarget () const
void	setSpeed (double speed)
Vector2D	getValue () const
bool	isTargetReached () const
void	update ()

Member Typedef Documentation

Vector2D

template<typename ValueUnit , typename TimeUnit >

using trap::algorithms::Ramp2D< ValueUnit, TimeUnit >::Vector2D = fang::math::Vector2D<ValueUnit>

Constructor & Destructor Documentation

Ramp2D()

template<typename ValueUnit , typename TimeUnit >

trap::algorithms::Ramp2D< ValueUnit, TimeUnit >::Ramp2D ( const Vector2D &  initialValue, double  rampSpeed  )

inline

Ramp speed is how much value unit per time unit

Member Function Documentation

getTarget()

template<typename ValueUnit , typename TimeUnit >

Vector2D trap::algorithms::Ramp2D< ValueUnit, TimeUnit >::getTarget ( ) const

inline

getValue()

template<typename ValueUnit , typename TimeUnit >

Vector2D trap::algorithms::Ramp2D< ValueUnit, TimeUnit >::getValue ( ) const

inline

isTargetReached()

template<typename ValueUnit , typename TimeUnit >

bool trap::algorithms::Ramp2D< ValueUnit, TimeUnit >::isTargetReached ( ) const

inline

setSpeed()

template<typename ValueUnit , typename TimeUnit >

void trap::algorithms::Ramp2D< ValueUnit, TimeUnit >::setSpeed ( double  speed )

inline

The speed of the ramps are only changed if a non-zero delta between the curretn values and target values are different

setTarget()

template<typename ValueUnit , typename TimeUnit >

void trap::algorithms::Ramp2D< ValueUnit, TimeUnit >::setTarget ( const Vector2D &  target )

inline

update()

template<typename ValueUnit , typename TimeUnit >

void trap::algorithms::Ramp2D< ValueUnit, TimeUnit >::update ( )

inline

---

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

• fang-mcb-project/src/wrap/trap/algorithms/ramp_2d.hpp