org.omg.dds.core.StatusCondition< ENTITY extends Entity<?, ?> Interface Template Reference

A StatusCondition object is an immutable object that specifies Condition that is associated with each org.omg.dds.core.Entity. More...

Inheritance diagram for org.omg.dds.core.StatusCondition< ENTITY extends Entity<?, ?>:

Collaboration diagram for org.omg.dds.core.StatusCondition< ENTITY extends Entity<?, ?>:

Public Member Functions
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 ()
ENTITY	getParent ()
boolean	getTriggerValue ()
void	setEnabledStatuses (Class<? extends Status >... statuses)
	This operation accepts a variable number of statuses that are encapsulated in a new StatusCondition object. More...
void	setEnabledStatuses (Collection< Class<? extends Status >> statuses)
	This operation accepts a collection of statuses that are encapsulated in a new StatusCondition object. More...

Detailed Description

A StatusCondition object is an immutable object that specifies Condition that is associated with each org.omg.dds.core.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).

Valid statuses are:

• org.omg.dds.core.status.DataAvailableStatus
• org.omg.dds.core.status.DataOnReadersStatus
• org.omg.dds.core.status.InconsistentTopicStatus
• org.omg.dds.core.status.LivelinessChangedStatus
• org.omg.dds.core.status.LivelinessLostStatus
• org.omg.dds.core.status.OfferedDeadlineMissedStatus
• org.omg.dds.core.status.OfferedIncompatibleQosStatus
• org.omg.dds.core.status.PublicationMatchedStatus
• org.omg.dds.core.status.RequestedDeadlineMissedStatus
• org.omg.dds.core.status.RequestedIncompatibleQosStatus
• org.omg.dds.core.status.SampleLostStatus
• org.omg.dds.core.status.SampleRejectedStatus
• org.omg.dds.core.status.SubscriptionMatchedStatus

Parameters

<ENTITY>

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

Definition at line 63 of file StatusCondition.java.

Member Function Documentation

getEnabledStatuses()

Set<Class<? extends Status> > org.omg.dds.core.StatusCondition< ENTITY 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)

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

getEnvironment()

ServiceEnvironment org.omg.dds.core.DDSObject.getEnvironment ( )

inherited

Returns

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

Implemented in org.omg.dds.core.ServiceEnvironment, org.opensplice.dds.sub.ReflectionDataReader< TYPE, OUT_TYPE >, org.opensplice.dds.core.ModifiableTimeImpl, org.opensplice.dds.pub.ReflectionDataWriter< TYPE >, org.opensplice.dds.core.DurationImpl, org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >, org.opensplice.dds.sub.ReadConditionImpl< TYPE >, org.opensplice.dds.core.EntityQosImpl< T extends QosPolicy >, org.opensplice.dds.type.TypeSupportImpl< TYPE >, org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl, org.opensplice.dds.topic.SubscriptionBuiltinTopicDataImpl, org.opensplice.dds.topic.TopicBuiltinTopicDataImpl, org.opensplice.dds.domain.DomainParticipantFactoryImpl, org.opensplice.dds.core.QosProviderImpl, org.opensplice.dds.core.status.OfferedIncompatibleQosStatusImpl, org.opensplice.dds.core.status.RequestedIncompatibleQosStatusImpl, org.opensplice.dds.core.InstanceHandleImpl, org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?>, org.opensplice.dds.core.status.LivelinessChangedStatusImpl, org.opensplice.dds.core.status.PublicationMatchedStatusImpl, org.opensplice.dds.core.status.SubscriptionMatchedStatusImpl, org.opensplice.dds.sub.SampleImpl< TYPE >, org.opensplice.dds.core.policy.ShareImpl, org.opensplice.dds.core.status.OfferedDeadlineMissedStatusImpl, org.opensplice.dds.core.status.SampleRejectedStatusImpl, org.opensplice.dds.core.WaitSetImpl, org.opensplice.dds.topic.ParticipantBuiltinTopicDataImpl, org.opensplice.dds.core.status.RequestedDeadlineMissedStatusImpl, org.opensplice.dds.topic.BuiltinTopicKeyImpl, org.opensplice.dds.core.GuardConditionImpl, org.opensplice.dds.core.event.AllDataDisposedEventImpl< TYPE >, org.opensplice.dds.core.policy.QosPolicyCountImpl, org.opensplice.dds.core.status.InconsistentTopicStatusImpl, org.opensplice.dds.core.status.LivelinessLostStatusImpl, org.opensplice.dds.core.status.SampleLostStatusImpl, org.opensplice.dds.core.policy.QosPolicyImpl, org.opensplice.dds.core.status.AllDataDisposedStatusImpl, org.opensplice.dds.core.IllegalArgumentExceptionImpl, org.opensplice.dds.core.InconsistentPolicyExceptionImpl, org.opensplice.dds.core.policy.PolicyFactoryImpl, org.opensplice.dds.core.policy.TypeConsistencyEnforcementImpl, org.opensplice.dds.core.PreconditionNotMetExceptionImpl, org.opensplice.dds.core.AlreadyClosedExceptionImpl, org.opensplice.dds.core.IllegalOperationExceptionImpl, org.opensplice.dds.core.ImmutablePolicyExceptionImpl, org.opensplice.dds.core.NotEnabledExceptionImpl, org.opensplice.dds.core.OutOfResourcesExceptionImpl, org.opensplice.dds.core.DDSExceptionImpl, org.opensplice.dds.core.status.DataAvailableStatusImpl, and org.opensplice.dds.core.status.DataOnReadersStatusImpl.

getParent()

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

(

)

Returns

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

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

getTriggerValue()

boolean org.omg.dds.core.Condition.getTriggerValue ( )

inherited

Returns

the triggerValue of the Condition.

Implemented in org.opensplice.dds.sub.ReadConditionImpl< TYPE >, org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?>, and org.opensplice.dds.core.GuardConditionImpl.

setEnabledStatuses() [1/2]

void org.omg.dds.core.StatusCondition< ENTITY 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)

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

setEnabledStatuses() [2/2]

void org.omg.dds.core.StatusCondition< ENTITY 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)

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

---

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

• java5/common/java/code/org/omg/dds/core/StatusCondition.java