rclcpp::node_interfaces::NodeInterfaceHandle< Tag > Class Template Reference

One slice's handle; Tag only keeps the five spellings distinct types. More...

#include <node.hpp>

Public Types
using	SharedPtr = NodeInterfaceHandle
	Upstream's Node*InterfaceSharedPtr — the handle itself (no allocator).

Public Member Functions
Context	get_context () const
Node *	node () const
	The node this handle names (null for a default-constructed one).
	NodeInterfaceHandle ()
	NodeInterfaceHandle (Node *node)
	operator bool () const
const NodeInterfaceHandle *	operator-> () const

Detailed Description

template<int Tag>
class rclcpp::node_interfaces::NodeInterfaceHandle< Tag >

One slice's handle; Tag only keeps the five spellings distinct types.

Member Typedef Documentation

SharedPtr

template<int Tag>

using rclcpp::node_interfaces::NodeInterfaceHandle< Tag >::SharedPtr = NodeInterfaceHandle

Upstream's Node*InterfaceSharedPtr — the handle itself (no allocator).

Constructor & Destructor Documentation

NodeInterfaceHandle() [1/2]

template<int Tag>

rclcpp::node_interfaces::NodeInterfaceHandle< Tag >::NodeInterfaceHandle ( )

inline

NodeInterfaceHandle() [2/2]

template<int Tag>

rclcpp::node_interfaces::NodeInterfaceHandle< Tag >::NodeInterfaceHandle ( Node * node )

inlineexplicit

Member Function Documentation

get_context()

template<int Tag>

Context rclcpp::node_interfaces::NodeInterfaceHandle< Tag >::get_context ( ) const

inline

NodeBaseInterface::get_context() (phase-488; Nav2's lifecycle node registers its pre-shutdown hook through it): the context of the executor the node was created on. Defined in rclcpp.hpp.

node()

template<int Tag>

Node * rclcpp::node_interfaces::NodeInterfaceHandle< Tag >::node ( ) const

inline

The node this handle names (null for a default-constructed one).

operator bool()

template<int Tag>

rclcpp::node_interfaces::NodeInterfaceHandle< Tag >::operator bool ( ) const

inlineexplicit

operator->()

template<int Tag>

const NodeInterfaceHandle * rclcpp::node_interfaces::NodeInterfaceHandle< Tag >::operator-> ( ) const

inline

-> reaches the handle itself, so get_node_base_interface()->... spells as upstream's does (phase-488).

---

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

• include/rclcpp/node.hpp
• include/rclcpp/rclcpp.hpp