rclcpp  master
C++ ROS Client Library API
Public Member Functions | List of all members
rclcpp::TopicEndpointInfo Class Reference

#include <node_graph_interface.hpp>

Public Member Functions

 TopicEndpointInfo (const rcl_topic_endpoint_info_t &info)
 Construct a TopicEndpointInfo from a rcl_topic_endpoint_info_t. More...
 
std::stringnode_name ()
 Get a mutable reference to the node name. More...
 
const std::stringnode_name () const
 Get a const reference to the node name. More...
 
std::stringnode_namespace ()
 Get a mutable reference to the node namespace. More...
 
const std::stringnode_namespace () const
 Get a const reference to the node namespace. More...
 
std::stringtopic_type ()
 Get a mutable reference to the topic type string. More...
 
const std::stringtopic_type () const
 Get a const reference to the topic type string. More...
 
rclcpp::EndpointTypeendpoint_type ()
 Get a mutable reference to the topic endpoint type. More...
 
const rclcpp::EndpointTypeendpoint_type () const
 Get a const reference to the topic endpoint type. More...
 
std::array< uint8_t, RMW_GID_STORAGE_SIZE > & endpoint_gid ()
 Get a mutable reference to the GID of the topic endpoint. More...
 
const std::array< uint8_t, RMW_GID_STORAGE_SIZE > & endpoint_gid () const
 Get a const reference to the GID of the topic endpoint. More...
 
rclcpp::QoSqos_profile ()
 Get a mutable reference to the QoS profile of the topic endpoint. More...
 
const rclcpp::QoSqos_profile () const
 Get a const reference to the QoS profile of the topic endpoint. More...
 

Detailed Description

Struct that contains topic endpoint information like the associated node name, node namespace, topic type, endpoint type, endpoint GID, and its QoS.

Constructor & Destructor Documentation

◆ TopicEndpointInfo()

rclcpp::TopicEndpointInfo::TopicEndpointInfo ( const rcl_topic_endpoint_info_t &  info)
inlineexplicit

Construct a TopicEndpointInfo from a rcl_topic_endpoint_info_t.

Member Function Documentation

◆ node_name() [1/2]

std::string& rclcpp::TopicEndpointInfo::node_name ( )

Get a mutable reference to the node name.

◆ node_name() [2/2]

const std::string& rclcpp::TopicEndpointInfo::node_name ( ) const

Get a const reference to the node name.

◆ node_namespace() [1/2]

std::string& rclcpp::TopicEndpointInfo::node_namespace ( )

Get a mutable reference to the node namespace.

◆ node_namespace() [2/2]

const std::string& rclcpp::TopicEndpointInfo::node_namespace ( ) const

Get a const reference to the node namespace.

◆ topic_type() [1/2]

std::string& rclcpp::TopicEndpointInfo::topic_type ( )

Get a mutable reference to the topic type string.

◆ topic_type() [2/2]

const std::string& rclcpp::TopicEndpointInfo::topic_type ( ) const

Get a const reference to the topic type string.

◆ endpoint_type() [1/2]

rclcpp::EndpointType& rclcpp::TopicEndpointInfo::endpoint_type ( )

Get a mutable reference to the topic endpoint type.

◆ endpoint_type() [2/2]

const rclcpp::EndpointType& rclcpp::TopicEndpointInfo::endpoint_type ( ) const

Get a const reference to the topic endpoint type.

◆ endpoint_gid() [1/2]

std::array<uint8_t, RMW_GID_STORAGE_SIZE>& rclcpp::TopicEndpointInfo::endpoint_gid ( )

Get a mutable reference to the GID of the topic endpoint.

◆ endpoint_gid() [2/2]

const std::array<uint8_t, RMW_GID_STORAGE_SIZE>& rclcpp::TopicEndpointInfo::endpoint_gid ( ) const

Get a const reference to the GID of the topic endpoint.

◆ qos_profile() [1/2]

rclcpp::QoS& rclcpp::TopicEndpointInfo::qos_profile ( )

Get a mutable reference to the QoS profile of the topic endpoint.

◆ qos_profile() [2/2]

const rclcpp::QoS& rclcpp::TopicEndpointInfo::qos_profile ( ) const

Get a const reference to the QoS profile of the topic endpoint.


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