ROS 2 rclcpp + rcl - kilted  kilted
ROS 2 C++ Client Library with ROS Client Library
Public Member Functions | List of all members
rclcpp::detail::RMWImplementationSpecificSubscriptionPayload Class Reference

Subscription payload that may be rmw implementation specific. More...

#include <rclcpp/detail/rmw_implementation_specific_subscription_payload.hpp>

Inheritance diagram for rclcpp::detail::RMWImplementationSpecificSubscriptionPayload:
Inheritance graph
[legend]
Collaboration diagram for rclcpp::detail::RMWImplementationSpecificSubscriptionPayload:
Collaboration graph
[legend]

Public Member Functions

virtual void modify_rmw_subscription_options (rmw_subscription_options_t &rmw_subscription_options) const
 Opportunity for a derived class to inject information into the rcl options. More...
 
- Public Member Functions inherited from rclcpp::detail::RMWImplementationSpecificPayload
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.
 

Detailed Description

Subscription payload that may be rmw implementation specific.

Definition at line 29 of file rmw_implementation_specific_subscription_payload.hpp.

Member Function Documentation

◆ modify_rmw_subscription_options()

void rclcpp::detail::RMWImplementationSpecificSubscriptionPayload::modify_rmw_subscription_options ( rmw_subscription_options_t &  rmw_subscription_options) const
virtual

Opportunity for a derived class to inject information into the rcl options.

This is called after the rcl_subscription_options_t has been prepared by rclcpp, but before rcl_subscription_init() is called.

The passed option is the rmw_subscription_options field of the rcl_subscription_options_t that will be passed to rcl_subscription_init().

By default the options are unmodified.

Definition at line 25 of file rmw_implementation_specific_subscription_payload.cpp.


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