WPILibC++  2019.3.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
frc::Filter Class Referenceabstract

Interface for filters. More...

#include <Filter.h>

Inheritance diagram for frc::Filter:
frc::PIDSource frc::LinearDigitalFilter

Public Member Functions

 Filter (PIDSource &source)
 
 Filter (std::shared_ptr< PIDSource > source)
 
 Filter (Filter &&)=default
 
Filteroperator= (Filter &&)=default
 
void SetPIDSourceType (PIDSourceType pidSource) override
 Set which parameter you are using as a process control variable. More...
 
PIDSourceType GetPIDSourceType () const override
 
double PIDGet () override=0
 
virtual double Get () const =0
 Returns the current filter estimate without also inserting new data as PIDGet() would do. More...
 
virtual void Reset ()=0
 Reset the filter state.
 

Protected Member Functions

double PIDGetSource ()
 Calls PIDGet() of source. More...
 

Additional Inherited Members

- Protected Attributes inherited from frc::PIDSource
PIDSourceType m_pidSource = PIDSourceType::kDisplacement
 

Detailed Description

Interface for filters.

Member Function Documentation

virtual double frc::Filter::Get ( ) const
pure virtual

Returns the current filter estimate without also inserting new data as PIDGet() would do.

Returns
The current filter estimate

Implemented in frc::LinearDigitalFilter.

double frc::Filter::PIDGetSource ( )
protected

Calls PIDGet() of source.

Returns
Current value of source
void frc::Filter::SetPIDSourceType ( PIDSourceType  pidSource)
overridevirtual

Set which parameter you are using as a process control variable.

Parameters
pidSourceAn enum to select the parameter.

Reimplemented from frc::PIDSource.


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