org.omg.dds.topic.TopicDescription< TYPE > Interface Template Reference

This interface is the base for org.omg.dds.topic.Topic, org.omg.dds.topic.ContentFilteredTopic, and org.omg.dds.topic.MultiTopic. More...

Inheritance diagram for org.omg.dds.topic.TopicDescription< TYPE >:

Collaboration diagram for org.omg.dds.topic.TopicDescription< TYPE >:

Public Member Functions
public< OTHER > TopicDescription< OTHER >	cast ()
	Cast this topic description to the given type, or throw an exception if the cast fails. More...
void	close ()
	Dispose the resources held by this object. More...
ServiceEnvironment	getEnvironment ()
String	getName ()
	Returns the name used to create the TopicDescription. More...
DomainParticipant	getParent ()
	Returns the org.omg.dds.domain.DomainParticipant to which the TopicDescription belongs. More...
String	getTypeName ()
	Returns the type name used to create the TopicDescription. More...
TypeSupport< TYPE >	getTypeSupport ()
	Returns the org.omg.dds.type.TypeSupport used to create this TopicDescription. More...

Detailed Description

This interface is the base for org.omg.dds.topic.Topic, org.omg.dds.topic.ContentFilteredTopic, and org.omg.dds.topic.MultiTopic.

TopicDescription represents the fact that both publications and subscriptions are tied to a single data type. Its attribute typeName defines a unique resulting type for the publication or the subscription and therefore creates an implicit association with a org.omg.dds.type.TypeSupport. TopicDescription has also a name that allows it to be retrieved locally.

Parameters

<TYPE>

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

Definition at line 42 of file TopicDescription.java.

Member Function Documentation

cast()

public<OTHER> TopicDescription<OTHER> org.omg.dds.topic.TopicDescription< TYPE >.cast

(

)

Cast this topic description to the given type, or throw an exception if the cast fails.

Parameters

<OTHER>

The type of the data exchanged on this topic, according to the caller.

Returns

this topic description

Exceptions

ClassCastException

if the cast fails

close()

void org.omg.dds.topic.TopicDescription< TYPE >.close

(

)

Dispose the resources held by this object.

A TopicDescription cannot be closed if it is in use by any org.omg.dds.pub.DataWriters or org.omg.dds.sub.DataReaders. With respect to org.omg.dds.topic.Topics specifically: a Topic cannot be closed if it has any remaining org.omg.dds.topic.ContentFilteredTopics or org.omg.dds.topic.MultiTopics related to it.

See also

org.omg.dds.core.Entity::close()

Implemented in org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >, and org.opensplice.dds.topic.TopicDescriptionExt< TYPE >.

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.

getName()

String org.omg.dds.topic.TopicDescription< TYPE >.getName

(

)

Returns the name used to create the TopicDescription.

Returns

the name.

Implemented in org.opensplice.dds.topic.TopicImpl< TYPE >, and org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.

getParent()

DomainParticipant org.omg.dds.topic.TopicDescription< TYPE >.getParent

(

)

Returns the org.omg.dds.domain.DomainParticipant to which the TopicDescription belongs.

Returns

the org.omg.dds.domain.DomainParticipant

Implemented in org.opensplice.dds.topic.TopicImpl< TYPE >, org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >, and org.omg.dds.topic.Topic< TYPE >.

getTypeName()

String org.omg.dds.topic.TopicDescription< TYPE >.getTypeName

(

)

Returns the type name used to create the TopicDescription.

Returns

the type name

Implemented in org.opensplice.dds.topic.TopicImpl< TYPE >, and org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.

getTypeSupport()

TypeSupport<TYPE> org.omg.dds.topic.TopicDescription< TYPE >.getTypeSupport

(

)

Returns the org.omg.dds.type.TypeSupport used to create this TopicDescription.

Returns

the org.omg.dds.type.TypeSupport.

Implemented in org.opensplice.dds.topic.TopicImpl< TYPE >, and org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.

---

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

• java5/common/java/code/org/omg/dds/topic/TopicDescription.java