org.omg.dds.core

Interface StatusCondition<ENTITY extends Entity<?,?>>

Type Parameters:

ENTITY - The type of the entity with which this condition is associated.

All Superinterfaces:

Condition, DDSObject

public interface StatusCondition<ENTITY extends Entity<?,?>>
extends Condition

A StatusCondition object is a specific Condition that is associated with each Entity. The triggerValue of the StatusCondition depends on the communication status of that entity (e.g., arrival of data, loss of information, etc.), "filtered" by the set of enabledStatuses on the StatusCondition. The triggerValue of a StatusCondition is the Boolean OR of the ChangedStatusFlag of all the communication statuses to which it is sensitive. That is, triggerValue == false only if all the values of the ChangedStatusFlags are false. The sensitivity of the StatusCondition to a particular communication status is controlled by the list of enabledStatuses set on the condition by means of setEnabledStatuses(Collection).

Method Summary

Methods

Modifier and Type	Method and Description
Set<Class<? extends Status>>	getEnabledStatuses() This operation retrieves the list of communication statuses that are taken into account to determine the triggerValue of the StatusCondition.
ENTITY	getParent()
void	setEnabledStatuses(Collection<Class<? extends Status>> statuses) This operation defines the list of communication statuses that are taken into account to determine the triggerValue of the StatusCondition.

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

getTriggerValue

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

getEnvironment

Method Detail

getEnabledStatuses

Set<Class<? extends Status>> getEnabledStatuses()

This operation retrieves the list of communication statuses that are taken into account to determine the triggerValue of the StatusCondition. This operation returns the statuses that were explicitly set on the last call to setEnabledStatuses(Collection) or, if it was never called, the default list.

Returns:

a new Set of enabled statuses.

See Also:

setEnabledStatuses(Collection)

setEnabledStatuses

void setEnabledStatuses(Collection<Class<? extends Status>> statuses)

This operation defines the list of communication statuses that are taken into account to determine the triggerValue of the StatusCondition. This operation may change the triggerValue of the StatusCondition. WaitSet objects behavior depend on the changes of the triggerValue of their attached conditions. Therefore, any WaitSet to which the StatusCondition is attached is potentially affected by this operation. If this function is not invoked, the default list of enabled statuses includes all the statuses.

Parameters:

statuses - For which status changes the condition should trigger. A null collection signifies all status changes.

See Also:

getEnabledStatuses()

getParent

ENTITY getParent()

Returns:

the Entity associated with the StatusCondition. Note that there is exactly one Entity associated with each StatusCondition.