rclcpp  master
C++ ROS Client Library API
Public Types | Public Member Functions | List of all members
rclcpp::node_interfaces::NodeParametersInterface Class Referenceabstract

Pure virtual interface class for the NodeParameters part of the Node API. More...

#include <node_parameters_interface.hpp>

Inheritance diagram for rclcpp::node_interfaces::NodeParametersInterface:
rclcpp::node_interfaces::NodeParameters

Public Types

using ParametersCallbackFunction = std::function< rcl_interfaces::msg::SetParametersResult(const std::vector< rclcpp::Parameter > &)>
 

Public Member Functions

virtual std::vector< rcl_interfaces::msg::SetParametersResult > set_parameters (const std::vector< rclcpp::Parameter > &parameters)=0
 
virtual rcl_interfaces::msg::SetParametersResult set_parameters_atomically (const std::vector< rclcpp::Parameter > &parameters)=0
 
virtual std::vector< rclcpp::Parameterget_parameters (const std::vector< std::string > &names) const =0
 Get descriptions of parameters given their names. More...
 
virtual rclcpp::Parameter get_parameter (const std::string &name) const =0
 Get the description of one parameter given a name. More...
 
virtual bool get_parameter (const std::string &name, rclcpp::Parameter &parameter) const =0
 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 =0
 
virtual std::vector< uint8_t > get_parameter_types (const std::vector< std::string > &names) const =0
 
virtual rcl_interfaces::msg::ListParametersResult list_parameters (const std::vector< std::string > &prefixes, uint64_t depth) const =0
 
virtual void register_param_change_callback (ParametersCallbackFunction callback)=0
 

Detailed Description

Pure virtual interface class for the NodeParameters part of the Node API.

Member Typedef Documentation

◆ ParametersCallbackFunction

Member Function Documentation

◆ set_parameters()

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

◆ set_parameters_atomically()

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

◆ get_parameters()

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

Get descriptions of parameters given their names.

Implemented in rclcpp::node_interfaces::NodeParameters.

◆ get_parameter() [1/2]

virtual rclcpp::Parameter rclcpp::node_interfaces::NodeParametersInterface::get_parameter ( const std::string name) const
pure virtual

Get the description of one parameter given a name.

Implemented in rclcpp::node_interfaces::NodeParameters.

◆ get_parameter() [2/2]

virtual bool rclcpp::node_interfaces::NodeParametersInterface::get_parameter ( const std::string name,
rclcpp::Parameter parameter 
) const
pure virtual

Get the description of one parameter given a name.

Implemented in rclcpp::node_interfaces::NodeParameters.

◆ describe_parameters()

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

◆ get_parameter_types()

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

◆ list_parameters()

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

◆ register_param_change_callback()

virtual void rclcpp::node_interfaces::NodeParametersInterface::register_param_change_callback ( ParametersCallbackFunction  callback)
pure virtual

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