ConditionCheckInRange Class Reference

#include <ArmarXCore/observers/checks/ConditionCheckInRange.h>

+ Inheritance diagram for ConditionCheckInRange:

Public Member Functions

ConditionCheckclone () override
 Clones the current check. More...
 
 ConditionCheckInRange ()
 
bool evaluate (const StringVariantMap &dataFields) override
 Evaluate the condition based on the current data field values. More...
 
- Public Member Functions inherited from ConditionCheck
 ConditionCheck ()
 Creates and initializes a ConditionCheck instance. More...
 
virtual ConditionCheckPtr createInstance (const CheckConfiguration &configuration, const ChannelRegistry &channelRegistry)
 
void evaluateCondition (const DataFieldRegistry &dataFields)
 Evaluates the condition based on the given registry of data fields. More...
 
bool getFulFilled ()
 Retrieve result of a condition evaluation initiated by evaluateCondition. More...
 
void reset ()
 Resets the status flags of the check such as check results. More...
 
 ~ConditionCheck () override
 Destructor. More...
 

Additional Inherited Members

- Public Types inherited from ConditionCheck
using ChannelRegistry = armarx::ChannelRegistry
 Creates a new ConditionCheck instance. More...
 
- Protected Member Functions inherited from ConditionCheck
void addSupportedType (VariantTypeId dataFieldType=0, ParameterTypeList parameterTypes=ParameterTypeList())
 Add a supported type for elementary condition check marks pairs of (dataFieldType,EvaluationTypes) More...
 
const VariantgetParameter (int index)
 Retrieve parameters of check. More...
 
void setNumberParameters (int numberParameters)
 Sets the number of paramaters required for this check. More...
 
- Static Protected Member Functions inherited from ConditionCheck
static ParameterTypeList createParameterTypeList (int numberTypes,...)
 

Detailed Description

Checks if the numbers published in the relevant data fields are within a reference range.

Parameters: The lower and upper bound of the reference range Supported types: Int, Float, Double

Definition at line 41 of file ConditionCheckInRange.h.

Constructor & Destructor Documentation

◆ ConditionCheckInRange()

Definition at line 45 of file ConditionCheckInRange.h.

Member Function Documentation

◆ clone()

ConditionCheck* clone ( )
inlineoverridevirtual

Clones the current check.

Implement this in each subclass of the check.

Returns
new instance

Reimplemented from ConditionCheck.

Definition at line 55 of file ConditionCheckInRange.h.

◆ evaluate()

bool evaluate ( const StringVariantMap dataFields)
inlineoverridevirtual

Evaluate the condition based on the current data field values.

This method should be overwritten in order to create a custom condition check.

Parameters
dataFieldsThe values of the relevant data fields to check against
Returns
In this implementation, returns always true

Reimplemented from ConditionCheck.

Definition at line 60 of file ConditionCheckInRange.h.

+ Here is the call graph for this function:

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