DDSTopicDescription Class Reference
[Topics]

<<interface>> Base class for DDSTopic, DDSContentFilteredTopic, and DDSMultiTopic. More...

Inheritance diagram for DDSTopicDescription:

DDSContentFilteredTopic DDSMultiTopic DDSTopic

List of all members.

Public Member Functions

virtual const char * get_type_name ()=0
 Get the associated type_name.
virtual const char * get_name ()=0
 Get the name used to create this DDSTopicDescription .
virtual DDSDomainParticipantget_participant ()=0
 Get the DDSDomainParticipant to which the DDSTopicDescription belongs.


Detailed Description

<<interface>> Base class for DDSTopic, DDSContentFilteredTopic, and DDSMultiTopic.

DDSTopicDescription 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 DDSTypeSupport.

DDSTopicDescription has also a name that allows it to be retrieved locally.

See also:
DDSTypeSupport, FooTypeSupport

Member Function Documentation

virtual const char* DDSTopicDescription::get_type_name (  )  [pure virtual]

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 FooTypeSupport::register_type method.

Thus, the type_name implies an association with a corresponding DDSTypeSupport and this DDSTopicDescription.

Returns:
the type name. The returned type name is valid until the DDSTopicDescription is deleted.
Postcondition:
The result is non-NULL.
See also:
DDSTypeSupport, FooTypeSupport

virtual const char* DDSTopicDescription::get_name (  )  [pure virtual]

Get the name used to create this DDSTopicDescription .

Returns:
the name used to create this DDSTopicDescription. The returned topic name is valid until the DDSTopicDescription is deleted.
Postcondition:
The result is non-NULL.

virtual DDSDomainParticipant* DDSTopicDescription::get_participant (  )  [pure virtual]

Get the DDSDomainParticipant to which the DDSTopicDescription belongs.

Returns:
The DDSDomainParticipant to which the DDSTopicDescription belongs.
Postcondition:
The result is non-NULL.


RTI Connext C++ API Version 4.5f Copyright © 17 Mar 2012 Real-Time Innovations, Inc