org.omg.dds.topic

Interface TopicDescription<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 description.

All Superinterfaces:

AutoCloseable, Closeable, DDSObject

All Known Subinterfaces:

ContentFilteredTopic<TYPE>, MultiTopic<TYPE>, Topic<TYPE>

public interface TopicDescription<TYPE>
extends Closeable, DDSObject

This interface is the base for Topic, ContentFilteredTopic, and 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 TypeSupport. TopicDescription has also a name that allows it to be retrieved locally.

Method Summary

Methods

Modifier and Type	Method and Description
<OTHER> TopicDescription<OTHER>	cast() Cast this topic description to the given type, or throw an exception if the cast fails.
void	close() Dispose the resources held by this object.
String	getName()
DomainParticipant	getParent()
String	getTypeName()
TypeSupport<TYPE>	getTypeSupport()

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

getEnvironment

Method Detail

getTypeSupport

TypeSupport<TYPE> getTypeSupport()

Returns:

the TypeSupport used to create this TopicDescription.

cast

<OTHER> TopicDescription<OTHER> cast()

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

Type Parameters:

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

Returns:

this topic description

Throws:

ClassCastException - if the cast fails

getTypeName

String getTypeName()

Returns:

the type name used to create the TopicDescription.

getName

String getName()

Returns:

the name used to create the TopicDescription.

getParent

DomainParticipant getParent()

Returns:

the DomainParticipant to which the TopicDescription belongs.

close

void close()

Dispose the resources held by this object. A TopicDescription cannot be closed if it is in use by any DataWriters or DataReaders. With respect to Topics specifically: a Topic cannot be closed if it has any remaining ContentFilteredTopics or MultiTopics related to it.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

See Also:

Entity.close()