CoreDX DDS C++ Reference Manual
Public Member Functions | List of all members
DDS::StatusCondition Class Reference

A StatusCondition is a condition associated with an Entity. More...

Inheritance diagram for DDS::StatusCondition:
DDS::Condition

Public Member Functions

bool get_trigger_value ()
 This routine returns the current value of the trigger_value in gc. More...
 
ReturnCode_t set_enabled_statuses (StatusMask mask)
 This routine sets the statuses which are enabled in this StatusCondition. More...
 
StatusMask get_enabled_statuses ()
 This routine returns the statuses which are enabled in this StatusCondition. More...
 
Entityget_entity ()
 This routine returns the single entity associated with this StatusCondition.
 

Detailed Description

A StatusCondition is a condition associated with an Entity.

The trigger_value is driven by the communication status of the associated Entity.

Member Function Documentation

StatusMask DDS::StatusCondition::get_enabled_statuses ( )

This routine returns the statuses which are enabled in this StatusCondition.

The statuses are returned as a bitmask.

bool DDS::StatusCondition::get_trigger_value ( )
virtual

This routine returns the current value of the trigger_value in gc.

A non-zero return value indicates that the trigger_value is TRUE.

A zero return value indicates that the trigger_value is FALSE.

Reimplemented from DDS::Condition.

ReturnCode_t DDS::StatusCondition::set_enabled_statuses ( StatusMask  mask)

This routine sets the statuses which are enabled in this StatusCondition.

The statuses are provided as a bitmask.


© 2009-2017 Twin Oaks Computing, Inc
Castle Rock, CO 80108
All rights reserved.