DDSGuardCondition Class Reference

<<interface>> A specific DDSCondition whose trigger_value is completely under the control of the application. More...

Inheritance diagram for DDSGuardCondition:

Public Member Functions
virtual DDS_Boolean	get_trigger_value ()
	Retrieve the trigger_value.
virtual DDS_ReturnCode_t	set_trigger_value (DDS_Boolean value)
	Set the guard condition trigger value.
	DDSGuardCondition ()
	No argument constructor.
virtual	~DDSGuardCondition ()
	Destructor.
Public Member Functions inherited from DDSCondition
virtual DDS_ReturnCode_t	set_handler (DDSConditionHandler *handler)
	Registers a DDSConditionHandler in this DDSCondition.
virtual DDSConditionHandler *	get_handler ()
	Returns the registered DDSConditionHandler.
virtual void	dispatch ()
	Calls DDSConditionHandler::on_condition_triggered of the registered DDSConditionHandler.

Detailed Description

<<interface>> A specific DDSCondition whose trigger_value is completely under the control of the application.

The DDSGuardCondition provides a way for an application to manually wake up a DDSWaitSet. This is accomplished by attaching the DDSGuardCondition to the DDSWaitSet and then setting the trigger_value by means of the DDSGuardCondition::set_trigger_value operation.

See Also

DDSWaitSet

Constructor & Destructor Documentation

DDSGuardCondition::DDSGuardCondition

(

)

No argument constructor.

The default constructor initializes the guard condition with trigger value DDS_BOOLEAN_FALSE

virtual DDSGuardCondition::~DDSGuardCondition ( )

virtual

Destructor.

Releases the resources associated with this object.

Deleting a NULL condition is safe and has no effect.

Member Function Documentation

virtual DDS_Boolean DDSGuardCondition::get_trigger_value ( )

virtual

Retrieve the trigger_value.

Returns

the trigger value.

Implements DDSCondition.

virtual DDS_ReturnCode_t DDSGuardCondition::set_trigger_value ( DDS_Boolean  value )

virtual

Set the guard condition trigger value.

Parameters

value

<<in>> the new trigger value.