param.h File Reference

#include "forwards.h"
#include "common.h"
#include "XmlRpcValue.h"
#include <vector>
#include <map>

Include dependency graph for param.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	ros
namespace	ros::param
	Contains functions which allow you to query the parameter server.
Functions
ROSCPP_DECL bool	ros::param::del (const std::string &key)
	Delete a parameter from the parameter server.
ROSCPP_DECL bool	ros::param::get (const std::string &key, std::string &s)
	Get a string value from the parameter server.
ROSCPP_DECL bool	ros::param::get (const std::string &key, double &d)
	Get a double value from the parameter server.
ROSCPP_DECL bool	ros::param::get (const std::string &key, float &f)
	Get a float value from the parameter server (internally using the double value).
ROSCPP_DECL bool	ros::param::get (const std::string &key, int &i)
	Get an integer value from the parameter server.
ROSCPP_DECL bool	ros::param::get (const std::string &key, bool &b)
	Get a boolean value from the parameter server.
ROSCPP_DECL bool	ros::param::get (const std::string &key, XmlRpc::XmlRpcValue &v)
	Get an arbitrary XML/RPC value from the parameter server.
ROSCPP_DECL bool	ros::param::get (const std::string &key, std::vector< std::string > &vec)
	Get a string vector value from the parameter server.
ROSCPP_DECL bool	ros::param::get (const std::string &key, std::vector< double > &vec)
	Get a double vector value from the parameter server.
ROSCPP_DECL bool	ros::param::get (const std::string &key, std::vector< float > &vec)
	Get a float vector value from the parameter server.
ROSCPP_DECL bool	ros::param::get (const std::string &key, std::vector< int > &vec)
	Get an int vector value from the parameter server.
ROSCPP_DECL bool	ros::param::get (const std::string &key, std::vector< bool > &vec)
	Get a bool vector value from the parameter server.
ROSCPP_DECL bool	ros::param::get (const std::string &key, std::map< std::string, std::string > &map)
	Get a string->string map value from the parameter server.
ROSCPP_DECL bool	ros::param::get (const std::string &key, std::map< std::string, double > &map)
	Get a string->double map value from the parameter server.
ROSCPP_DECL bool	ros::param::get (const std::string &key, std::map< std::string, float > &map)
	Get a string->float map value from the parameter server.
ROSCPP_DECL bool	ros::param::get (const std::string &key, std::map< std::string, int > &map)
	Get a string->int map value from the parameter server.
ROSCPP_DECL bool	ros::param::get (const std::string &key, std::map< std::string, bool > &map)
	Get a string->bool map value from the parameter server.
ROSCPP_DECL bool	ros::param::getCached (const std::string &key, std::string &s)
	Get a string value from the parameter server, with local caching.
ROSCPP_DECL bool	ros::param::getCached (const std::string &key, double &d)
	Get a double value from the parameter server, with local caching.
ROSCPP_DECL bool	ros::param::getCached (const std::string &key, int &i)
	Get an integer value from the parameter server, with local caching.
ROSCPP_DECL bool	ros::param::getCached (const std::string &key, bool &b)
	Get a boolean value from the parameter server, with local caching.
ROSCPP_DECL bool	ros::param::getCached (const std::string &key, XmlRpc::XmlRpcValue &v)
	Get an arbitrary XML/RPC value from the parameter server, with local caching.
ROSCPP_DECL bool	ros::param::getCached (const std::string &key, std::vector< std::string > &vec)
	Get a string vector value from the parameter server, with local caching.
ROSCPP_DECL bool	ros::param::getCached (const std::string &key, std::vector< double > &vec)
	Get a double vector value from the parameter server, with local caching.
ROSCPP_DECL bool	ros::param::getCached (const std::string &key, std::vector< float > &vec)
	Get a float vector value from the parameter server, with local caching.
ROSCPP_DECL bool	ros::param::getCached (const std::string &key, std::vector< int > &vec)
	Get an int vector value from the parameter server, with local caching.
ROSCPP_DECL bool	ros::param::getCached (const std::string &key, std::vector< bool > &vec)
	Get a bool vector value from the parameter server, with local caching.
ROSCPP_DECL bool	ros::param::getCached (const std::string &key, std::map< std::string, std::string > &map)
	Get a string->string map value from the parameter server, with local caching.
ROSCPP_DECL bool	ros::param::getCached (const std::string &key, std::map< std::string, double > &map)
	Get a string->double map value from the parameter server, with local caching.
ROSCPP_DECL bool	ros::param::getCached (const std::string &key, std::map< std::string, float > &map)
	Get a string->float map value from the parameter server, with local caching.
ROSCPP_DECL bool	ros::param::getCached (const std::string &key, std::map< std::string, int > &map)
	Get a string->int map value from the parameter server, with local caching.
ROSCPP_DECL bool	ros::param::getCached (const std::string &key, std::map< std::string, bool > &map)
	Get a string->bool map value from the parameter server, with local caching.
ROSCPP_DECL bool	ros::param::has (const std::string &key)
	Check whether a parameter exists on the parameter server.
template<typename T >
void	ros::param::param (const std::string &param_name, T &param_val, const T &default_val)
	Assign value from parameter server, with default.
ROSCPP_DECL bool	ros::param::search (const std::string &ns, const std::string &key, std::string &result)
	Search up the tree for a parameter with a given key.
ROSCPP_DECL bool	ros::param::search (const std::string &key, std::string &result)
	Search up the tree for a parameter with a given key. This version defaults to starting in the current node's name.
ROSCPP_DECL void	ros::param::set (const std::string &key, const XmlRpc::XmlRpcValue &v)
	Set an arbitrary XML/RPC value on the parameter server.
ROSCPP_DECL void	ros::param::set (const std::string &key, const std::string &s)
	Set a string value on the parameter server.
ROSCPP_DECL void	ros::param::set (const std::string &key, const char *s)
	Set a string value on the parameter server.
ROSCPP_DECL void	ros::param::set (const std::string &key, double d)
	Set a double value on the parameter server.
ROSCPP_DECL void	ros::param::set (const std::string &key, int i)
	Set an integer value on the parameter server.
ROSCPP_DECL void	ros::param::set (const std::string &key, bool b)
	Set a bool value on the parameter server.
ROSCPP_DECL void	ros::param::set (const std::string &key, const std::vector< std::string > &vec)
	Set a string vector value on the parameter server.
ROSCPP_DECL void	ros::param::set (const std::string &key, const std::vector< double > &vec)
	Set a double vector value on the parameter server.
ROSCPP_DECL void	ros::param::set (const std::string &key, const std::vector< float > &vec)
	Set a float vector value on the parameter server.
ROSCPP_DECL void	ros::param::set (const std::string &key, const std::vector< int > &vec)
	Set an integer vector value on the parameter server.
ROSCPP_DECL void	ros::param::set (const std::string &key, const std::vector< bool > &vec)
	Set a bool vector value on the parameter server.
ROSCPP_DECL void	ros::param::set (const std::string &key, const std::map< std::string, std::string > &map)
	Set a string->string map value on the parameter server.
ROSCPP_DECL void	ros::param::set (const std::string &key, const std::map< std::string, double > &map)
	Set a string->double map value on the parameter server.
ROSCPP_DECL void	ros::param::set (const std::string &key, const std::map< std::string, float > &map)
	Set a string->float map value on the parameter server.
ROSCPP_DECL void	ros::param::set (const std::string &key, const std::map< std::string, int > &map)
	Set a string->int map value on the parameter server.
ROSCPP_DECL void	ros::param::set (const std::string &key, const std::map< std::string, bool > &map)
	Set a string->bool map value on the parameter server.