argos_lib::HysteresisFilter< T > Class Template Reference

A simple hysteresis filter for giving a bool output for a threshold. More...

#include <hysteresis_filter.h>

Public Member Functions
	HysteresisFilter ()=delete
	HysteresisFilter (T deactivateThreshold, T activateThreshold)
	Construct a new Hysteresis Filter object. More...
bool	operator() (T newValue)
	Gets new status after applying hysteresis. More...

Private Attributes
const T	m_activateThreshold
	Threshold above which output becomes true. More...
const T	m_deactivateThreshold
	Threshold below which output becomes false. More...
bool	m_currentState
	Latest state after applying hysteresis. More...

Detailed Description

template<typename T>
class argos_lib::HysteresisFilter< T >

A simple hysteresis filter for giving a bool output for a threshold.

Template Parameters

T	Type of threshold values

Constructor & Destructor Documentation

HysteresisFilter() [1/2]

template<typename T >

argos_lib::HysteresisFilter< T >::HysteresisFilter ( )

delete

HysteresisFilter() [2/2]

template<typename T >

argos_lib::HysteresisFilter< T >::HysteresisFilter ( T  deactivateThreshold, T  activateThreshold  )

inline

Construct a new Hysteresis Filter object.

Parameters

deactivateThreshold	Value below which output becomes false
activateThreshold	Value above which output becomes true

Member Function Documentation

operator()()

template<typename T >

bool argos_lib::HysteresisFilter< T >::operator() ( T  newValue )

inline

Gets new status after applying hysteresis.

Parameters

newValue

Latest raw value to update the filter

Returns

Filtered value after applying newValue

Member Data Documentation

m_activateThreshold

template<typename T >

const T argos_lib::HysteresisFilter< T >::m_activateThreshold

private

Threshold above which output becomes true.

m_currentState

template<typename T >

bool argos_lib::HysteresisFilter< T >::m_currentState

private

Latest state after applying hysteresis.

m_deactivateThreshold

template<typename T >

const T argos_lib::HysteresisFilter< T >::m_deactivateThreshold

private

Threshold below which output becomes false.

---

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

• src/argos_lib/include/argos_lib/general/hysteresis_filter.h