Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HBhvConditionSensorActive Class Reference

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

#include <HBhvSensor.h>

List of all members.

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)

Detailed Description

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


Constructor & Destructor Documentation

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

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.

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: