Gazebo Transport

API Reference

15.0.0~pre1
FullyQualifiedTopic Class Reference

Type for fully qualified topics. More...

#include <TopicUtils.hh>

Public Member Functions

 FullyQualifiedTopic (const std::string &_partition, const std::string &_ns, const std::string &_topic)
 Constructor.
 
std::optional< std::stringFullTopic () const
 Gets the fully qualified topic if it is valid.
 
const std::stringNamespace () const
 Gets the namespace.
 
const std::stringPartition () const
 Gets the partition.
 
const std::stringTopic () const
 Gets the topic.
 

Detailed Description

Type for fully qualified topics.

Constructor & Destructor Documentation

◆ FullyQualifiedTopic()

FullyQualifiedTopic ( const std::string _partition,
const std::string _ns,
const std::string _topic 
)
inline

Constructor.

Parameters
[in]_partitionPartition
[in]_nsNamespace
[in]_topicUnqualified topic
See also
TopicUtils::FullyQualifiedName

References TopicUtils::FullyQualifiedName().

Member Function Documentation

◆ FullTopic()

std::optional< std::string > FullTopic ( ) const
inline

Gets the fully qualified topic if it is valid.

Returns
THe fully qualified topic if valid, otherwise std::nullopt

◆ Namespace()

const std::string & Namespace ( ) const
inline

Gets the namespace.

Returns
namespace

◆ Partition()

const std::string & Partition ( ) const
inline

Gets the partition.

Returns
partition

◆ Topic()

const std::string & Topic ( ) const
inline

Gets the topic.

Returns
topic

The documentation for this class was generated from the following file: