DDS::GuardCondition Class Reference
[Conditions and WaitSets]

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

#include <managed_infrastructure.h>

Inheritance diagram for DDS::GuardCondition:

List of all members.

Public Member Functions
virtual System::Boolean	get_trigger_value () override
	Retrieve the trigger_value.
virtual void	set_trigger_value (System::Boolean value)
	Set the guard condition trigger value.
	GuardCondition ()
	No argument constructor.
	~GuardCondition ()
	Destructor.

---

Detailed Description

<<interface>> A specific DDS::Condition whose trigger_value is completely under the control of the application.

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

See also:

DDS::WaitSet

---

Constructor & Destructor Documentation

DDS::GuardCondition::GuardCondition

(

)

No argument constructor.

Construct a new guard condition on the heap.

Returns:

A new condition with trigger value false, or null if a condition could not be allocated.

DDS::GuardCondition::~GuardCondition

(

)

Destructor.

Releases the resources associated with this object.

Calling this method multiple times on the same object is safe; subsequent deletions will have no effect.

---

Member Function Documentation

virtual System::Boolean DDS::GuardCondition::get_trigger_value

(

)

[override, virtual]

Retrieve the trigger_value.

Returns:

the trigger value.

Implements DDS::Condition.

virtual void DDS::GuardCondition::set_trigger_value

(

System::Boolean

value

)

[virtual]

Set the guard condition trigger value.

Parameters:

value

<<in>> the new trigger value.