DDS::ITopicDescription Interface Reference

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

#include <managed_topic.h>

Inheritance diagram for DDS::ITopicDescription:

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

Detailed Description

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

ITopicDescription 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.

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

See also

DDS::TypeSupport, FooTypeSupport

Member Function Documentation

get_type_name()

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 ITopicDescription.

Returns

the type name. The returned type name is valid until the ITopicDescription is deleted.

Postcondition

The result is non-NULL.

See also

DDS::TypeSupport, FooTypeSupport

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

get_name()

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

(

)

Get the name used to create this ITopicDescription .

Returns

the name used to create this ITopicDescription. The returned topic name is valid until the ITopicDescription is deleted.

Postcondition

The result is non-NULL.

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

get_participant()

DomainParticipant ^ DDS::ITopicDescription::get_participant

(

)

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

Returns

The DDS::DomainParticipant to which the ITopicDescription belongs.

Postcondition

The result is non-NULL.

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