TopicDescription Interface Reference

com.rti.dds.topic.Topic entity and associated elements More...

Inheritance diagram for TopicDescription:

Public Member Functions
String	get_type_name ()
	Get the associated type_name.
String	get_name ()
	Get the name used to create this com.rti.dds.topic.TopicDescription .
DomainParticipant	get_participant ()
	Get the com.rti.dds.domain.DomainParticipant to which the com.rti.dds.topic.TopicDescription belongs.

Detailed Description

com.rti.dds.topic.Topic entity and associated elements

<<interface>> Base class for com.rti.dds.topic.Topic, com.rti.dds.topic.ContentFilteredTopic, and com.rti.dds.topic.MultiTopic.

com.rti.dds.topic.TopicDescription represents the fact that both publications and subscriptions are tied to a single data-type. Its attribute type_name defines a unique resulting type for the publication or the subscription and therefore creates an implicit association with a com.rti.dds.topic.TypeSupport.

com.rti.dds.topic.TopicDescription has also a name that allows it to be retrieved locally.

See Also

com.rti.dds.topic.TypeSupport, com.rti.ndds.example.FooTypeSupport

Member Function Documentation

String get_type_name

(

)

Get the associated type_name.

The type name defines a locally unique type for the publication or the subscription.

The type_name corresponds to a unique string used to register a type via the com.rti.ndds.example.FooTypeSupport.register_type method.

Thus, the type_name implies an association with a corresponding com.rti.dds.topic.TypeSupport and this com.rti.dds.topic.TopicDescription.

Returns

the type name. The returned type name is valid until the com.rti.dds.topic.TopicDescription is deleted.

Postcondition

The result is non-NULL.

See Also

com.rti.dds.topic.TypeSupport, com.rti.ndds.example.FooTypeSupport

String get_name

(

)

Get the name used to create this com.rti.dds.topic.TopicDescription .

Returns

the name used to create this com.rti.dds.topic.TopicDescription. The returned topic name is valid until the com.rti.dds.topic.TopicDescription is deleted.

Postcondition

The result is non-NULL.

DomainParticipant get_participant

(

)

Get the com.rti.dds.domain.DomainParticipant to which the com.rti.dds.topic.TopicDescription belongs.

Returns

The com.rti.dds.domain.DomainParticipant to which the com.rti.dds.topic.TopicDescription belongs.

Postcondition

The result is non-NULL.