RTI Connext Modern C++ API  Version 5.2.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
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::BuiltinTopicKeykey () const
 Get the DCPS key to distinguish entries.
 
const dds::core::stringname () const
 Get the name of the dds::topic::Topic.
 
const dds::core::stringtype_name () const
 Get the name of the type attached to the dds::topic::Topic.
 
const
dds::core::policy::Durability
durability () const
 Get the dds::core::policy::Durability policy of the corresponding dds::topic::Topic.
 
const
dds::core::policy::DurabilityService
durability_service () const
 Get the dds::core::policy::DurabilityService policy of the corresponding dds::topic::Topic.
 
const dds::core::policy::Deadlinedeadline () const
 Get the dds::core::policy::Deadline policy of the corresponding dds::topic::Topic.
 
const
dds::core::policy::LatencyBudget
latency_budget () const
 Get the dds::core::policy::LatencyBudget policy of the corresponding dds::topic::Topic.
 
const
dds::core::policy::Liveliness
liveliness () const
 Get the dds::core::policy::Liveliness policy of the corresponding dds::topic::Topic.
 
const
dds::core::policy::Reliability
reliability () const
 Get the dds::core::policy::Reliability policy of the corresponding dds::topic::Topic.
 
const
dds::core::policy::TransportPriority
transport_priority () const
 Get the dds::core::policy::TransportPriority policy of the corresponding dds::topic::Topic.
 
const dds::core::policy::Lifespanlifespan () const
 Get the dds::core::policy::Lifespan policy of the corresponding dds::topic::Topic.
 
const
dds::core::policy::DestinationOrder
destination_order () const
 Get the dds::core::policy::DestinationOrder policy of the corresponding dds::topic::Topic.
 
const dds::core::policy::Historyhistory () const
 Get the dds::core::policy::History policy of the corresponding dds::topic::Topic.
 
const
dds::core::policy::ResourceLimits
resource_limits () const
 Get the dds::core::policy::ResourceLimits policy of the corresponding dds::topic::Topic.
 
const
dds::core::policy::Ownership
ownership () const
 Get the dds::core::policy::Ownership policy of the corresponding dds::topic::Topic.
 
const
dds::core::policy::TopicData
topic_data () const
 Get the dds::core::policy::TopicData policy of the corresponding dds::topic::Topic.
 

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

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

Get the DCPS key to distinguish entries.

Returns
The key
const dds::core::string& dds::topic::TopicBuiltinTopicData::name ( ) const
inline

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

Returns
The topic's 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
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
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
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
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
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
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
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
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
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
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
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
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
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

RTI Connext Modern C++ API Version 5.2.0 Copyright © Sun Jun 21 2015 Real-Time Innovations, Inc