DDS_StatusCondition Struct Reference

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

Related Functions
(Note that these are not member functions.)
unsigned char	DDS_StatusCondition_get_trigger_value (DDS_StatusCondition sc)
	This routine returns the current value of the trigger_value in gc. More...
DDS_StatusMask	DDS_StatusCondition_get_enabled_statuses (DDS_StatusCondition sc)
	This routine returns the statuses which are enabled in this StatusCondition. More...
DDS_ReturnCode_t	DDS_StatusCondition_set_enabled_statuses (DDS_StatusCondition sc, DDS_StatusMask mask)
	This routine sets the statuses which are enabled in this StatusCondition. More...
DDS_Entity	DDS_StatusCondition_get_entity (DDS_StatusCondition sc)
	This routine returns the single entity associated with this StatusCondition.

Detailed Description

A DDS_StatusCondition is a condition associated with an Entity.

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

Friends And Related Function Documentation

DDS_StatusCondition_get_enabled_statuses()

DDS_StatusMask DDS_StatusCondition_get_enabled_statuses ( DDS_StatusCondition  sc )

related

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

The statuses are returned as a bitmask.

DDS_StatusCondition_get_trigger_value()

unsigned char DDS_StatusCondition_get_trigger_value ( DDS_StatusCondition  sc )

related

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.

DDS_StatusCondition_set_enabled_statuses()

DDS_ReturnCode_t DDS_StatusCondition_set_enabled_statuses ( DDS_StatusCondition  sc, DDS_StatusMask  mask  )

related

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

The statuses are provided as a bitmask.