rclcpp  master
C++ ROS Client Library API
Public Member Functions | Public Attributes | List of all members
rclcpp::PublisherOptionsWithAllocator< Allocator > Struct Template Reference

Structure containing optional configuration for Publishers. More...

#include <publisher_options.hpp>

Inheritance diagram for rclcpp::PublisherOptionsWithAllocator< Allocator >:
Inheritance graph
[legend]
Collaboration diagram for rclcpp::PublisherOptionsWithAllocator< Allocator >:
Collaboration graph
[legend]

Public Member Functions

 PublisherOptionsWithAllocator ()
 
 PublisherOptionsWithAllocator (const PublisherOptionsBase &publisher_options_base)
 Constructor using base class as input. More...
 
template<typename MessageT >
rcl_publisher_options_t to_rcl_publisher_options (const rclcpp::QoS &qos) const
 Convert this class, and a rclcpp::QoS, into an rcl_publisher_options_t. More...
 
std::shared_ptr< Allocator > get_allocator () const
 Get the allocator, creating one if needed. More...
 

Public Attributes

std::shared_ptr< Allocator > allocator = nullptr
 Optional custom allocator. More...
 
- Public Attributes inherited from rclcpp::PublisherOptionsBase
IntraProcessSetting use_intra_process_comm = IntraProcessSetting::NodeDefault
 Setting to explicitly set intraprocess communications. More...
 
PublisherEventCallbacks event_callbacks
 Callbacks for various events related to publishers. More...
 
std::shared_ptr< rclcpp::callback_group::CallbackGroupcallback_group
 Callback group in which the waitable items from the publisher should be placed. More...
 
std::shared_ptr< rclcpp::detail::RMWImplementationSpecificPublisherPayloadrmw_implementation_payload = nullptr
 Optional RMW implementation specific payload to be used during creation of the publisher. More...
 

Detailed Description

template<typename Allocator>
struct rclcpp::PublisherOptionsWithAllocator< Allocator >

Structure containing optional configuration for Publishers.

Constructor & Destructor Documentation

◆ PublisherOptionsWithAllocator() [1/2]

template<typename Allocator>
rclcpp::PublisherOptionsWithAllocator< Allocator >::PublisherOptionsWithAllocator ( )
inline

◆ PublisherOptionsWithAllocator() [2/2]

template<typename Allocator>
rclcpp::PublisherOptionsWithAllocator< Allocator >::PublisherOptionsWithAllocator ( const PublisherOptionsBase publisher_options_base)
inlineexplicit

Constructor using base class as input.

Member Function Documentation

◆ to_rcl_publisher_options()

template<typename Allocator>
template<typename MessageT >
rcl_publisher_options_t rclcpp::PublisherOptionsWithAllocator< Allocator >::to_rcl_publisher_options ( const rclcpp::QoS qos) const
inline

Convert this class, and a rclcpp::QoS, into an rcl_publisher_options_t.

◆ get_allocator()

template<typename Allocator>
std::shared_ptr<Allocator> rclcpp::PublisherOptionsWithAllocator< Allocator >::get_allocator ( ) const
inline

Get the allocator, creating one if needed.

Member Data Documentation

◆ allocator

template<typename Allocator>
std::shared_ptr<Allocator> rclcpp::PublisherOptionsWithAllocator< Allocator >::allocator = nullptr

Optional custom allocator.


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