DatafieldFilter Class Reference

The DatafieldFilter class is the base class for all filters and filter implementation should derive from this class. For usage explanation see Filtering the data. More...

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

Inheritance diagram for DatafieldFilter:

Public Member Functions
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 Attributes
TimeVariantBaseMap	dataHistory
std::mutex	historyMutex

Detailed Description

The DatafieldFilter class is the base class for all filters and filter implementation should derive from this class. For usage explanation see Filtering the data.

Definition at line 45 of file DatafieldFilter.h.

Constructor & Destructor Documentation

DatafieldFilter() [1/2]

DatafieldFilter

(

)

Definition at line 30 of file DatafieldFilter.cpp.

DatafieldFilter() [2/2]

DatafieldFilter

(

DatafieldFilter const &

filter

)

Definition at line 35 of file DatafieldFilter.cpp.

Member Function Documentation

checkTypeSupport()

bool checkTypeSupport ( VariantTypeId  variantType, const Ice::Current &  c = Ice::emptyCurrent  ) const

override

Checks whether the given type is supported.

Parameters

variantType

Returns

Definition at line 82 of file DatafieldFilter.cpp.

getDataHistory()

const TimeVariantBaseMap & getDataHistory

(

)

const

Definition at line 117 of file DatafieldFilter.cpp.

getProperties()

armarx::StringFloatDictionary getProperties ( const Ice::Current &  c = Ice::emptyCurrent ) const

override

Definition at line 96 of file DatafieldFilter.cpp.

Here is the caller graph for this function:

getValue()

VariantBasePtr getValue ( const Ice::Current &  c = Ice::emptyCurrent ) const

override

Retrieves the current, filtered value.

Triggers calculates if if filtered value pointer is empty.

Definition at line 70 of file DatafieldFilter.cpp.

Here is the caller graph for this function:

setProperties()

void setProperties ( const armarx::StringFloatDictionary &  newValues, const Ice::Current &  c = Ice::emptyCurrent  )

override

Definition at line 103 of file DatafieldFilter.cpp.

Here is the caller graph for this function:

update()

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.

Parameters

timestamp	Timestamp at which the data value was taken.
value	The new data value.

Definition at line 44 of file DatafieldFilter.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

dataHistory

TimeVariantBaseMap dataHistory

protected

Definition at line 79 of file DatafieldFilter.h.

historyMutex

std::mutex historyMutex

mutableprotected

Definition at line 80 of file DatafieldFilter.h.

---

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

• ArmarXCore/observers/filters/DatafieldFilter.h
• ArmarXCore/observers/filters/DatafieldFilter.cpp