DDS.IGuardCondition Interface Reference

An IGuardCondition object is a specific ICondition whose TriggerValue is completely under the control of the application. The IGuardCondition has no factory and must be created by the application. The IGuardCondition is directly created as an object by using the GuardCondition constructor. When a IGuardCondition is initially created, the TriggerValue is false. The purpose of the IGuardCondition is to provide the means for an application to manually wake up an IWaitSet. This is accomplished by attaching the IGuardCondition to the IWaitset and setting the TriggerValue by means of the IGuardCondition.SetTriggerValue operation. More...

Inheritance diagram for DDS.IGuardCondition:

Collaboration diagram for DDS.IGuardCondition:

Public Member Functions
ReturnCode	SetTriggerValue (bool value)
	This operation sets the TriggerValue of the IGuardCondition. More...
Public Member Functions inherited from DDS.ICondition
bool	GetTriggerValue ()
	Each ICondition has a TriggerValue that can be true or false and is set by the DDS depending on the evaluation of the ICondition. More...

Detailed Description

An IGuardCondition object is a specific ICondition whose TriggerValue is completely under the control of the application. The IGuardCondition has no factory and must be created by the application. The IGuardCondition is directly created as an object by using the GuardCondition constructor. When a IGuardCondition is initially created, the TriggerValue is false. The purpose of the IGuardCondition is to provide the means for an application to manually wake up an IWaitSet. This is accomplished by attaching the IGuardCondition to the IWaitset and setting the TriggerValue by means of the IGuardCondition.SetTriggerValue operation.

See also

Waitset

Definition at line 233 of file DdsDcpsInterfaces.cs.

Member Function Documentation

SetTriggerValue()

ReturnCode DDS.IGuardCondition.SetTriggerValue

(

bool

value

)

This operation sets the TriggerValue of the IGuardCondition.

An IGuardCondition object is a specific ICondition which TriggerValue is completely under the control of the application. This operation must be used by the application to manually wake-up an IWaitSet. This operation sets the TriggerValue of the IGuardCondition to the parameter value. When an IGuardCondition is initially created, the TriggerValue is false.

Parameters

value

The boolean value to which the IGuardCondition is set.

Returns

Possible return codes of the operation are:

• DDS.ReturnCode Ok - The specified TriggerValue has successfully been applied.
• DDS.ReturnCode Error - An internal error has occurred.

---

The documentation for this interface was generated from the following file:

• src/api/dcps/sacs/code/DDS/DdsDcpsInterfaces.cs