<<interface>> A specific DDS::Condition that is associated with each DDS::Entity. More...

#include <managed_infrastructure.h>

Inheritance diagram for DDS::StatusCondition:

Public Member Functions
StatusMask	get_enabled_statuses ()
	Get the list of statuses enabled on an DDS::Entity. More...

void	set_enabled_statuses (StatusMask mask)
	This operation defines the list of communication statuses that determine the `trigger_value` of the DDS::StatusCondition. More...

Entity ^	get_entity ()
	Get the DDS::Entity associated with the DDS::StatusCondition. More...

virtual System::Boolean	get_trigger_value () override
	Retrieve the `trigger_value`. More...

Detailed Description

<<interface>> A specific DDS::Condition that is associated with each DDS::Entity.

The trigger_value of the DDS::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 DDS::StatusCondition.

See also: Status Kinds; DDS::WaitSet, DDS::Condition; DDS::Listener

Member Function Documentation

◆ get_enabled_statuses()

StatusMask DDS::StatusCondition::get_enabled_statuses ( )

Get the list of statuses enabled on an DDS::Entity.

Returns: list of enabled statuses.

◆ set_enabled_statuses()

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

This operation defines the list of communication statuses that determine the trigger_value of the DDS::StatusCondition.

This operation may change the trigger_value of the DDS::StatusCondition.

DDS::WaitSet objects' behavior depends on the changes of the trigger_value of their attached conditions. Therefore, any DDS::WaitSet to which the DDS::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

◆ get_entity()

Entity ^ DDS::StatusCondition::get_entity ( )

Get the DDS::Entity associated with the DDS::StatusCondition.

There is exactly one DDS::Entity assocated with each DDS::StatusCondition.

Returns: DDS::Entity associated with the DDS::StatusCondition.

◆ get_trigger_value()

virtual System::Boolean DDS::StatusCondition::get_trigger_value ( )

overridevirtual

Retrieve the trigger_value.

Returns: the trigger value.