org.omg.dds.topic

Interface Topic<TYPE>

Type Parameters:

TYPE - The concrete type of the data that will be published and/ or subscribed by the readers and writers that use this topic.

All Superinterfaces:

AutoCloseable, Closeable, DDSObject, DomainEntity<TopicListener<TYPE>,TopicQos>, Entity<TopicListener<TYPE>,TopicQos>, TopicDescription<TYPE>

public interface Topic<TYPE>
extends TopicDescription<TYPE>, DomainEntity<TopicListener<TYPE>,TopicQos>

Topic is the most basic description of the data to be published and subscribed. A Topic is identified by its name, which must be unique in the whole Domain. Topic is the only TopicDescription that can be used for publications and therefore associated to a DataWriter. All operations except for the inherited operations Entity.setQos(org.omg.dds.core.EntityQos), Entity.getQos(), Entity.setListener(java.util.EventListener), Entity.getListener(), Entity.enable(), getStatusCondition(), and TopicDescription.close() may fail with the exception NotEnabledException.

Method Summary

Methods

Modifier and Type	Method and Description
InconsistentTopicStatus	getInconsistentTopicStatus() This method allows the application to retrieve the InconsistentTopicStatus of the Topic.
DomainParticipant	getParent()
StatusCondition<Topic<TYPE>>	getStatusCondition() This operation allows access to the StatusCondition associated with the Entity.

Methods inherited from interface org.omg.dds.topic.TopicDescription

cast, close, getName, getTypeName, getTypeSupport

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

enable, getInstanceHandle, getListener, getQos, getStatusChanges, retain, setListener, setListener, setQos, setQos

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

getEnvironment

Method Detail

getInconsistentTopicStatus

InconsistentTopicStatus getInconsistentTopicStatus()

This method allows the application to retrieve the InconsistentTopicStatus of the Topic. Each DomainEntity has a set of relevant communication statuses. A change of status causes the corresponding Listener to be invoked and can also be monitored by means of the associated StatusCondition.

See Also:

TopicListener, StatusCondition

getStatusCondition

StatusCondition<Topic<TYPE>> getStatusCondition()

Description copied from interface: Entity

This operation allows access to the StatusCondition associated with the Entity. The returned condition can then be added to a WaitSet so that the application can wait for specific status changes that affect the Entity.

Specified by:

getStatusCondition in interface Entity<TopicListener<TYPE>,TopicQos>

getParent

DomainParticipant getParent()

Specified by:

getParent in interface DomainEntity<TopicListener<TYPE>,TopicQos>

Specified by:

getParent in interface TopicDescription<TYPE>

Returns:

the DomainParticipant to which the TopicDescription belongs.