MovingWindowFilter< T > Class Template Reference
Base class for MovingWindowFilter. More...
#include <MovingWindowFilter.hh>
Public Member Functions | |
| MovingWindowFilter () | |
| Constructor. More... | |
| virtual | ~MovingWindowFilter () |
| Destructor. More... | |
| void | SetWindowSize (unsigned int _n) |
| Set window size. More... | |
| void | Update (T _val) |
| Update value of filter. More... | |
| T | Value () |
| Get filtered result. More... | |
| bool | WindowFilled () const |
| Get whether the window has been filled. More... | |
| unsigned int | WindowSize () const |
| Get the window size. More... | |
Protected Member Functions | |
| MovingWindowFilter (MovingWindowFilterPrivate< T > &_d) | |
| Allow subclasses to initialize their own data pointer. More... | |
Protected Attributes | |
| std::unique_ptr< MovingWindowFilterPrivate< T > > | dataPtr |
| Data pointer. More... | |
Detailed Description
template<typename T>
class ignition::common::MovingWindowFilter< T >
Base class for MovingWindowFilter.
Constructor & Destructor Documentation
◆ MovingWindowFilter() [1/2]
Constructor.
◆ ~MovingWindowFilter()
|
virtual |
Destructor.
◆ MovingWindowFilter() [2/2]
|
explicitprotected |
Allow subclasses to initialize their own data pointer.
- Parameters
-
[in] _d Reference to data pointer.
Member Function Documentation
◆ SetWindowSize()
| void SetWindowSize | ( | unsigned int | _n | ) |
Set window size.
- Parameters
-
[in] _n new desired window size
◆ Update()
| void Update | ( | T | _val | ) |
Update value of filter.
- Parameters
-
[in] _val new raw value
◆ Value()
| T Value |
Get filtered result.
- Returns
- Latest filtered value
◆ WindowFilled()
| bool WindowFilled |
Get whether the window has been filled.
- Returns
- True if the window has been filled.
◆ WindowSize()
| unsigned int WindowSize |
Get the window size.
- Returns
- The size of the moving window.
Member Data Documentation
◆ dataPtr
|
protected |
Data pointer.
The documentation for this class was generated from the following file: