rclcpp  master
C++ ROS Client Library API
Public Types | Public Attributes | List of all members
rclcpp::SubscriptionFactory Struct Reference

Factory with functions used to create a Subscription<MessageT>. More...

#include <subscription_factory.hpp>

Collaboration diagram for rclcpp::SubscriptionFactory:
Collaboration graph
[legend]

Public Types

using SubscriptionFactoryFunction = std::function< rclcpp::SubscriptionBase::SharedPtr(rclcpp::node_interfaces::NodeBaseInterface *node_base, const std::string &topic_name, rcl_subscription_options_t &subscription_options)>
 
using SetupIntraProcessFunction = std::function< void(rclcpp::intra_process_manager::IntraProcessManager::SharedPtr ipm, rclcpp::SubscriptionBase::SharedPtr subscription, const rcl_subscription_options_t &subscription_options)>
 

Public Attributes

SubscriptionFactoryFunction create_typed_subscription
 
SetupIntraProcessFunction setup_intra_process
 

Detailed Description

Factory with functions used to create a Subscription<MessageT>.

This factory class is used to encapsulate the template generated functions which are used during the creation of a Message type specific subscription within a non-templated class.

It is created using the create_subscription_factory function, which is usually called from a templated "create_subscription" method of the Node class, and is passed to the non-templated "create_subscription" method of the NodeTopics class where it is used to create and setup the Subscription.

Member Typedef Documentation

◆ SubscriptionFactoryFunction

using rclcpp::SubscriptionFactory::SubscriptionFactoryFunction = std::function< rclcpp::SubscriptionBase::SharedPtr( rclcpp::node_interfaces::NodeBaseInterface * node_base, const std::string & topic_name, rcl_subscription_options_t & subscription_options)>

◆ SetupIntraProcessFunction

using rclcpp::SubscriptionFactory::SetupIntraProcessFunction = std::function< void ( rclcpp::intra_process_manager::IntraProcessManager::SharedPtr ipm, rclcpp::SubscriptionBase::SharedPtr subscription, const rcl_subscription_options_t & subscription_options)>

Member Data Documentation

◆ create_typed_subscription

SubscriptionFactoryFunction rclcpp::SubscriptionFactory::create_typed_subscription

◆ setup_intra_process

SetupIntraProcessFunction rclcpp::SubscriptionFactory::setup_intra_process

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