ROS 2 rclcpp + rcl - kilted  kilted
ROS 2 C++ Client Library with ROS Client Library
Public Member Functions | Public Attributes | List of all members
rclcpp::PublisherOptionsWithAllocator< Allocator > Struct Template Reference

Structure containing optional configuration for Publishers. More...

#include <rclcpp/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 (const PublisherOptionsBase &publisher_options_base)
 Constructor using base class as input.
 
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.
 
std::shared_ptr< Allocator > get_allocator () const
 Get the allocator, creating one if needed.
 

Public Attributes

std::shared_ptr< Allocator > allocator = nullptr
 Optional custom allocator.
 
- Public Attributes inherited from rclcpp::PublisherOptionsBase
IntraProcessSetting use_intra_process_comm = IntraProcessSetting::NodeDefault
 Setting to explicitly set intraprocess communications.
 
IntraProcessBufferType intra_process_buffer_type = IntraProcessBufferType::SharedPtr
 Setting the data-type stored in the intraprocess buffer.
 
PublisherEventCallbacks event_callbacks
 Callbacks for various events related to publishers.
 
bool use_default_callbacks = true
 Whether or not to use default callbacks when user doesn't supply any in event_callbacks.
 
rmw_unique_network_flow_endpoints_requirement_t require_unique_network_flow_endpoints
 
std::shared_ptr< rclcpp::CallbackGroupcallback_group
 Callback group in which the waitable items from the publisher should be placed.
 
std::shared_ptr< rclcpp::detail::RMWImplementationSpecificPublisherPayloadrmw_implementation_payload = nullptr
 Optional RMW implementation specific payload to be used during creation of the publisher.
 
QosOverridingOptions qos_overriding_options
 

Detailed Description

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

Structure containing optional configuration for Publishers.

Definition at line 70 of file publisher_options.hpp.


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