Filter Class Reference

Abstract base class that defines the interface for single variable filters Derived classes must implement the filter and reset methods. More...

#include <filter.hpp>

Inheritance diagram for Filter:

Collaboration diagram for Filter:

Public Member Functions
virtual	~Filter ()=default
	Virtual destructor for safe polymorphic use.
virtual double	filter (double input)=0
	Apply the filter to a new input value.
virtual void	reset (double value=0.0)=0
	Reset the filter to a specific value.

Detailed Description

Abstract base class that defines the interface for single variable filters Derived classes must implement the filter and reset methods.

Definition at line 8 of file filter.hpp.

Constructor & Destructor Documentation

~Filter()

virtual Filter::~Filter ( )

virtualdefault

Virtual destructor for safe polymorphic use.

Member Function Documentation

filter()

virtual double Filter::filter ( double  input )

pure virtual

Apply the filter to a new input value.

Parameters

input

New input value

Returns

Filtered value

Implemented in LowPassFilter.

reset()

virtual void Filter::reset ( double  value = 0.0 )

pure virtual

Reset the filter to a specific value.

Parameters

value

Value to reset the filter to (default is 0.0)

Implemented in LowPassFilter.

---

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

• src/common_lib/include/common_lib/filters/filter.hpp