rclcpp::node_interfaces::NodeParameters Class Reference

Implementation of the NodeParameters part of the Node API. More...

#include <node_parameters.hpp>

Inheritance diagram for rclcpp::node_interfaces::NodeParameters:

Collaboration diagram for rclcpp::node_interfaces::NodeParameters:

Public Member Functions
	NodeParameters (const node_interfaces::NodeBaseInterface::SharedPtr node_base, const node_interfaces::NodeTopicsInterface::SharedPtr node_topics, const node_interfaces::NodeServicesInterface::SharedPtr node_services, const node_interfaces::NodeClockInterface::SharedPtr node_clock, const std::vector< Parameter > &initial_parameters, bool use_intra_process, bool start_parameter_services)
virtual	~NodeParameters ()
virtual std::vector< rcl_interfaces::msg::SetParametersResult >	set_parameters (const std::vector< rclcpp::Parameter > &parameters)
virtual rcl_interfaces::msg::SetParametersResult	set_parameters_atomically (const std::vector< rclcpp::Parameter > &parameters)
virtual std::vector< rclcpp::Parameter >	get_parameters (const std::vector< std::string > &names) const
	Get descriptions of parameters given their names. More...
virtual rclcpp::Parameter	get_parameter (const std::string &name) const
	Get the description of one parameter given a name. More...
virtual bool	get_parameter (const std::string &name, rclcpp::Parameter &parameter) const
	Get the description of one parameter given a name. More...
virtual std::vector< rcl_interfaces::msg::ParameterDescriptor >	describe_parameters (const std::vector< std::string > &names) const
virtual std::vector< uint8_t >	get_parameter_types (const std::vector< std::string > &names) const
virtual rcl_interfaces::msg::ListParametersResult	list_parameters (const std::vector< std::string > &prefixes, uint64_t depth) const
virtual void	register_param_change_callback (ParametersCallbackFunction callback)
Public Member Functions inherited from rclcpp::node_interfaces::NodeParametersInterface
virtual	~NodeParametersInterface ()=default

Additional Inherited Members
Public Types inherited from rclcpp::node_interfaces::NodeParametersInterface
using	ParametersCallbackFunction = std::function< rcl_interfaces::msg::SetParametersResult(const std::vector< rclcpp::Parameter > &)>

Detailed Description

Implementation of the NodeParameters part of the Node API.

Constructor & Destructor Documentation

NodeParameters()

rclcpp::node_interfaces::NodeParameters::NodeParameters	(	const node_interfaces::NodeBaseInterface::SharedPtr	node_base,
		const node_interfaces::NodeTopicsInterface::SharedPtr	node_topics,
		const node_interfaces::NodeServicesInterface::SharedPtr	node_services,
		const node_interfaces::NodeClockInterface::SharedPtr	node_clock,
		const std::vector< Parameter > &	initial_parameters,
		bool	use_intra_process,
		bool	start_parameter_services
	)

~NodeParameters()

virtual rclcpp::node_interfaces::NodeParameters::~NodeParameters ( )

virtual

Member Function Documentation

set_parameters()

virtual std::vector<rcl_interfaces::msg::SetParametersResult> rclcpp::node_interfaces::NodeParameters::set_parameters ( const std::vector< rclcpp::Parameter > &  parameters )

virtual

Implements rclcpp::node_interfaces::NodeParametersInterface.

set_parameters_atomically()

virtual rcl_interfaces::msg::SetParametersResult rclcpp::node_interfaces::NodeParameters::set_parameters_atomically ( const std::vector< rclcpp::Parameter > &  parameters )

virtual

Implements rclcpp::node_interfaces::NodeParametersInterface.

get_parameters()

virtual std::vector<rclcpp::Parameter> rclcpp::node_interfaces::NodeParameters::get_parameters ( const std::vector< std::string > &  names ) const

virtual

Get descriptions of parameters given their names.

Implements rclcpp::node_interfaces::NodeParametersInterface.

get_parameter() [1/2]

virtual rclcpp::Parameter rclcpp::node_interfaces::NodeParameters::get_parameter ( const std::string &  name ) const

virtual

Get the description of one parameter given a name.

Implements rclcpp::node_interfaces::NodeParametersInterface.

get_parameter() [2/2]

virtual bool rclcpp::node_interfaces::NodeParameters::get_parameter ( const std::string &  name, rclcpp::Parameter &  parameter  ) const

virtual

Get the description of one parameter given a name.

Implements rclcpp::node_interfaces::NodeParametersInterface.

describe_parameters()

virtual std::vector<rcl_interfaces::msg::ParameterDescriptor> rclcpp::node_interfaces::NodeParameters::describe_parameters ( const std::vector< std::string > &  names ) const

virtual

Implements rclcpp::node_interfaces::NodeParametersInterface.

get_parameter_types()

virtual std::vector<uint8_t> rclcpp::node_interfaces::NodeParameters::get_parameter_types ( const std::vector< std::string > &  names ) const

virtual

Implements rclcpp::node_interfaces::NodeParametersInterface.

list_parameters()

virtual rcl_interfaces::msg::ListParametersResult rclcpp::node_interfaces::NodeParameters::list_parameters ( const std::vector< std::string > &  prefixes, uint64_t  depth  ) const

virtual

Implements rclcpp::node_interfaces::NodeParametersInterface.

register_param_change_callback()

virtual void rclcpp::node_interfaces::NodeParameters::register_param_change_callback ( ParametersCallbackFunction  callback )

virtual

Implements rclcpp::node_interfaces::NodeParametersInterface.

---

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

• include/rclcpp/node_interfaces/node_parameters.hpp