rclcpp
master
C++ ROS Client Library API
|
Implementation of the NodeParameters part of the Node API. More...
#include <node_parameters.hpp>
Public Types | |
using | CallbacksContainerType = std::list< OnSetParametersCallbackHandle::WeakPtr > |
Public Types inherited from rclcpp::node_interfaces::NodeParametersInterface | |
using | OnParametersSetCallbackType = OnSetParametersCallbackHandle::OnParametersSetCallbackType |
Public Member Functions | |
NodeParameters (const node_interfaces::NodeBaseInterface::SharedPtr node_base, const node_interfaces::NodeLoggingInterface::SharedPtr node_logging, 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 > ¶meter_overrides, bool start_parameter_services, bool start_parameter_event_publisher, const rclcpp::QoS ¶meter_event_qos, const rclcpp::PublisherOptionsBase ¶meter_event_publisher_options, bool allow_undeclared_parameters, bool automatically_declare_parameters_from_overrides) | |
virtual | ~NodeParameters () |
const rclcpp::ParameterValue & | declare_parameter (const std::string &name, const rclcpp::ParameterValue &default_value, const rcl_interfaces::msg::ParameterDescriptor ¶meter_descriptor, bool ignore_override) override |
Declare and initialize a parameter. More... | |
void | undeclare_parameter (const std::string &name) override |
Undeclare a parameter. More... | |
bool | has_parameter (const std::string &name) const override |
Return true if the parameter has been declared, otherwise false. More... | |
std::vector< rcl_interfaces::msg::SetParametersResult > | set_parameters (const std::vector< rclcpp::Parameter > ¶meters) override |
Set one or more parameters, one at a time. More... | |
rcl_interfaces::msg::SetParametersResult | set_parameters_atomically (const std::vector< rclcpp::Parameter > ¶meters) override |
Set and initialize a parameter, all at once. More... | |
std::vector< rclcpp::Parameter > | get_parameters (const std::vector< std::string > &names) const override |
Get descriptions of parameters given their names. More... | |
rclcpp::Parameter | get_parameter (const std::string &name) const override |
Get the description of one parameter given a name. More... | |
bool | get_parameter (const std::string &name, rclcpp::Parameter ¶meter) const override |
Get the description of one parameter given a name. More... | |
bool | get_parameters_by_prefix (const std::string &prefix, std::map< std::string, rclcpp::Parameter > ¶meters) const override |
Get all parameters that have the specified prefix into the parameters map. More... | |
std::vector< rcl_interfaces::msg::ParameterDescriptor > | describe_parameters (const std::vector< std::string > &names) const override |
std::vector< uint8_t > | get_parameter_types (const std::vector< std::string > &names) const override |
rcl_interfaces::msg::ListParametersResult | list_parameters (const std::vector< std::string > &prefixes, uint64_t depth) const override |
RCUTILS_WARN_UNUSED OnSetParametersCallbackHandle::SharedPtr | add_on_set_parameters_callback (OnParametersSetCallbackType callback) override |
Add a callback for when parameters are being set. More... | |
void | remove_on_set_parameters_callback (const OnSetParametersCallbackHandle *const handler) override |
Remove a callback registered with add_on_set_parameters_callback . More... | |
OnParametersSetCallbackType | set_on_parameters_set_callback (OnParametersSetCallbackType callback) override |
Register a callback for when parameters are being set, return an existing one. More... | |
const std::map< std::string, rclcpp::ParameterValue > & | get_parameter_overrides () const override |
Return the initial parameter values used by the NodeParameters to override default values. More... | |
Public Member Functions inherited from rclcpp::node_interfaces::NodeParametersInterface | |
virtual | ~NodeParametersInterface ()=default |
Implementation of the NodeParameters part of the Node API.
using rclcpp::node_interfaces::NodeParameters::CallbacksContainerType = std::list<OnSetParametersCallbackHandle::WeakPtr> |
rclcpp::node_interfaces::NodeParameters::NodeParameters | ( | const node_interfaces::NodeBaseInterface::SharedPtr | node_base, |
const node_interfaces::NodeLoggingInterface::SharedPtr | node_logging, | ||
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 > & | parameter_overrides, | ||
bool | start_parameter_services, | ||
bool | start_parameter_event_publisher, | ||
const rclcpp::QoS & | parameter_event_qos, | ||
const rclcpp::PublisherOptionsBase & | parameter_event_publisher_options, | ||
bool | allow_undeclared_parameters, | ||
bool | automatically_declare_parameters_from_overrides | ||
) |
|
virtual |
|
overridevirtual |
Declare and initialize a parameter.
Implements rclcpp::node_interfaces::NodeParametersInterface.
|
overridevirtual |
Undeclare a parameter.
Implements rclcpp::node_interfaces::NodeParametersInterface.
|
overridevirtual |
Return true if the parameter has been declared, otherwise false.
Implements rclcpp::node_interfaces::NodeParametersInterface.
|
overridevirtual |
Set one or more parameters, one at a time.
Implements rclcpp::node_interfaces::NodeParametersInterface.
|
overridevirtual |
Set and initialize a parameter, all at once.
Implements rclcpp::node_interfaces::NodeParametersInterface.
|
overridevirtual |
Get descriptions of parameters given their names.
Implements rclcpp::node_interfaces::NodeParametersInterface.
|
overridevirtual |
Get the description of one parameter given a name.
Implements rclcpp::node_interfaces::NodeParametersInterface.
|
overridevirtual |
Get the description of one parameter given a name.
Implements rclcpp::node_interfaces::NodeParametersInterface.
|
overridevirtual |
Get all parameters that have the specified prefix into the parameters map.
Implements rclcpp::node_interfaces::NodeParametersInterface.
|
overridevirtual |
Implements rclcpp::node_interfaces::NodeParametersInterface.
|
overridevirtual |
Implements rclcpp::node_interfaces::NodeParametersInterface.
|
overridevirtual |
Implements rclcpp::node_interfaces::NodeParametersInterface.
|
overridevirtual |
Add a callback for when parameters are being set.
Implements rclcpp::node_interfaces::NodeParametersInterface.
|
overridevirtual |
Remove a callback registered with add_on_set_parameters_callback
.
Implements rclcpp::node_interfaces::NodeParametersInterface.
|
overridevirtual |
Register a callback for when parameters are being set, return an existing one.
Implements rclcpp::node_interfaces::NodeParametersInterface.
|
overridevirtual |
Return the initial parameter values used by the NodeParameters to override default values.
Implements rclcpp::node_interfaces::NodeParametersInterface.