rclcpp::memory_strategy::MemoryStrategy Class Reference

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

#include <memory_strategy.hpp>

Inheritance diagram for rclcpp::memory_strategy::MemoryStrategy:

Public Types
using	WeakNodeVector = std::vector< rclcpp::node_interfaces::NodeBaseInterface::WeakPtr >

Public Member Functions
virtual bool	collect_entities (const WeakNodeVector &weak_nodes)=0
virtual size_t	number_of_ready_subscriptions () const =0
virtual size_t	number_of_ready_services () const =0
virtual size_t	number_of_ready_clients () const =0
virtual size_t	number_of_ready_timers () const =0
virtual size_t	number_of_guard_conditions () const =0
virtual bool	add_handles_to_waitset (rcl_wait_set_t *wait_set)=0
virtual void	clear_handles ()=0
virtual void	remove_null_handles (rcl_wait_set_t *wait_set)=0
virtual rclcpp::executor::AnyExecutable::SharedPtr	instantiate_next_executable ()=0
	Provide a newly initialized AnyExecutable object. More...
virtual void	add_guard_condition (const rcl_guard_condition_t *guard_condition)=0
virtual void	remove_guard_condition (const rcl_guard_condition_t *guard_condition)=0
virtual void	get_next_subscription (rclcpp::executor::AnyExecutable::SharedPtr any_exec, const WeakNodeVector &weak_nodes)=0
virtual void	get_next_service (rclcpp::executor::AnyExecutable::SharedPtr any_exec, const WeakNodeVector &weak_nodes)=0
virtual void	get_next_client (rclcpp::executor::AnyExecutable::SharedPtr any_exec, const WeakNodeVector &weak_nodes)=0
virtual rcl_allocator_t	get_allocator ()=0

Static Public Member Functions
static rclcpp::subscription::SubscriptionBase::SharedPtr	get_subscription_by_handle (const rcl_subscription_t *subscriber_handle, const WeakNodeVector &weak_nodes)
static rclcpp::service::ServiceBase::SharedPtr	get_service_by_handle (const rcl_service_t *service_handle, const WeakNodeVector &weak_nodes)
static rclcpp::client::ClientBase::SharedPtr	get_client_by_handle (const rcl_client_t *client_handle, const WeakNodeVector &weak_nodes)
static rclcpp::node_interfaces::NodeBaseInterface::SharedPtr	get_node_by_group (rclcpp::callback_group::CallbackGroup::SharedPtr group, const WeakNodeVector &weak_nodes)
static rclcpp::callback_group::CallbackGroup::SharedPtr	get_group_by_subscription (rclcpp::subscription::SubscriptionBase::SharedPtr subscription, const WeakNodeVector &weak_nodes)
static rclcpp::callback_group::CallbackGroup::SharedPtr	get_group_by_service (rclcpp::service::ServiceBase::SharedPtr service, const WeakNodeVector &weak_nodes)
static rclcpp::callback_group::CallbackGroup::SharedPtr	get_group_by_client (rclcpp::client::ClientBase::SharedPtr client, const WeakNodeVector &weak_nodes)

Detailed Description

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.

Member Typedef Documentation

WeakNodeVector

using rclcpp::memory_strategy::MemoryStrategy::WeakNodeVector = std::vector<rclcpp::node_interfaces::NodeBaseInterface::WeakPtr>

Member Function Documentation

collect_entities()

virtual bool rclcpp::memory_strategy::MemoryStrategy::collect_entities ( const WeakNodeVector &  weak_nodes )

pure virtual

Implemented in rclcpp::memory_strategies::allocator_memory_strategy::AllocatorMemoryStrategy< Alloc >.

number_of_ready_subscriptions()

virtual size_t rclcpp::memory_strategy::MemoryStrategy::number_of_ready_subscriptions ( ) const

pure virtual

Implemented in rclcpp::memory_strategies::allocator_memory_strategy::AllocatorMemoryStrategy< Alloc >.

number_of_ready_services()

virtual size_t rclcpp::memory_strategy::MemoryStrategy::number_of_ready_services ( ) const

pure virtual

Implemented in rclcpp::memory_strategies::allocator_memory_strategy::AllocatorMemoryStrategy< Alloc >.

number_of_ready_clients()

virtual size_t rclcpp::memory_strategy::MemoryStrategy::number_of_ready_clients ( ) const

pure virtual

Implemented in rclcpp::memory_strategies::allocator_memory_strategy::AllocatorMemoryStrategy< Alloc >.

number_of_ready_timers()

virtual size_t rclcpp::memory_strategy::MemoryStrategy::number_of_ready_timers ( ) const

pure virtual

Implemented in rclcpp::memory_strategies::allocator_memory_strategy::AllocatorMemoryStrategy< Alloc >.

number_of_guard_conditions()

virtual size_t rclcpp::memory_strategy::MemoryStrategy::number_of_guard_conditions ( ) const

pure virtual

Implemented in rclcpp::memory_strategies::allocator_memory_strategy::AllocatorMemoryStrategy< Alloc >.

add_handles_to_waitset()

virtual bool rclcpp::memory_strategy::MemoryStrategy::add_handles_to_waitset ( rcl_wait_set_t *  wait_set )

pure virtual

Implemented in rclcpp::memory_strategies::allocator_memory_strategy::AllocatorMemoryStrategy< Alloc >.

clear_handles()

virtual void rclcpp::memory_strategy::MemoryStrategy::clear_handles ( )

pure virtual

Implemented in rclcpp::memory_strategies::allocator_memory_strategy::AllocatorMemoryStrategy< Alloc >.

remove_null_handles()

virtual void rclcpp::memory_strategy::MemoryStrategy::remove_null_handles ( rcl_wait_set_t *  wait_set )

pure virtual

Implemented in rclcpp::memory_strategies::allocator_memory_strategy::AllocatorMemoryStrategy< Alloc >.

instantiate_next_executable()

virtual rclcpp::executor::AnyExecutable::SharedPtr rclcpp::memory_strategy::MemoryStrategy::instantiate_next_executable ( )

pure virtual

Provide a newly initialized AnyExecutable object.

Implemented in rclcpp::memory_strategies::allocator_memory_strategy::AllocatorMemoryStrategy< Alloc >.

add_guard_condition()

virtual void rclcpp::memory_strategy::MemoryStrategy::add_guard_condition ( const rcl_guard_condition_t *  guard_condition )

pure virtual

Implemented in rclcpp::memory_strategies::allocator_memory_strategy::AllocatorMemoryStrategy< Alloc >.

remove_guard_condition()

virtual void rclcpp::memory_strategy::MemoryStrategy::remove_guard_condition ( const rcl_guard_condition_t *  guard_condition )

pure virtual

Implemented in rclcpp::memory_strategies::allocator_memory_strategy::AllocatorMemoryStrategy< Alloc >.

get_next_subscription()

virtual void rclcpp::memory_strategy::MemoryStrategy::get_next_subscription ( rclcpp::executor::AnyExecutable::SharedPtr  any_exec, const WeakNodeVector &  weak_nodes  )

pure virtual

get_next_service()

virtual void rclcpp::memory_strategy::MemoryStrategy::get_next_service ( rclcpp::executor::AnyExecutable::SharedPtr  any_exec, const WeakNodeVector &  weak_nodes  )

pure virtual

get_next_client()

virtual void rclcpp::memory_strategy::MemoryStrategy::get_next_client ( rclcpp::executor::AnyExecutable::SharedPtr  any_exec, const WeakNodeVector &  weak_nodes  )

pure virtual

get_allocator()

virtual rcl_allocator_t rclcpp::memory_strategy::MemoryStrategy::get_allocator ( )

pure virtual

Implemented in rclcpp::memory_strategies::allocator_memory_strategy::AllocatorMemoryStrategy< Alloc >.

get_subscription_by_handle()

static rclcpp::subscription::SubscriptionBase::SharedPtr rclcpp::memory_strategy::MemoryStrategy::get_subscription_by_handle ( const rcl_subscription_t *  subscriber_handle, const WeakNodeVector &  weak_nodes  )

static

get_service_by_handle()

static rclcpp::service::ServiceBase::SharedPtr rclcpp::memory_strategy::MemoryStrategy::get_service_by_handle ( const rcl_service_t *  service_handle, const WeakNodeVector &  weak_nodes  )

static

get_client_by_handle()

static rclcpp::client::ClientBase::SharedPtr rclcpp::memory_strategy::MemoryStrategy::get_client_by_handle ( const rcl_client_t *  client_handle, const WeakNodeVector &  weak_nodes  )

static

get_node_by_group()

static rclcpp::node_interfaces::NodeBaseInterface::SharedPtr rclcpp::memory_strategy::MemoryStrategy::get_node_by_group ( rclcpp::callback_group::CallbackGroup::SharedPtr  group, const WeakNodeVector &  weak_nodes  )

static

get_group_by_subscription()

static rclcpp::callback_group::CallbackGroup::SharedPtr rclcpp::memory_strategy::MemoryStrategy::get_group_by_subscription ( rclcpp::subscription::SubscriptionBase::SharedPtr  subscription, const WeakNodeVector &  weak_nodes  )

static

get_group_by_service()

static rclcpp::callback_group::CallbackGroup::SharedPtr rclcpp::memory_strategy::MemoryStrategy::get_group_by_service ( rclcpp::service::ServiceBase::SharedPtr  service, const WeakNodeVector &  weak_nodes  )

static

get_group_by_client()

static rclcpp::callback_group::CallbackGroup::SharedPtr rclcpp::memory_strategy::MemoryStrategy::get_group_by_client ( rclcpp::client::ClientBase::SharedPtr  client, const WeakNodeVector &  weak_nodes  )

static

---

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

• include/rclcpp/memory_strategy.hpp