RTI Connext Traditional C++ API  Version 6.1.2

<<interface>> Root class for all the conditions that may be attached to a DDSWaitSet. More...

Inheritance diagram for DDSCondition:
DDSGuardCondition DDSReadCondition DDSStatusCondition DDSQueryCondition

Public Member Functions

virtual DDS_Boolean get_trigger_value ()=0
 Retrieve the trigger_value. More...
 
virtual DDS_ReturnCode_t set_handler (DDSConditionHandler *handler)
 <<extension>> Registers a DDSConditionHandler in this DDSCondition. More...
 
virtual DDSConditionHandlerget_handler ()
 <<extension>> Returns the registered DDSConditionHandler. More...
 
virtual void dispatch ()
 <<extension>> Calls DDSConditionHandler::on_condition_triggered of the registered DDSConditionHandler. More...
 

Detailed Description

<<interface>> Root class for all the conditions that may be attached to a DDSWaitSet.

This basic class is specialised in three classes:

DDSGuardCondition, DDSStatusCondition, and DDSReadCondition.

A DDSCondition has a trigger_value that can be DDS_BOOLEAN_TRUE or DDS_BOOLEAN_FALSE and is set automatically by RTI Connext.

See also
DDSWaitSet

Member Function Documentation

◆ get_trigger_value()

virtual DDS_Boolean DDSCondition::get_trigger_value ( )
pure virtual

Retrieve the trigger_value.

Returns
the trigger value.

Implemented in DDSGuardCondition.

◆ set_handler()

virtual DDS_ReturnCode_t DDSCondition::set_handler ( DDSConditionHandler handler)
virtual

<<extension>> Registers a DDSConditionHandler in this DDSCondition.

This operation replaces any existing registered handler. If there is any resources associated with an existing registered handler that need to be released, you may first call DDSCondition::get_handler to retrieve the handler.

MT Safety:
It is not safe to call DDSCondition::set_handler, DDSCondition::get_handler or DDSCondition::dispatch concurrently.
Parameters
handlerThe DDSConditionHandler to be called by DDSCondition::dispatch. If this parameter is null, an no-op handler implemenation will be set.

◆ get_handler()

virtual DDSConditionHandler* DDSCondition::get_handler ( )
virtual

<<extension>> Returns the registered DDSConditionHandler.

If no DDSConditionHandler is registered, this operation returns a no-op DDSConditionHandler implementation.

◆ dispatch()

virtual void DDSCondition::dispatch ( )
virtual

<<extension>> Calls DDSConditionHandler::on_condition_triggered of the registered DDSConditionHandler.

If the trigger value is true, calling this operation will call the registered.

If no DDSConditionHandler is registered, this operation is a no-op.