rclcpp::parameter_client::SyncParametersClient Class Reference

#include <parameter_client.hpp>

Public Member Functions
	SyncParametersClient (rclcpp::node::Node::SharedPtr node, const rmw_qos_profile_t &qos_profile=rmw_qos_profile_parameters)
	SyncParametersClient (rclcpp::executor::Executor::SharedPtr executor, rclcpp::node::Node::SharedPtr node, const rmw_qos_profile_t &qos_profile=rmw_qos_profile_parameters)
std::vector< rclcpp::parameter::ParameterVariant >	get_parameters (const std::vector< std::string > &parameter_names)
bool	has_parameter (const std::string &parameter_name)
template<typename T >
T	get_parameter_impl (const std::string &parameter_name, std::function< T()> parameter_not_found_handler)
template<typename T >
T	get_parameter (const std::string &parameter_name, const T &default_value)
template<typename T >
T	get_parameter (const std::string &parameter_name)
std::vector< rclcpp::parameter::ParameterType >	get_parameter_types (const std::vector< std::string > &parameter_names)
std::vector< rcl_interfaces::msg::SetParametersResult >	set_parameters (const std::vector< rclcpp::parameter::ParameterVariant > &parameters)
rcl_interfaces::msg::SetParametersResult	set_parameters_atomically (const std::vector< rclcpp::parameter::ParameterVariant > &parameters)
rcl_interfaces::msg::ListParametersResult	list_parameters (const std::vector< std::string > &parameter_prefixes, uint64_t depth)
template<typename CallbackT >
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))

Constructor & Destructor Documentation

SyncParametersClient() [1/2]

rclcpp::parameter_client::SyncParametersClient::SyncParametersClient ( rclcpp::node::Node::SharedPtr  node, const rmw_qos_profile_t &  qos_profile = rmw_qos_profile_parameters  )

explicit

SyncParametersClient() [2/2]

rclcpp::parameter_client::SyncParametersClient::SyncParametersClient	(	rclcpp::executor::Executor::SharedPtr	executor,
		rclcpp::node::Node::SharedPtr	node,
		const rmw_qos_profile_t &	qos_profile = rmw_qos_profile_parameters
	)

Member Function Documentation

get_parameters()

std::vector<rclcpp::parameter::ParameterVariant> rclcpp::parameter_client::SyncParametersClient::get_parameters

(

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

parameter_names

)

has_parameter()

bool rclcpp::parameter_client::SyncParametersClient::has_parameter

(

const std::string &

parameter_name

)

get_parameter_impl()

template<typename T >

T rclcpp::parameter_client::SyncParametersClient::get_parameter_impl ( const std::string &  parameter_name, std::function< T()>  parameter_not_found_handler  )

inline

get_parameter() [1/2]

template<typename T >

T rclcpp::parameter_client::SyncParametersClient::get_parameter ( const std::string &  parameter_name, const T &  default_value  )

inline

get_parameter() [2/2]

template<typename T >

T rclcpp::parameter_client::SyncParametersClient::get_parameter ( const std::string &  parameter_name )

inline

get_parameter_types()

std::vector<rclcpp::parameter::ParameterType> rclcpp::parameter_client::SyncParametersClient::get_parameter_types

(

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

parameter_names

)

set_parameters()

std::vector<rcl_interfaces::msg::SetParametersResult> rclcpp::parameter_client::SyncParametersClient::set_parameters

(

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

parameters

)

set_parameters_atomically()

rcl_interfaces::msg::SetParametersResult rclcpp::parameter_client::SyncParametersClient::set_parameters_atomically

(

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

parameters

)

list_parameters()

rcl_interfaces::msg::ListParametersResult rclcpp::parameter_client::SyncParametersClient::list_parameters	(	const std::vector< std::string > &	parameter_prefixes,
		uint64_t	depth
	)

on_parameter_event()

template<typename CallbackT >

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

inline

service_is_ready()

bool rclcpp::parameter_client::SyncParametersClient::service_is_ready ( ) const

inline

wait_for_service()

template<typename RatioT = std::milli>

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

inline

---

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

• include/rclcpp/parameter_client.hpp