HBhvConditionSensorActive Class Reference

The HBhvConditionSensorActive class evaluates if the given sensor is currently active. More...

#include <HBhvSensor.h>

Public Member Functions

virtual void Evaluate (bool &and_flag, bool &or_flag)
 
 HBhvConditionSensorActive (const char *target, const char *hevent, bool invert, HBhvSensor *sensor)
 
virtual void Serialize (HUtilityXMLGenerator *xmlgen)
 
- Public Member Functions inherited from HBhvCondition
virtual HBhvSensorGetSensor ()
 
 HBhvCondition (const char *target, const char *hevent, bool invert, HBhvSensor *sensor)
 
virtual void Register ()
 
virtual void Serialize (HUtilityXMLGenerator *xmlgen, HUtilityXMLTag *xmlt)
 
virtual void SetTarget (const char *target)
 
virtual void UnRegister ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HBhvCondition
static void * XMLCallback (HUtilityXMLTag *xt, bool open, void *m_pExtraData)
 
- Protected Attributes inherited from HBhvCondition
bool m_bConditionMet
 
bool m_bInvert
 
char m_Event [256]
 
HBhvSensorm_pSensor
 
HBhvTargetObjectm_pTarget
 
char m_Value [256]
 

Detailed Description

The HBhvConditionSensorActive class evaluates if the given sensor is currently active.

Constructor & Destructor Documentation

◆ HBhvConditionSensorActive()

HBhvConditionSensorActive::HBhvConditionSensorActive ( const char *  target,
const char *  hevent,
bool  invert,
HBhvSensor sensor 
)

Constructs an HBhvConditionSensorActive object.

Parameters
targetThe descriptor of the target sensor. You can use HBhvTargetObject::CreateTargetString() to generate this string.
heventThe event type.
invertPass true to invert the condition. In other words, this condition will return true if the condition evaluates to false and false if the condition evaluates to true.
sensorA pointer to the HBhvSensor object that this condition belongs to.

Member Function Documentation

◆ Evaluate()

virtual void HBhvConditionSensorActive::Evaluate ( bool &  and_flag,
bool &  or_flag 
)
virtual

Evaluates the condition.

Parameters
and_flagReturns true if the target sensor was active or false if it is inactive. Note that this flag will return the opposite values if the invert flag is set to true.
or_flagResult of evaluation

Reimplemented from HBhvCondition.

◆ Serialize()

virtual void HBhvConditionSensorActive::Serialize ( HUtilityXMLGenerator *  xmlgen)
virtual

Writes XML data to a buffer.

Reimplemented from HBhvCondition.


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