org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?> Class Template Reference

Inheritance diagram for org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?>:

Collaboration diagram for org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?>:

Public Member Functions
	StatusConditionImpl (OsplServiceEnvironment environment, DDS.StatusCondition oldCondition, T parent)
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. More...
ServiceEnvironment	getEnvironment ()
DDS.StatusCondition	getOldCondition ()
T	getParent ()
boolean	getTriggerValue ()
void	setEnabledStatuses (Collection< Class<? extends Status >> statuses)
	This operation accepts a collection of statuses that are encapsulated in a new StatusCondition object. More...
void	setEnabledStatuses (Class<? extends Status >... statuses)
	This operation accepts a variable number of statuses that are encapsulated in a new StatusCondition object. More...
String	toString ()

Detailed Description

Definition at line 33 of file StatusConditionImpl.java.

Constructor & Destructor Documentation

StatusConditionImpl()

org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?>.StatusConditionImpl	(	OsplServiceEnvironment	environment,
		DDS.StatusCondition	oldCondition,
		T	parent
	)

Definition at line 39 of file StatusConditionImpl.java.

Member Function Documentation

getEnabledStatuses()

Set<Class<? extends Status> > org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?>.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)

Implements org.omg.dds.core.StatusCondition< ENTITY extends Entity<?, ?>.

Definition at line 62 of file StatusConditionImpl.java.

getEnvironment()

ServiceEnvironment org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?>.getEnvironment

(

)

Returns

the org.omg.dds.core.ServiceEnvironment object that directly or indirectly was used to create this object.

Implements org.omg.dds.core.DDSObject.

Definition at line 52 of file StatusConditionImpl.java.

getOldCondition()

DDS.StatusCondition org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?>.getOldCondition

(

)

Definition at line 83 of file StatusConditionImpl.java.

getParent()

T org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?>.getParent

(

)

Returns

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

Implements org.omg.dds.core.StatusCondition< ENTITY extends Entity<?, ?>.

Definition at line 57 of file StatusConditionImpl.java.

getTriggerValue()

boolean org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?>.getTriggerValue

(

)

Returns

the triggerValue of the Condition.

Implements org.omg.dds.core.Condition.

Definition at line 47 of file StatusConditionImpl.java.

setEnabledStatuses() [1/2]

void org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?>.setEnabledStatuses

(

Collection< Class<? extends Status >>

statuses

)

This operation accepts a collection of statuses that are encapsulated in a new StatusCondition object.

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

#setEnabledStatuses(Collection)

Implements org.omg.dds.core.StatusCondition< ENTITY extends Entity<?, ?>.

Definition at line 68 of file StatusConditionImpl.java.

setEnabledStatuses() [2/2]

void org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?>.setEnabledStatuses

(

Class<? extends Status >...

statuses

)

This operation accepts a variable number of statuses that are encapsulated in a new StatusCondition object.

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. An empty parameter list signifies all status changes.

See also

#setEnabledStatuses(Collection)

Implements org.omg.dds.core.StatusCondition< ENTITY extends Entity<?, ?>.

Definition at line 77 of file StatusConditionImpl.java.

toString()

String org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?>.toString

(

)

Definition at line 88 of file StatusConditionImpl.java.

---

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

• java5/common/java/code/org/opensplice/dds/core/StatusConditionImpl.java