bst::ConsecutiveValuesFilter< T > Class Template Reference

A simple counting filter that allows for some noise. More...

#include <filters.hpp>

Collaboration diagram for bst::ConsecutiveValuesFilter< T >:

Public Member Functions
	ConsecutiveValuesFilter (T initial_value, size_t filter_threshold=0)
	Constructor for the ConsecutiveValuesFilter. More...
	~ConsecutiveValuesFilter ()=default
	Destructor for the ConsecutiveValuesFilter. More...
bool	addValue (T value)
	The input stream for this filter. More...
T	getCurrentValue () const
	Returns the current value. More...
void	reset (T value)
	Resets the filter's counter and sets the current value. More...
void	setFilterThreshold (size_t filter_threshold)

Private Attributes
size_t	current_count_ {0}
	The current count of consecutive new values. More...
T	current_value_ {}
	The current value. More...
size_t	filter_threshold_
	The filter threshold. More...
T	new_value_ {}
	The new value that is being counted. More...

Detailed Description

template<class T>
class bst::ConsecutiveValuesFilter< T >

A simple counting filter that allows for some noise.

Template Parameters

T	The type of data to filter (enumerations generally).

Constructor & Destructor Documentation

ConsecutiveValuesFilter()

template<class T >

bst::ConsecutiveValuesFilter< T >::ConsecutiveValuesFilter ( T  initial_value, size_t  filter_threshold = 0  )

inline

Constructor for the ConsecutiveValuesFilter.

Parameters

initial_value	The initial value to set the filter to.
filter_threshold	The number of consecutive values that must be seen before the filter will pass the value.

~ConsecutiveValuesFilter()

template<class T >

bst::ConsecutiveValuesFilter< T >::~ConsecutiveValuesFilter ( )

default

Destructor for the ConsecutiveValuesFilter.

Member Function Documentation

reset()

template<class T >

void bst::ConsecutiveValuesFilter< T >::reset ( T  value )

inline

Resets the filter's counter and sets the current value.

Parameters

value

The value to set the current value to.

References bst::ConsecutiveValuesFilter< T >::current_count_, and bst::ConsecutiveValuesFilter< T >::current_value_.

setFilterThreshold()

template<class T >

void bst::ConsecutiveValuesFilter< T >::setFilterThreshold ( size_t  filter_threshold )

inline

References bst::ConsecutiveValuesFilter< T >::filter_threshold_.

addValue()

template<class T >

bool bst::ConsecutiveValuesFilter< T >::addValue ( T  value )

inline

The input stream for this filter.

Parameters

value

The input

Returns

true if the filtered value has changed, false otherwise.

References bst::ConsecutiveValuesFilter< T >::current_count_, bst::ConsecutiveValuesFilter< T >::current_value_, bst::ConsecutiveValuesFilter< T >::filter_threshold_, and bst::ConsecutiveValuesFilter< T >::new_value_.

getCurrentValue()

template<class T >

T bst::ConsecutiveValuesFilter< T >::getCurrentValue ( ) const

inline

Returns the current value.

References bst::ConsecutiveValuesFilter< T >::current_value_.

Member Data Documentation

filter_threshold_

template<class T >

size_t bst::ConsecutiveValuesFilter< T >::filter_threshold_

private

The filter threshold.

Referenced by bst::ConsecutiveValuesFilter< T >::addValue(), and bst::ConsecutiveValuesFilter< T >::setFilterThreshold().

current_count_

template<class T >

size_t bst::ConsecutiveValuesFilter< T >::current_count_ {0}

private

The current count of consecutive new values.

Referenced by bst::ConsecutiveValuesFilter< T >::addValue(), and bst::ConsecutiveValuesFilter< T >::reset().

current_value_

template<class T >

T bst::ConsecutiveValuesFilter< T >::current_value_ {}

private

The current value.

Referenced by bst::ConsecutiveValuesFilter< T >::addValue(), bst::ConsecutiveValuesFilter< T >::getCurrentValue(), and bst::ConsecutiveValuesFilter< T >::reset().

new_value_

template<class T >

T bst::ConsecutiveValuesFilter< T >::new_value_ {}

private

The new value that is being counted.

Referenced by bst::ConsecutiveValuesFilter< T >::addValue().