MovingWindowFilter< T > Class Template Reference

Base class for MovingWindowFilter. More...

#include <MovingWindowFilter.hh>

Public Member Functions
	MovingWindowFilter ()
	Constructor.
virtual	~MovingWindowFilter ()
	Destructor.
void	SetWindowSize (unsigned int _n)
	Set window size.
void	Update (T _val)
	Update value of filter.
T	Value ()
	Get filtered result.
bool	WindowFilled () const
	Get whether the window has been filled.
unsigned int	WindowSize () const
	Get the window size.

Protected Member Functions
	MovingWindowFilter (MovingWindowFilterPrivate< T > &_d)
	Allow subclasses to initialize their own data pointer.

Protected Attributes
std::unique_ptr< MovingWindowFilterPrivate< T > >	dataPtr
	Data pointer.

Detailed Description

template<typename T>
class gz::common::MovingWindowFilter< T >

Base class for MovingWindowFilter.

Constructor & Destructor Documentation

MovingWindowFilter() [1/2]

template<typename T >

MovingWindowFilter

(

)

Constructor.

~MovingWindowFilter()

template<typename T >

~MovingWindowFilter ( )

virtual

Destructor.

MovingWindowFilter() [2/2]

template<typename T >

MovingWindowFilter ( MovingWindowFilterPrivate< T > &  _d )

explicitprotected

Allow subclasses to initialize their own data pointer.

Parameters

[in]

_d

Reference to data pointer.

Member Function Documentation

SetWindowSize()

template<typename T >

void SetWindowSize

(

unsigned int

_n

)

Set window size.

Parameters

[in]

_n

new desired window size

Update()

template<typename T >

void Update

(

T

_val

)

Update value of filter.

Parameters

[in]

_val

new raw value

Value()

template<typename T >

T Value

(

)

Get filtered result.

Returns

Latest filtered value

WindowFilled()

template<typename T >

bool WindowFilled

(

)

const

Get whether the window has been filled.

Returns

True if the window has been filled.

WindowSize()

template<typename T >

unsigned int WindowSize

(

)

const

Get the window size.

Returns

The size of the moving window.

Member Data Documentation

dataPtr

template<typename T >

std::unique_ptr<MovingWindowFilterPrivate<T> > dataPtr

protected

Data pointer.

---

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

• MovingWindowFilter.hh