dds::topic::TopicBuiltinTopicData Class Reference

Entry created when a dds::topic::Topic object is discovered. More...

#include <dds/topic/BuiltinTopic.hpp>

Public Member Functions
const dds::topic::BuiltinTopicKey &	key () const
	Get the DCPS key to distinguish entries. More...
const dds::core::string &	name () const
	Get the name of the dds::topic::Topic. More...
const dds::core::string &	type_name () const
	Get the name of the type attached to the dds::topic::Topic. More...
const dds::core::policy::Durability &	durability () const
	Get the dds::core::policy::Durability policy of the corresponding dds::topic::Topic. More...
const dds::core::policy::DurabilityService &	durability_service () const
	Get the dds::core::policy::DurabilityService policy of the corresponding dds::topic::Topic. More...
const dds::core::policy::Deadline &	deadline () const
	Get the dds::core::policy::Deadline policy of the corresponding dds::topic::Topic. More...
const dds::core::policy::LatencyBudget &	latency_budget () const
	Get the dds::core::policy::LatencyBudget policy of the corresponding dds::topic::Topic. More...
const dds::core::policy::Liveliness &	liveliness () const
	Get the dds::core::policy::Liveliness policy of the corresponding dds::topic::Topic. More...
const dds::core::policy::Reliability &	reliability () const
	Get the dds::core::policy::Reliability policy of the corresponding dds::topic::Topic. More...
const dds::core::policy::TransportPriority &	transport_priority () const
	Get the dds::core::policy::TransportPriority policy of the corresponding dds::topic::Topic. More...
const dds::core::policy::Lifespan &	lifespan () const
	Get the dds::core::policy::Lifespan policy of the corresponding dds::topic::Topic. More...
const dds::core::policy::DestinationOrder &	destination_order () const
	Get the dds::core::policy::DestinationOrder policy of the corresponding dds::topic::Topic. More...
const dds::core::policy::History &	history () const
	Get the dds::core::policy::History policy of the corresponding dds::topic::Topic. More...
const dds::core::policy::ResourceLimits &	resource_limits () const
	Get the dds::core::policy::ResourceLimits policy of the corresponding dds::topic::Topic. More...
const dds::core::policy::Ownership &	ownership () const
	Get the dds::core::policy::Ownership policy of the corresponding dds::topic::Topic. More...
const dds::core::policy::TopicData &	topic_data () const
	Get the dds::core::policy::TopicData policy of the corresponding dds::topic::Topic. More...
const dds::core::policy::DataRepresentation &	representation () const
	Get the dds::core::policy::DataRepresentation policy of the corresponding dds::topic::Topic. More...

Detailed Description

Entry created when a dds::topic::Topic object is discovered.

Data associated with the built-in topic dds::topic::topic_topic_name(). It contains QoS policies and additional information that apply to the remote dds::topic::Topic.

Note: The dds::topic::TopicBuiltinTopicData built-in topic is meant to convey information about discovered Topics. This Topic's samples are not propagated in a separate packet on the wire. Instead, the data is sent as part of the information carried by other built-in topics (dds::topic::PublicationBuiltinTopicData and dds::topic::SubscriptionBuiltinTopicData). Therefore TopicBuiltinTopicData DataReaders will not receive any data.

Member Function Documentation

key()

const dds::topic::BuiltinTopicKey& dds::topic::TopicBuiltinTopicData::key ( ) const

inline

Get the DCPS key to distinguish entries.

Returns

The key

name()

const dds::core::string& dds::topic::TopicBuiltinTopicData::name ( ) const

inline

Get the name of the dds::topic::Topic.

Returns

The topic's name

type_name()

const dds::core::string& dds::topic::TopicBuiltinTopicData::type_name ( ) const

inline

Get the name of the type attached to the dds::topic::Topic.

Returns

The type's name

durability()

const dds::core::policy::Durability& dds::topic::TopicBuiltinTopicData::durability ( ) const

inline

Get the dds::core::policy::Durability policy of the corresponding dds::topic::Topic.

Returns

The Durability policy

durability_service()

const dds::core::policy::DurabilityService& dds::topic::TopicBuiltinTopicData::durability_service ( ) const

inline

Get the dds::core::policy::DurabilityService policy of the corresponding dds::topic::Topic.

Returns

The DurabilityService policy

deadline()

const dds::core::policy::Deadline& dds::topic::TopicBuiltinTopicData::deadline ( ) const

inline

Get the dds::core::policy::Deadline policy of the corresponding dds::topic::Topic.

Returns

The Deadline policy

latency_budget()

const dds::core::policy::LatencyBudget& dds::topic::TopicBuiltinTopicData::latency_budget ( ) const

inline

Get the dds::core::policy::LatencyBudget policy of the corresponding dds::topic::Topic.

Returns

The LatencyBudget policy

liveliness()

const dds::core::policy::Liveliness& dds::topic::TopicBuiltinTopicData::liveliness ( ) const

inline

Get the dds::core::policy::Liveliness policy of the corresponding dds::topic::Topic.

Returns

The Liveliness policy

reliability()

const dds::core::policy::Reliability& dds::topic::TopicBuiltinTopicData::reliability ( ) const

inline

Get the dds::core::policy::Reliability policy of the corresponding dds::topic::Topic.

Returns

The Reliability policy

transport_priority()

const dds::core::policy::TransportPriority& dds::topic::TopicBuiltinTopicData::transport_priority ( ) const

inline

Get the dds::core::policy::TransportPriority policy of the corresponding dds::topic::Topic.

Returns

The TransportPriority policy

lifespan()

const dds::core::policy::Lifespan& dds::topic::TopicBuiltinTopicData::lifespan ( ) const

inline

Get the dds::core::policy::Lifespan policy of the corresponding dds::topic::Topic.

Returns

The Lifespan policy

destination_order()

const dds::core::policy::DestinationOrder& dds::topic::TopicBuiltinTopicData::destination_order ( ) const

inline

Get the dds::core::policy::DestinationOrder policy of the corresponding dds::topic::Topic.

Returns

The DestinationOrder policy

history()

const dds::core::policy::History& dds::topic::TopicBuiltinTopicData::history ( ) const

inline

Get the dds::core::policy::History policy of the corresponding dds::topic::Topic.

Returns

The History policy

resource_limits()

const dds::core::policy::ResourceLimits& dds::topic::TopicBuiltinTopicData::resource_limits ( ) const

inline

Get the dds::core::policy::ResourceLimits policy of the corresponding dds::topic::Topic.

Returns

The ResourceLimits policy

ownership()

const dds::core::policy::Ownership& dds::topic::TopicBuiltinTopicData::ownership ( ) const

inline

Get the dds::core::policy::Ownership policy of the corresponding dds::topic::Topic.

Returns

The Ownership policy

topic_data()

const dds::core::policy::TopicData& dds::topic::TopicBuiltinTopicData::topic_data ( ) const

inline

Get the dds::core::policy::TopicData policy of the corresponding dds::topic::Topic.

Returns

The TopicData policy

representation()

const dds::core::policy::DataRepresentation& dds::topic::TopicBuiltinTopicData::representation ( ) const

inline

Get the dds::core::policy::DataRepresentation policy of the corresponding dds::topic::Topic.

Returns

The DataRepresentation policy