AGX Dynamics 2.42.3.1
Loading...
Searching...
No Matches
agxControl::DataFilter Class Referenceabstract

Virtual base class of a data filter for data smoothing. More...

#include <MeasurementOperations.h>

+ Inheritance diagram for agxControl::DataFilter:

Public Member Functions

 DataFilter (agx::Real samplingTime)
 Default constructor.
 
virtual void filterValue (agx::Real inValue)=0
 Returns the a filtered signal given a value supplied to the filter.
 
agx::Real getFilteredValue () const
 Returns the current filtered value.
 
virtual bool setSamplingTime (agx::Real samplingTime)
 Set the discrete sampling time of the filter.
 
- Public Member Functions inherited from agx::Referenced
 Referenced ()
 Default constructor.
 
 Referenced (const Referenced &)
 
template<typename T >
T * as ()
 Subclass casting.
 
template<typename T >
const T * as () const
 
template<typename T >
T * asSafe ()
 Safe subclass casting, return nullptr if template type does not match.
 
template<typename T >
const T * asSafe () const
 
int getReferenceCount () const
 
template<typename T >
bool is () const
 Subclass test.
 
Referenced & operator= (const Referenced &)
 Assignment operator. Will increment the number of references to the referenced object.
 
void reference (void *ptr=nullptr) const
 Explicitly increment the reference count by one, indicating that this object has another pointer which is referencing it.
 
void unreference (void *ptr=nullptr) const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
 
void unreference_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
 

Protected Member Functions

virtual ~DataFilter ()
 Default destructor.
 
- Protected Member Functions inherited from agx::Referenced
virtual ~Referenced ()
 Destructor.
 
void allocateObserverVector () const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

agx::Real m_filteredValue
 
agx::Real m_samplingTime
 
- Protected Attributes inherited from agx::Referenced
Mutex m_mutex
 
ObserverContainer m_observers
 
AtomicValue m_refCount
 

Additional Inherited Members

- Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool ValidateCast (const Referenced *object)
 
- Static Protected Member Functions inherited from agx::Referenced
static DeleteHandler * getDeleteHandler ()
 
static void setDeleteHandler (DeleteHandler *handler)
 Internal: Set a DeleteHandler to which deletion of all referenced counted objects will be delegated to.
 

Detailed Description

Virtual base class of a data filter for data smoothing.

Child classes implement different types of filters.

Definition at line 30 of file MeasurementOperations.h.

Constructor & Destructor Documentation

◆ DataFilter()

agxControl::DataFilter::DataFilter ( agx::Real  samplingTime)

Default constructor.

◆ ~DataFilter()

virtual agxControl::DataFilter::~DataFilter ( )
protectedvirtual

Default destructor.

Member Function Documentation

◆ filterValue()

virtual void agxControl::DataFilter::filterValue ( agx::Real  inValue)
pure virtual

Returns the a filtered signal given a value supplied to the filter.

Implemented in agxControl::ExponentialFilter.

◆ getFilteredValue()

agx::Real agxControl::DataFilter::getFilteredValue ( ) const

Returns the current filtered value.

Definition at line 57 of file MeasurementOperations.h.

◆ setSamplingTime()

virtual bool agxControl::DataFilter::setSamplingTime ( agx::Real  samplingTime)
virtual

Set the discrete sampling time of the filter.

Reimplemented in agxControl::ExponentialFilter.

Member Data Documentation

◆ m_filteredValue

agx::Real agxControl::DataFilter::m_filteredValue
protected

Definition at line 53 of file MeasurementOperations.h.

◆ m_samplingTime

agx::Real agxControl::DataFilter::m_samplingTime
protected

Definition at line 54 of file MeasurementOperations.h.


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