RTI Connext .Net APIs  Version 5.2.0
 All Classes Namespaces Functions Variables Enumerations Properties Groups Pages
DDS::StatusCondition Class Reference

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

#include <managed_infrastructure.h>

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

Public Member Functions

StatusMask get_enabled_statuses ()
 Get the list of statuses enabled on an DDS::Entity.
 
void set_enabled_statuses (StatusMask mask)
 This operation defines the list of communication statuses that determine the trigger_value of the DDS::StatusCondition.
 
Entityget_entity ()
 Get the DDS::Entity associated with the DDS::StatusCondition.
 
virtual System::Boolean get_trigger_value () override
 Retrieve the trigger_value.
 

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

StatusMask DDS::StatusCondition::get_enabled_statuses ( )

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

Returns
list of 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
Oneof the Standard Return Codes
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.
virtual System::Boolean DDS::StatusCondition::get_trigger_value ( )
overridevirtual

Retrieve the trigger_value.

Returns
the trigger value.

Implements DDS::Condition.


RTI Connext .Net APIs Version 5.2.0 Copyright © Sun Jun 21 2015 Real-Time Innovations, Inc