DDS::ITopicDescription Interface Reference
[Topics]

<<interface>> Base class for DDS::Topic, DDS::ContentFilteredTopic, and DDS::MultiTopic. More...

#include <managed_topic.h>

Inheritance diagram for DDS::ITopicDescription:

List of all members.

Public Member Functions
System::String^	get_type_name ()
	Get the associated type_name.
System::String^	get_name ()
	Get the name used to create this DDS::TopicDescription .
DomainParticipant^	get_participant ()
	Get the DDS::DomainParticipant to which the DDS::TopicDescription belongs.

---

Detailed Description

<<interface>> Base class for DDS::Topic, DDS::ContentFilteredTopic, and DDS::MultiTopic.

DDS::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 DDS::TypeSupport.

DDS::TopicDescription has also a name that allows it to be retrieved locally.

See also:

DDS::TypeSupport, FooTypeSupport

---

Member Function Documentation

System::String ^ DDS::ITopicDescription::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 FooTypeSupport::register_type method.

Thus, the type_name implies an association with a corresponding DDS::TypeSupport and this DDS::TopicDescription.

Returns:

the type name. The returned type name is valid until the DDS::TopicDescription is deleted.

Postcondition:

The result is non-NULL.

See also:

DDS::TypeSupport, FooTypeSupport

Implemented in DDS::ContentFilteredTopic, DDS::MultiTopic, and DDS::Topic.

System::String ^ DDS::ITopicDescription::get_name

(

)

Get the name used to create this DDS::TopicDescription .

Returns:

the name used to create this DDS::TopicDescription. The returned topic name is valid until the DDS::TopicDescription is deleted.

Postcondition:

The result is non-NULL.

Implemented in DDS::ContentFilteredTopic, DDS::MultiTopic, and DDS::Topic.

DomainParticipant ^ DDS::ITopicDescription::get_participant

(

)

Get the DDS::DomainParticipant to which the DDS::TopicDescription belongs.

Returns:

The DDS::DomainParticipant to which the DDS::TopicDescription belongs.

Postcondition:

The result is non-NULL.

Implemented in DDS::ContentFilteredTopic, DDS::MultiTopic, and DDS::Topic.