param.cpp File Reference

#include "ros/param.h"
#include "ros/master.h"
#include "ros/xmlrpc_manager.h"
#include "ros/this_node.h"
#include "ros/names.h"
#include <ros/console.h>
#include <boost/thread/recursive_mutex.hpp>
#include <boost/lexical_cast.hpp>
#include <vector>
#include <map>

Include dependency graph for param.cpp:

Go to the source code of this file.

Namespaces
	ros
	ros::param
	Contains functions which allow you to query the parameter server.

Typedefs
typedef std::map< std::string, XmlRpc::XmlRpcValue >	ros::param::M_Param

Functions
ROSCPP_DECL bool	ros::param::del (const std::string &key)
	Delete a parameter from the parameter server. More...
ROSCPP_DECL bool	ros::param::get (const std::string &key, std::string &s)
	Get a string value from the parameter server. More...
ROSCPP_DECL bool	ros::param::get (const std::string &key, double &d)
	Get a double value from the parameter server. More...
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). More...
ROSCPP_DECL bool	ros::param::get (const std::string &key, int &i)
	Get an integer value from the parameter server. More...
ROSCPP_DECL bool	ros::param::get (const std::string &key, bool &b)
	Get a boolean value from the parameter server. More...
ROSCPP_DECL bool	ros::param::get (const std::string &key, XmlRpc::XmlRpcValue &v)
	Get an arbitrary XML/RPC value from the parameter server. More...
ROSCPP_DECL bool	ros::param::get (const std::string &key, std::vector< std::string > &vec)
	Get a string vector value from the parameter server. More...
ROSCPP_DECL bool	ros::param::get (const std::string &key, std::vector< double > &vec)
	Get a double vector value from the parameter server. More...
ROSCPP_DECL bool	ros::param::get (const std::string &key, std::vector< float > &vec)
	Get a float vector value from the parameter server. More...
ROSCPP_DECL bool	ros::param::get (const std::string &key, std::vector< int > &vec)
	Get an int vector value from the parameter server. More...
ROSCPP_DECL bool	ros::param::get (const std::string &key, std::vector< bool > &vec)
	Get a bool vector value from the parameter server. More...
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. More...
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. More...
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. More...
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. More...
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. More...
ROSCPP_DECL bool	ros::param::getCached (const std::string &key, std::string &s)
	Get a string value from the parameter server, with local caching. More...
ROSCPP_DECL bool	ros::param::getCached (const std::string &key, double &d)
	Get a double value from the parameter server, with local caching. More...
ROSCPP_DECL bool	ros::param::getCached (const std::string &key, float &f)
	Get a float value from the parameter server, with local caching. More...
ROSCPP_DECL bool	ros::param::getCached (const std::string &key, int &i)
	Get an integer value from the parameter server, with local caching. More...
ROSCPP_DECL bool	ros::param::getCached (const std::string &key, bool &b)
	Get a boolean value from the parameter server, with local caching. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
bool	ros::param::getImpl (const std::string &key, XmlRpc::XmlRpcValue &v, bool use_cache)
bool	ros::param::getImpl (const std::string &key, std::string &s, bool use_cache)
bool	ros::param::getImpl (const std::string &key, double &d, bool use_cache)
bool	ros::param::getImpl (const std::string &key, float &f, bool use_cache)
bool	ros::param::getImpl (const std::string &key, int &i, bool use_cache)
bool	ros::param::getImpl (const std::string &key, bool &b, bool use_cache)
template<class T >
bool	ros::param::getImpl (const std::string &key, std::vector< T > &vec, bool cached)
template<class T >
bool	ros::param::getImpl (const std::string &key, std::map< std::string, T > &map, bool cached)
ROSCPP_DECL bool	ros::param::getParamNames (std::vector< std::string > &keys)
	Get the list of all the parameters in the server. More...
ROSCPP_DECL bool	ros::param::has (const std::string &key)
	Check whether a parameter exists on the parameter server. More...
void	ros::param::init (const M_string &remappings)
void	ros::param::invalidateParentParams (const std::string &key)
void	ros::param::paramUpdateCallback (XmlRpc::XmlRpcValue &params, XmlRpc::XmlRpcValue &result)
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. More...
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. More...
ROSCPP_DECL void	ros::param::set (const std::string &key, const XmlRpc::XmlRpcValue &v)
	Set an arbitrary XML/RPC value on the parameter server. More...
ROSCPP_DECL void	ros::param::set (const std::string &key, const std::string &s)
	Set a string value on the parameter server. More...
ROSCPP_DECL void	ros::param::set (const std::string &key, const char *s)
	Set a string value on the parameter server. More...
ROSCPP_DECL void	ros::param::set (const std::string &key, double d)
	Set a double value on the parameter server. More...
ROSCPP_DECL void	ros::param::set (const std::string &key, int i)
	Set an integer value on the parameter server. More...
ROSCPP_DECL void	ros::param::set (const std::string &key, bool b)
	Set a bool value on the parameter server. More...
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. More...
ROSCPP_DECL void	ros::param::set (const std::string &key, const std::vector< double > &vec)
	Set a double vector value on the parameter server. More...
ROSCPP_DECL void	ros::param::set (const std::string &key, const std::vector< float > &vec)
	Set a float vector value on the parameter server. More...
ROSCPP_DECL void	ros::param::set (const std::string &key, const std::vector< int > &vec)
	Set an integer vector value on the parameter server. More...
ROSCPP_DECL void	ros::param::set (const std::string &key, const std::vector< bool > &vec)
	Set a bool vector value on the parameter server. More...
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. More...
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. More...
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. More...
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. More...
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. More...
template<class T >
void	ros::param::setImpl (const std::string &key, const std::vector< T > &vec)
template<class T >
void	ros::param::setImpl (const std::string &key, const std::map< std::string, T > &map)
ROSCPP_DECL void	ros::param::unsubscribeCachedParam (const std::string &key)
	Unsubscribe cached parameter from the master. More...
ROSCPP_DECL void	ros::param::unsubscribeCachedParam (void)
	Unsubscribe all cached parameter from the master. More...
void	ros::param::update (const std::string &key, const XmlRpc::XmlRpcValue &v)
template<class T >
T	ros::param::xml_cast (XmlRpc::XmlRpcValue xml_value)
template<>
double	ros::param::xml_cast (XmlRpc::XmlRpcValue xml_value)
template<>
float	ros::param::xml_cast (XmlRpc::XmlRpcValue xml_value)
template<>
int	ros::param::xml_cast (XmlRpc::XmlRpcValue xml_value)
template<>
bool	ros::param::xml_cast (XmlRpc::XmlRpcValue xml_value)
template<class T >
bool	ros::param::xml_castable (int XmlType)
template<>
bool	ros::param::xml_castable< bool > (int XmlType)
template<>
bool	ros::param::xml_castable< double > (int XmlType)
template<>
bool	ros::param::xml_castable< float > (int XmlType)
template<>
bool	ros::param::xml_castable< int > (int XmlType)
template<>
bool	ros::param::xml_castable< std::string > (int XmlType)

Variables
M_Param	ros::param::g_params
boost::recursive_mutex	ros::param::g_params_mutex
S_string	ros::param::g_subscribed_params