okapi::ComposableFilter Class Reference

#include <composableFilter.hpp>

Inheritance diagram for okapi::ComposableFilter:

Public Member Functions
	ComposableFilter (const std::initializer_list< std::shared_ptr< Filter > > &ilist)
	A composable filter is a filter that consists of other filters.
double	filter (double ireading) override
	Filters a value.
double	getOutput () const override
virtual void	addFilter (std::shared_ptr< Filter > ifilter)
	Adds a filter to the end of the sequence.
Public Member Functions inherited from okapi::Filter
virtual	~Filter ()

Protected Attributes
std::vector< std::shared_ptr< Filter > >	filters
double	output = 0

Detailed Description

Definition at line 15 of file composableFilter.hpp.

Constructor & Destructor Documentation

ComposableFilter()

okapi::ComposableFilter::ComposableFilter

(

const std::initializer_list< std::shared_ptr< Filter > > &

ilist

)

A composable filter is a filter that consists of other filters.

The input signal is passed through each filter in sequence. The final output of this filter is the output of the last filter.

Parameters

ilist

The filters to use in sequence.

Member Function Documentation

addFilter()

virtual void okapi::ComposableFilter::addFilter ( std::shared_ptr< Filter >  ifilter )

virtual

Adds a filter to the end of the sequence.

Parameters

ifilter

The filter to add.

filter()

double okapi::ComposableFilter::filter ( double  ireading )

overridevirtual

Filters a value.

Parameters

ireading

A new measurement.

Returns

The filtered result.

Implements okapi::Filter.

getOutput()

double okapi::ComposableFilter::getOutput ( ) const

overridevirtual

Returns

The previous output from filter.

Implements okapi::Filter.

Member Data Documentation

filters

std::vector<std::shared_ptr<Filter> > okapi::ComposableFilter::filters

protected

Definition at line 47 of file composableFilter.hpp.

output

double okapi::ComposableFilter::output = 0

protected

Definition at line 48 of file composableFilter.hpp.

---

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

• include/okapi/api/filter/composableFilter.hpp