StatusCondition Interface Reference

<<interface>> A specific com.rti.dds.infrastructure.Condition that is associated with each com.rti.dds.infrastructure.Entity. More...

Inheritance diagram for StatusCondition:

Public Member Functions
int	get_enabled_statuses ()
	Get the list of statuses enabled on an com.rti.dds.infrastructure.Entity.
void	set_enabled_statuses (int mask)
	This operation defines the list of communication statuses that determine the trigger_value of the com.rti.dds.infrastructure.StatusCondition.
Entity	get_entity ()
	Get the com.rti.dds.infrastructure.Entity associated with the com.rti.dds.infrastructure.StatusCondition.
Public Member Functions inherited from Condition
boolean	get_trigger_value ()
	Retrieve the trigger_value.

Detailed Description

<<interface>> A specific com.rti.dds.infrastructure.Condition that is associated with each com.rti.dds.infrastructure.Entity.

The trigger_value of the com.rti.dds.infrastructure.StatusCondition depends on the communication status of that entity (e.g., arrival of data, loss of information, etc.), 'filtered' by the set of enabled_statuses on the com.rti.dds.infrastructure.StatusCondition.

See Also

Status Kinds

com.rti.dds.infrastructure.WaitSet, com.rti.dds.infrastructure.Condition

com.rti.dds.infrastructure.Listener

Member Function Documentation

int get_enabled_statuses

(

)

Get the list of statuses enabled on an com.rti.dds.infrastructure.Entity.

Returns

list of enabled statuses.

void set_enabled_statuses

(

int

mask

)

This operation defines the list of communication statuses that determine the trigger_value of the com.rti.dds.infrastructure.StatusCondition.

This operation may change the trigger_value of the com.rti.dds.infrastructure.StatusCondition.

com.rti.dds.infrastructure.WaitSet objects' behavior depends on the changes of the trigger_value of their attached conditions. Therefore, any com.rti.dds.infrastructure.WaitSet to which the com.rti.dds.infrastructure.StatusCondition is attached is potentially affected by this operation.

If this function is not invoked, the default list of enabled statuses includes all the statuses.

Parameters

mask	<<in>> the list of enables statuses (see Status Kinds)

Exceptions

One	of the Standard Return Codes

Entity get_entity

(

)

Get the com.rti.dds.infrastructure.Entity associated with the com.rti.dds.infrastructure.StatusCondition.

There is exactly one com.rti.dds.infrastructure.Entity assocated with each com.rti.dds.infrastructure.StatusCondition.

Returns

com.rti.dds.infrastructure.Entity associated with the com.rti.dds.infrastructure.StatusCondition.