rclcpp::SubscriptionOptionsWithAllocator< Allocator > Struct Template Reference

Structure containing optional configuration for Subscriptions. More...

#include <subscription_options.hpp>

Inheritance diagram for rclcpp::SubscriptionOptionsWithAllocator< Allocator >:

Collaboration diagram for rclcpp::SubscriptionOptionsWithAllocator< Allocator >:

Public Member Functions
	SubscriptionOptionsWithAllocator ()
	SubscriptionOptionsWithAllocator (const SubscriptionOptionsBase &subscription_options_base)
	Constructor using base class as input. More...
template<typename MessageT >
rcl_subscription_options_t	to_rcl_subscription_options (const rclcpp::QoS &qos) const
	Convert this class, with a rclcpp::QoS, into an rcl_subscription_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::SubscriptionOptionsBase
SubscriptionEventCallbacks	event_callbacks
	Callbacks for events related to this subscription. More...
bool	use_default_callbacks = true
	Whether or not to use default callbacks when user doesn't supply any in event_callbacks. More...
bool	ignore_local_publications = false
	True to ignore local publications. More...
rclcpp::CallbackGroup::SharedPtr	callback_group = nullptr
	The callback group for this subscription. NULL to use the default callback group. More...
IntraProcessSetting	use_intra_process_comm = IntraProcessSetting::NodeDefault
	Setting to explicitly set intraprocess communications. More...
IntraProcessBufferType	intra_process_buffer_type = IntraProcessBufferType::CallbackDefault
	Setting the data-type stored in the intraprocess buffer. More...
std::shared_ptr< rclcpp::detail::RMWImplementationSpecificSubscriptionPayload >	rmw_implementation_payload = nullptr
	Optional RMW implementation specific payload to be used during creation of the subscription. More...
TopicStatisticsOptions	topic_stats_options

Detailed Description

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

Structure containing optional configuration for Subscriptions.

Constructor & Destructor Documentation

SubscriptionOptionsWithAllocator() [1/2]

template<typename Allocator >

rclcpp::SubscriptionOptionsWithAllocator< Allocator >::SubscriptionOptionsWithAllocator ( )

inline

SubscriptionOptionsWithAllocator() [2/2]

template<typename Allocator >

rclcpp::SubscriptionOptionsWithAllocator< Allocator >::SubscriptionOptionsWithAllocator ( const SubscriptionOptionsBase &  subscription_options_base )

inlineexplicit

Constructor using base class as input.

Member Function Documentation

to_rcl_subscription_options()

template<typename Allocator >

template<typename MessageT >

rcl_subscription_options_t rclcpp::SubscriptionOptionsWithAllocator< Allocator >::to_rcl_subscription_options ( const rclcpp::QoS &  qos ) const

inline

Convert this class, with a rclcpp::QoS, into an rcl_subscription_options_t.

Parameters

qos	QoS profile for subcription.

Returns

rcl_subscription_options_t structure based on the rclcpp::QoS

get_allocator()

template<typename Allocator >

std::shared_ptr<Allocator> rclcpp::SubscriptionOptionsWithAllocator< Allocator >::get_allocator ( ) const

inline

Get the allocator, creating one if needed.

Member Data Documentation

allocator

template<typename Allocator >

std::shared_ptr<Allocator> rclcpp::SubscriptionOptionsWithAllocator< Allocator >::allocator = nullptr

Optional custom allocator.

---

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

• include/rclcpp/subscription_options.hpp