This class is the base for Topic, ContentFilteredTopic and MultiTopic. More...

Inheritance diagram for dds::topic::TopicDescription:

[legend]

Collaboration diagram for dds::topic::TopicDescription:

Public Member Functions
const std::string &	name () const
	This operation returns the name used to create the TopicDescription. More...

const std::string &	type_name () const
	This operation returns the registered name of the data type associated with the TopicDescription. More...

const dds::domain::DomainParticipant &	domain_participant () const
	This operation returns the DomainParticipant associated with the TopicDescription. More...

const dds::domain::DomainParticipant &	participant () const
	This operation returns the DomainParticipant associated with the TopicDescription. More...

Public Member Functions inherited from dds::core::Reference< DELEGATE >
	Reference (dds::core::null_type &)
	Creates a "null" reference.

	Reference (const Reference &ref)
	Creates a reference from another. More...

template<typename D >
	Reference (const Reference< D > &ref)
	Enables safe assignment from other reference types. More...

	Reference (DELEGATE_T *p)
	The following two constructors create a dds Reference from a vendor specific delegate. More...

	~Reference ()
	Destroys a reference.

template<typename R >
bool	operator== (const R &ref) const
	Compares two reference objects and returns true if they are equal. More...

template<typename R >
bool	operator!= (const R &ref) const
	Compares two reference objects and returns true if they are not-equal. More...

Reference &	operator= (const null_type)
	Special assignment operators that takes care of assigning null to this reference. More...

bool	is_nil () const
	Returns true if this reference object is nil, meaning pointing to null.

bool	operator== (const null_type) const
	Special `operator==` used to check if this reference object equals the `null` reference. More...

bool	operator!= (const null_type nil) const
	Special `operator!=` used to check if this reference object does not equals the `null` reference. More...

const DELEGATE_REF_T &	delegate () const
	Returns a reference to the underlying delegate. More...

DELEGATE_REF_T &	delegate ()
	Returns a reference to the underlying delegate. More...

DELEGATE *	operator-> ()
	The `operator->()` is provided to be able to directly invoke methods on the delegate. More...

const DELEGATE *	operator-> () const
	The `operator->()` is provided to be able to directly invoke methods on the delegate. More...

Detailed Description

This class is the base for Topic, ContentFilteredTopic and MultiTopic.

The TopicDescription attribute type_name defines an unique data type that is made available to the Data Distribution Service when a Topic is created with that type.
TopicDescription has also a name that allows it to be retrieved locally.

Member Function Documentation

◆ domain_participant()

const dds::domain::DomainParticipant& dds::topic::TopicDescription::domain_participant ( ) const

This operation returns the DomainParticipant associated with the TopicDescription.

Note that there is exactly one DomainParticipant associated with each TopicDescription.

Returns: the DomainParticipant

◆ name()

const std::string& dds::topic::TopicDescription::name ( ) const

This operation returns the name used to create the TopicDescription.

Returns: the TopicDescription name

◆ participant()

const dds::domain::DomainParticipant& dds::topic::TopicDescription::participant ( ) const

This operation returns the DomainParticipant associated with the TopicDescription.

Note that there is exactly one DomainParticipant associated with each TopicDescription.

Returns: the DomainParticipant

◆ type_name()

const std::string& dds::topic::TopicDescription::type_name ( ) const

This operation returns the registered name of the data type associated with the TopicDescription.