DDSGuardCondition Class Reference
[Conditions and WaitSets]

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

Inheritance diagram for DDSGuardCondition:

DDSCondition

List of all members.

Public Member Functions

virtual DDS_Boolean get_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.


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.

Construct a new guard condition on the heap.

Returns:
A new condition with trigger value DDS_BOOLEAN_FALSE, or NULL if a condition could not be allocated.

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.


RTI Data Distribution Service C++ API Version 4.5e Copyright © 23 Oct 2011 Real-Time Innovations, Inc