List of all members | Public Member Functions | Protected Member Functions | Friends
ButterworthFilter Class Reference

#include <ArmarXCore/observers/filters/ButterworthFilter.h>

+ Inheritance diagram for ButterworthFilter:

Public Member Functions

 ButterworthFilter (double frequency, int sampleRate, PassType passType, double resonance)
 
VariantBasePtr calculate (const Ice::Current &=Ice::emptyCurrent) const override
 
StringFloatDictionary getProperties (const Ice::Current &) const override
 
double getRawValue () const
 
ParameterTypeList getSupportedTypes (const Ice::Current &=Ice::emptyCurrent) const override
 This filter supports: Int, Long, Float, Double. More...
 
VariantBasePtr getValue (const Ice::Current &=Ice::emptyCurrent) const override
 
void reset (double frequency, int sampleRate, PassType passType, double resonance)
 
void setInitialValue (double value)
 
void setProperties (const StringFloatDictionary &values, const Ice::Current &) override
 
void update (double newInput)
 
void update (Ice::Long, const VariantBasePtr &value, const Ice::Current &=Ice::emptyCurrent) override
 
- Public Member Functions inherited from DatafieldFilter
bool checkTypeSupport (VariantTypeId variantType, const Ice::Current &c=Ice::emptyCurrent) const override
 Checks whether the given type is supported. More...
 
 DatafieldFilter ()
 
 DatafieldFilter (DatafieldFilter const &filter)
 
const TimeVariantBaseMap & getDataHistory () const
 
armarx::StringFloatDictionary getProperties (const Ice::Current &c=Ice::emptyCurrent) const override
 
VariantBasePtr getValue (const Ice::Current &c=Ice::emptyCurrent) const override
 Retrieves the current, filtered value. More...
 
void setProperties (const armarx::StringFloatDictionary &newValues, const Ice::Current &c=Ice::emptyCurrent) override
 
void update (Ice::Long timestamp, const VariantBasePtr &value, const Ice::Current &c=Ice::emptyCurrent) override
 Adds the given value to the data map, erases old values if maximum size was reached, and calculates the new filtered value. More...
 

Protected Member Functions

 ButterworthFilter ()
 

Friends

template<class BaseClass , class VariantClass >
class ::armarx::GenericFactory
 

Additional Inherited Members

- Protected Attributes inherited from DatafieldFilter
TimeVariantBaseMap dataHistory
 
std::mutex historyMutex
 

Detailed Description

Definition at line 40 of file ButterworthFilter.h.

Constructor & Destructor Documentation

◆ ButterworthFilter() [1/2]

ButterworthFilter ( )
protected

Definition at line 33 of file ButterworthFilter.cpp.

◆ ButterworthFilter() [2/2]

ButterworthFilter ( double  frequency,
int  sampleRate,
PassType  passType,
double  resonance 
)

Member Function Documentation

◆ calculate()

armarx::VariantBasePtr calculate ( const Ice::Current &  = Ice::emptyCurrent) const
override

Definition at line 149 of file ButterworthFilter.cpp.

◆ getProperties()

StringFloatDictionary getProperties ( const Ice::Current &  ) const
override

Definition at line 157 of file ButterworthFilter.cpp.

◆ getRawValue()

double getRawValue ( ) const

Definition at line 143 of file ButterworthFilter.cpp.

◆ getSupportedTypes()

armarx::ParameterTypeList getSupportedTypes ( const Ice::Current &  = Ice::emptyCurrent) const
override

This filter supports: Int, Long, Float, Double.

Returns
List of VariantTypes

Definition at line 82 of file ButterworthFilter.cpp.

◆ getValue()

armarx::VariantBasePtr getValue ( const Ice::Current &  = Ice::emptyCurrent) const
override

Definition at line 136 of file ButterworthFilter.cpp.

◆ reset()

void reset ( double  frequency,
int  sampleRate,
PassType  passType,
double  resonance 
)

Definition at line 35 of file ButterworthFilter.cpp.

◆ setInitialValue()

void setInitialValue ( double  value)

Definition at line 70 of file ButterworthFilter.cpp.

+ Here is the call graph for this function:

◆ setProperties()

void setProperties ( const StringFloatDictionary &  values,
const Ice::Current &   
)
override

Definition at line 167 of file ButterworthFilter.cpp.

◆ update() [1/2]

void update ( double  newInput)

Definition at line 122 of file ButterworthFilter.cpp.

◆ update() [2/2]

void update ( Ice::Long  ,
const VariantBasePtr &  value,
const Ice::Current &  = Ice::emptyCurrent 
)
override

Definition at line 92 of file ButterworthFilter.cpp.

+ Here is the call graph for this function:

Friends And Related Function Documentation

◆ ::armarx::GenericFactory

friend class ::armarx::GenericFactory
friend

Definition at line 45 of file ButterworthFilter.h.

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