HBhvConditionSensorActivated Class Reference

The HBhvConditionSensorActivated class evaluates if a sensor has been activated. More...

#include <HBhvSensor.h>

Public Member Functions

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

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 HBhvConditionSensorActivated class evaluates if a sensor has been activated.

Constructor & Destructor Documentation

◆ HBhvConditionSensorActivated()

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

Constructs an HBhvConditionSensorActivated 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

◆ SensorActivatedEvent()

virtual int HBhvConditionSensorActivated::SensorActivatedEvent ( HBhvSensor ainst)
virtual

Called by the event manager if a sensor has been activated. If the sensor that was activated is the target sensor, this condition of this HBhvConditionSensorActivated associated sensor are evaluated.

◆ Serialize()

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

Writes XML data to a buffer.

Reimplemented from HBhvCondition.


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