ROS 2 rclcpp + rcl - jazzy  jazzy
ROS 2 C++ Client Library with ROS Client Library
Public Types | Public Member Functions | List of all members
rclcpp::memory_strategies::allocator_memory_strategy::AllocatorMemoryStrategy< Alloc > Class Template Reference

Delegate for handling memory allocations while the Executor is executing. More...

#include <rclcpp/strategies/allocator_memory_strategy.hpp>

Inheritance diagram for rclcpp::memory_strategies::allocator_memory_strategy::AllocatorMemoryStrategy< Alloc >:
Inheritance graph
[legend]
Collaboration diagram for rclcpp::memory_strategies::allocator_memory_strategy::AllocatorMemoryStrategy< Alloc >:
Collaboration graph
[legend]

Public Types

using VoidAllocTraits = typename allocator::AllocRebind< void *, Alloc >
 
using VoidAlloc = typename VoidAllocTraits::allocator_type
 
- Public Types inherited from rclcpp::memory_strategy::MemoryStrategy
using WeakCallbackGroupsToNodesMap = std::map< rclcpp::CallbackGroup::WeakPtr, rclcpp::node_interfaces::NodeBaseInterface::WeakPtr, std::owner_less< rclcpp::CallbackGroup::WeakPtr > >
 

Public Member Functions

 AllocatorMemoryStrategy (std::shared_ptr< Alloc > allocator)
 
void add_guard_condition (const rclcpp::GuardCondition &guard_condition) override
 
void remove_guard_condition (const rclcpp::GuardCondition *guard_condition) override
 
void clear_handles () override
 
void remove_null_handles (rcl_wait_set_t *wait_set) override
 
bool collect_entities (const WeakCallbackGroupsToNodesMap &weak_groups_to_nodes) override
 
void add_waitable_handle (const rclcpp::Waitable::SharedPtr &waitable) override
 
bool add_handles_to_wait_set (rcl_wait_set_t *wait_set) override
 
void get_next_subscription (rclcpp::AnyExecutable &any_exec, const WeakCallbackGroupsToNodesMap &weak_groups_to_nodes) override
 
void get_next_service (rclcpp::AnyExecutable &any_exec, const WeakCallbackGroupsToNodesMap &weak_groups_to_nodes) override
 
void get_next_client (rclcpp::AnyExecutable &any_exec, const WeakCallbackGroupsToNodesMap &weak_groups_to_nodes) override
 
void get_next_timer (rclcpp::AnyExecutable &any_exec, const WeakCallbackGroupsToNodesMap &weak_groups_to_nodes) override
 
void get_next_waitable (rclcpp::AnyExecutable &any_exec, const WeakCallbackGroupsToNodesMap &weak_groups_to_nodes) override
 
rcl_allocator_t get_allocator () override
 
size_t number_of_ready_subscriptions () const override
 
size_t number_of_ready_services () const override
 
size_t number_of_ready_events () const override
 
size_t number_of_ready_clients () const override
 
size_t number_of_guard_conditions () const override
 
size_t number_of_ready_timers () const override
 
size_t number_of_waitables () const override
 

Additional Inherited Members

- Static Public Member Functions inherited from rclcpp::memory_strategy::MemoryStrategy
static rclcpp::SubscriptionBase::SharedPtr get_subscription_by_handle (const std::shared_ptr< const rcl_subscription_t > &subscriber_handle, const WeakCallbackGroupsToNodesMap &weak_groups_to_nodes)
 
static rclcpp::ServiceBase::SharedPtr get_service_by_handle (const std::shared_ptr< const rcl_service_t > &service_handle, const WeakCallbackGroupsToNodesMap &weak_groups_to_nodes)
 
static rclcpp::ClientBase::SharedPtr get_client_by_handle (const std::shared_ptr< const rcl_client_t > &client_handle, const WeakCallbackGroupsToNodesMap &weak_groups_to_nodes)
 
static rclcpp::TimerBase::SharedPtr get_timer_by_handle (const std::shared_ptr< const rcl_timer_t > &timer_handle, const WeakCallbackGroupsToNodesMap &weak_groups_to_nodes)
 
static rclcpp::node_interfaces::NodeBaseInterface::SharedPtr get_node_by_group (const rclcpp::CallbackGroup::SharedPtr &group, const WeakCallbackGroupsToNodesMap &weak_groups_to_nodes)
 
static rclcpp::CallbackGroup::SharedPtr get_group_by_subscription (const rclcpp::SubscriptionBase::SharedPtr &subscription, const WeakCallbackGroupsToNodesMap &weak_groups_to_nodes)
 
static rclcpp::CallbackGroup::SharedPtr get_group_by_service (const rclcpp::ServiceBase::SharedPtr &service, const WeakCallbackGroupsToNodesMap &weak_groups_to_nodes)
 
static rclcpp::CallbackGroup::SharedPtr get_group_by_client (const rclcpp::ClientBase::SharedPtr &client, const WeakCallbackGroupsToNodesMap &weak_groups_to_nodes)
 
static rclcpp::CallbackGroup::SharedPtr get_group_by_timer (const rclcpp::TimerBase::SharedPtr &timer, const WeakCallbackGroupsToNodesMap &weak_groups_to_nodes)
 
static rclcpp::CallbackGroup::SharedPtr get_group_by_waitable (const rclcpp::Waitable::SharedPtr &waitable, const WeakCallbackGroupsToNodesMap &weak_groups_to_nodes)
 

Detailed Description

template<typename Alloc = std::allocator<void>>
class rclcpp::memory_strategies::allocator_memory_strategy::AllocatorMemoryStrategy< Alloc >

Delegate for handling memory allocations while the Executor is executing.

By default, the memory strategy dynamically allocates memory for structures that come in from the rmw implementation after the executor waits for work, based on the number of entities that come through.

Definition at line 47 of file allocator_memory_strategy.hpp.


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