Public Member Functions | Protected Attributes | List of all members
gazebo::math::Filter< T > Class Template Referenceabstract

Filter base class. More...

#include <math/gzmath.hh>

Inheritance diagram for gazebo::math::Filter< T >:
Inheritance graph
[legend]

Public Member Functions

virtual ~Filter ()
 Destructor. More...
 
virtual const T & GetValue ()
 Get the output of the filter. More...
 
virtual void SetFc (double _fc, double _fs)=0
 Set the cutoff frequency and sample rate. More...
 
virtual void SetValue (const T &_val)
 Set the output of the filter. More...
 

Protected Attributes

y0
 Output. More...
 

Detailed Description

template<class T>
class gazebo::math::Filter< T >

Filter base class.

Constructor & Destructor Documentation

template<class T>
virtual gazebo::math::Filter< T >::~Filter ( )
inlinevirtual

Destructor.

Member Function Documentation

template<class T>
virtual const T& gazebo::math::Filter< T >::GetValue ( )
inlinevirtual

Get the output of the filter.

Returns
Filter's output.
template<class T>
virtual void gazebo::math::Filter< T >::SetFc ( double  _fc,
double  _fs 
)
pure virtual

Set the cutoff frequency and sample rate.

Parameters
[in]_fcCutoff frequency.
[in]_fsSample rate.

Implemented in gazebo::math::BiQuad< T >, gazebo::math::BiQuad< math::Vector3 >, gazebo::math::OnePole< T >, gazebo::math::OnePole< math::Quaternion >, and gazebo::math::OnePole< math::Vector3 >.

template<class T>
virtual void gazebo::math::Filter< T >::SetValue ( const T &  _val)
inlinevirtual

Set the output of the filter.

Parameters
[in]_valNew value.

Reimplemented in gazebo::math::BiQuad< T >, and gazebo::math::BiQuad< math::Vector3 >.

Member Data Documentation

template<class T>
T gazebo::math::Filter< T >::y0
protected

Output.


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