RTI Connext .NET API (legacy)  Version 6.1.2

<<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:
DDS::Condition

Public Member Functions

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

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

◆ GuardCondition()

DDS::GuardCondition::GuardCondition ( )

No argument constructor.

The default constructor initializes the guard condition with trigger value false

◆ ~GuardCondition()

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

◆ get_trigger_value()

virtual System::Boolean DDS::GuardCondition::get_trigger_value ( )
overridevirtual

Retrieve the trigger_value.

Returns
the trigger value.

Implements DDS::Condition.

◆ set_trigger_value()

virtual void DDS::GuardCondition::set_trigger_value ( System::Boolean  value)
virtual

Set the guard condition trigger value.

Parameters
value<<in>> the new trigger value.