LocalGuidance
A library that generates velocity references to follow a path.
robot_utils::FilteredVariable< T > Class Template Reference

#include <FilteredVariable.hpp>

Public Member Functions

T & operator= (const T &other)
 
 FilteredVariable (void)
 
 FilteredVariable (const T &other)
 
 FilteredVariable (const T &other, double a)
 
void setAlpha (double a)
 
 ~FilteredVariable (void)
 
void initialize (const T &other)
 
void reset ()
 
void update (const T &newVal)
 
bool isInitialized ()
 
val ()
 

Public Attributes

value
 
double alpha
 
bool initialized
 

Detailed Description

template<class T>
class robot_utils::FilteredVariable< T >

implements a low-pass filter.

Constructor & Destructor Documentation

◆ FilteredVariable() [1/3]

template<class T >
robot_utils::FilteredVariable< T >::FilteredVariable ( void  )
inline

◆ FilteredVariable() [2/3]

template<class T >
robot_utils::FilteredVariable< T >::FilteredVariable ( const T &  other)
inline

◆ FilteredVariable() [3/3]

template<class T >
robot_utils::FilteredVariable< T >::FilteredVariable ( const T &  other,
double  a 
)
inline

◆ ~FilteredVariable()

template<class T >
robot_utils::FilteredVariable< T >::~FilteredVariable ( void  )
inline

Member Function Documentation

◆ initialize()

template<class T >
void robot_utils::FilteredVariable< T >::initialize ( const T &  other)
inline

◆ isInitialized()

template<class T >
bool robot_utils::FilteredVariable< T >::isInitialized ( )
inline

◆ operator=()

template<class T >
T& robot_utils::FilteredVariable< T >::operator= ( const T &  other)
inline

◆ reset()

template<class T >
void robot_utils::FilteredVariable< T >::reset ( )
inline

◆ setAlpha()

template<class T >
void robot_utils::FilteredVariable< T >::setAlpha ( double  a)
inline

◆ update()

template<class T >
void robot_utils::FilteredVariable< T >::update ( const T &  newVal)
inline

◆ val()

template<class T >
T robot_utils::FilteredVariable< T >::val ( )
inline

Member Data Documentation

◆ alpha

template<class T >
double robot_utils::FilteredVariable< T >::alpha

◆ initialized

template<class T >
bool robot_utils::FilteredVariable< T >::initialized

◆ value

template<class T >
T robot_utils::FilteredVariable< T >::value

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