org.omg.dds.core

Class GuardCondition

java.lang.Object

org.omg.dds.core.GuardCondition

All Implemented Interfaces:

Condition, DDSObject

public abstract class GuardCondition
extends Object
implements Condition

A GuardCondition object is a specific Condition whose triggerValue is completely under the control of the application. When it is first created, the triggerValue is set to false. The purpose of the GuardCondition is to provide the means for the application to manually wake up a WaitSet. This is accomplished by attaching the GuardCondition to the WaitSet and then setting the triggerValue by means of the setTriggerValue(boolean) operation.

Constructor Summary

Constructors

Constructor and Description
GuardCondition()

Method Summary

Methods

Modifier and Type	Method and Description
static GuardCondition	newGuardCondition(ServiceEnvironment env)
abstract void	setTriggerValue(boolean value) This operation sets the triggerValue of the GuardCondition.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.omg.dds.core.Condition

getTriggerValue

Methods inherited from interface org.omg.dds.core.DDSObject

getEnvironment

Constructor Detail

GuardCondition

public GuardCondition()

Method Detail

newGuardCondition

public static GuardCondition newGuardCondition(ServiceEnvironment env)

Parameters:

env - Identifies the Service instance to which the new object will belong.

setTriggerValue

public abstract void setTriggerValue(boolean value)

This operation sets the triggerValue of the GuardCondition. WaitSet objects' behavior depends on the changes of the triggerValue of their attached conditions. Therefore, any WaitSet to which the GuardCondition is attached is potentially affected by this operation.

See Also:

Condition.getTriggerValue()