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

Mechanism for passing rmw implementation specific settings through the ROS interfaces. More...

#include <rmw_implementation_specific_payload.hpp>

Inheritance diagram for rclcpp::detail::RMWImplementationSpecificPayload:
Inheritance graph
[legend]

Public Member Functions

virtual ~RMWImplementationSpecificPayload ()=default
 
bool has_been_customized () const
 Return false if this class has not been customized, otherwise true. More...
 
virtual const char * get_implementation_identifier () const
 Derrived classes should override this and return the identifier of its rmw implementation. More...
 

Detailed Description

Mechanism for passing rmw implementation specific settings through the ROS interfaces.

Constructor & Destructor Documentation

◆ ~RMWImplementationSpecificPayload()

virtual rclcpp::detail::RMWImplementationSpecificPayload::~RMWImplementationSpecificPayload ( )
virtualdefault

Member Function Documentation

◆ has_been_customized()

bool rclcpp::detail::RMWImplementationSpecificPayload::has_been_customized ( ) const

Return false if this class has not been customized, otherwise true.

It does this based on the value of the rmw implementation identifier that this class reports, and so it is important for a specialization of this class to override the get_rmw_implementation_identifier() method to return something other than nullptr.

◆ get_implementation_identifier()

virtual const char* rclcpp::detail::RMWImplementationSpecificPayload::get_implementation_identifier ( ) const
virtual

Derrived classes should override this and return the identifier of its rmw implementation.


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