rclcpp::parameter_client::AsyncParametersClient Class Reference

#include <parameter_client.hpp>

Public Member Functions
	AsyncParametersClient (const rclcpp::node_interfaces::NodeBaseInterface::SharedPtr node_base_interface, const rclcpp::node_interfaces::NodeTopicsInterface::SharedPtr node_topics_interface, const rclcpp::node_interfaces::NodeGraphInterface::SharedPtr node_graph_interface, const rclcpp::node_interfaces::NodeServicesInterface::SharedPtr node_services_interface, const std::string &remote_node_name="", const rmw_qos_profile_t &qos_profile=rmw_qos_profile_parameters)
	AsyncParametersClient (const rclcpp::node::Node::SharedPtr node, const std::string &remote_node_name="", const rmw_qos_profile_t &qos_profile=rmw_qos_profile_parameters)
std::shared_future< std::vector< rclcpp::parameter::ParameterVariant > >	get_parameters (const std::vector< std::string > &names, std::function< void(std::shared_future< std::vector< rclcpp::parameter::ParameterVariant >>) > callback=nullptr)
std::shared_future< std::vector< rclcpp::parameter::ParameterType > >	get_parameter_types (const std::vector< std::string > &names, std::function< void(std::shared_future< std::vector< rclcpp::parameter::ParameterType >>) > callback=nullptr)
std::shared_future< std::vector< rcl_interfaces::msg::SetParametersResult > >	set_parameters (const std::vector< rclcpp::parameter::ParameterVariant > &parameters, std::function< void(std::shared_future< std::vector< rcl_interfaces::msg::SetParametersResult >>) > callback=nullptr)
std::shared_future< rcl_interfaces::msg::SetParametersResult >	set_parameters_atomically (const std::vector< rclcpp::parameter::ParameterVariant > &parameters, std::function< void(std::shared_future< rcl_interfaces::msg::SetParametersResult >) > callback=nullptr)
std::shared_future< rcl_interfaces::msg::ListParametersResult >	list_parameters (const std::vector< std::string > &prefixes, uint64_t depth, std::function< void(std::shared_future< rcl_interfaces::msg::ListParametersResult >) > callback=nullptr)
template<typename CallbackT , typename Alloc = std::allocator<void>, typename SubscriptionT = rclcpp::subscription::Subscription<rcl_interfaces::msg::ParameterEvent, Alloc>>
rclcpp::subscription::Subscription< rcl_interfaces::msg::ParameterEvent >::SharedPtr	on_parameter_event (CallbackT &&callback)
bool	service_is_ready () const
template<typename RatioT = std::milli>
bool	wait_for_service (std::chrono::duration< int64_t, RatioT > timeout=std::chrono::duration< int64_t, RatioT >(-1))

Protected Member Functions
bool	wait_for_service_nanoseconds (std::chrono::nanoseconds timeout)

Constructor & Destructor Documentation

AsyncParametersClient() [1/2]

rclcpp::parameter_client::AsyncParametersClient::AsyncParametersClient	(	const rclcpp::node_interfaces::NodeBaseInterface::SharedPtr	node_base_interface,
		const rclcpp::node_interfaces::NodeTopicsInterface::SharedPtr	node_topics_interface,
		const rclcpp::node_interfaces::NodeGraphInterface::SharedPtr	node_graph_interface,
		const rclcpp::node_interfaces::NodeServicesInterface::SharedPtr	node_services_interface,
		const std::string &	remote_node_name = "",
		const rmw_qos_profile_t &	qos_profile = rmw_qos_profile_parameters
	)

AsyncParametersClient() [2/2]

rclcpp::parameter_client::AsyncParametersClient::AsyncParametersClient	(	const rclcpp::node::Node::SharedPtr	node,
		const std::string &	remote_node_name = "",
		const rmw_qos_profile_t &	qos_profile = rmw_qos_profile_parameters
	)

Member Function Documentation

get_parameters()

std::shared_future<std::vector<rclcpp::parameter::ParameterVariant> > rclcpp::parameter_client::AsyncParametersClient::get_parameters

(

const std::vector< std::string > &

names

)

get_parameter_types()

std::shared_future<std::vector<rclcpp::parameter::ParameterType> > rclcpp::parameter_client::AsyncParametersClient::get_parameter_types

(

const std::vector< std::string > &

names

)

set_parameters()

std::shared_future<std::vector<rcl_interfaces::msg::SetParametersResult> > rclcpp::parameter_client::AsyncParametersClient::set_parameters

(

const std::vector< rclcpp::parameter::ParameterVariant > &

parameters

)

set_parameters_atomically()

std::shared_future<rcl_interfaces::msg::SetParametersResult> rclcpp::parameter_client::AsyncParametersClient::set_parameters_atomically	(	const std::vector< rclcpp::parameter::ParameterVariant > &	parameters,
		std::function< void(std::shared_future< rcl_interfaces::msg::SetParametersResult >) >	callback = nullptr
	)

list_parameters()

std::shared_future<rcl_interfaces::msg::ListParametersResult> rclcpp::parameter_client::AsyncParametersClient::list_parameters	(	const std::vector< std::string > &	prefixes,
		uint64_t	depth,
		std::function< void(std::shared_future< rcl_interfaces::msg::ListParametersResult >) >	callback = nullptr
	)

on_parameter_event()

template<typename CallbackT , typename Alloc = std::allocator<void>, typename SubscriptionT = rclcpp::subscription::Subscription<rcl_interfaces::msg::ParameterEvent, Alloc>>

rclcpp::subscription::Subscription<rcl_interfaces::msg::ParameterEvent>::SharedPtr rclcpp::parameter_client::AsyncParametersClient::on_parameter_event ( CallbackT &&  callback )

inline

service_is_ready()

bool rclcpp::parameter_client::AsyncParametersClient::service_is_ready

(

)

const

wait_for_service()

template<typename RatioT = std::milli>

bool rclcpp::parameter_client::AsyncParametersClient::wait_for_service ( std::chrono::duration< int64_t, RatioT >  timeout = std::chrono::duration<int64_t, RatioT>(-1) )

inline

wait_for_service_nanoseconds()

bool rclcpp::parameter_client::AsyncParametersClient::wait_for_service_nanoseconds ( std::chrono::nanoseconds  timeout )

protected

---

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

• include/rclcpp/parameter_client.hpp