Structure containing optional configuration for Subscriptions. More...
#include <rclcpp/subscription_options.hpp>
Public Member Functions | |
| SubscriptionOptionsWithAllocator (const SubscriptionOptionsBase &subscription_options_base) | |
| Constructor using base class as input. | |
| 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 |
Public Attributes | |
| std::shared_ptr< Allocator > | allocator = nullptr |
| Optional custom allocator. | |
 Public Attributes inherited from rclcpp::SubscriptionOptionsBase | |
| SubscriptionEventCallbacks | event_callbacks |
| Callbacks for events related to this subscription. | |
| bool | use_default_callbacks = true |
| Whether or not to use default callbacks when user doesn't supply any in event_callbacks. | |
| bool | ignore_local_publications = false |
| True to ignore local publications. | |
| rmw_unique_network_flow_endpoints_requirement_t | require_unique_network_flow_endpoints |
| rclcpp::CallbackGroup::SharedPtr | callback_group = nullptr |
| The callback group for this subscription. NULL to use the default callback group. | |
| IntraProcessSetting | use_intra_process_comm = IntraProcessSetting::NodeDefault |
| Setting to explicitly set intraprocess communications. | |
| IntraProcessBufferType | intra_process_buffer_type = IntraProcessBufferType::CallbackDefault |
| Setting the data-type stored in the intraprocess buffer. | |
| std::shared_ptr< rclcpp::detail::RMWImplementationSpecificSubscriptionPayload > | rmw_implementation_payload = nullptr |
| Optional RMW implementation specific payload to be used during creation of the subscription. | |
| TopicStatisticsOptions | topic_stats_options |
| QosOverridingOptions | qos_overriding_options |
| ContentFilterOptions | content_filter_options |
Detailed Description
template<typename Allocator>
struct rclcpp::SubscriptionOptionsWithAllocator< Allocator >
Structure containing optional configuration for Subscriptions.
Definition at line 91 of file subscription_options.hpp.
Member Function Documentation
◆ to_rcl_subscription_options()
|
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
Definition at line 115 of file subscription_options.hpp.
References rcl_subscription_options_s::allocator, rclcpp::ContentFilterOptions::expression_parameters, rclcpp::ContentFilterOptions::filter_expression, rclcpp::get_c_string(), rclcpp::get_c_vector_string(), rclcpp::QoS::get_rmw_qos_profile(), rclcpp::SubscriptionOptionsBase::ignore_local_publications, rcl_subscription_options_s::qos, RCL_RET_OK, rcl_subscription_get_default_options(), rcl_subscription_options_set_content_filter_options(), rclcpp::SubscriptionOptionsBase::require_unique_network_flow_endpoints, rclcpp::SubscriptionOptionsBase::rmw_implementation_payload, and rcl_subscription_options_s::rmw_subscription_options.
The documentation for this struct was generated from the following file:
- rclcpp/include/rclcpp/subscription_options.hpp
