param.h

Go to the documentation of this file.

/*
 * Copyright (C) 2009, Willow Garage, Inc.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *   * Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   * Neither the names of Willow Garage, Inc. nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ROSCPP_PARAM_H
#define ROSCPP_PARAM_H

#include "forwards.h"
#include "common.h"
#include "xmlrpcpp/XmlRpcValue.h"

#include <vector>
#include <map>

namespace ros
{

namespace param
{

ROSCPP_DECL void set(const std::string& key, const XmlRpc::XmlRpcValue& v);
ROSCPP_DECL void set(const std::string& key, const std::string& s);
ROSCPP_DECL void set(const std::string& key, const char* s);
ROSCPP_DECL void set(const std::string& key, double d);
ROSCPP_DECL void set(const std::string& key, int i);
ROSCPP_DECL void set(const std::string& key, bool b);


ROSCPP_DECL void set(const std::string& key, const std::vector<std::string>& vec);
ROSCPP_DECL void set(const std::string& key, const std::vector<double>& vec);
ROSCPP_DECL void set(const std::string& key, const std::vector<float>& vec);
ROSCPP_DECL void set(const std::string& key, const std::vector<int>& vec);
ROSCPP_DECL void set(const std::string& key, const std::vector<bool>& vec);

ROSCPP_DECL void set(const std::string& key, const std::map<std::string, std::string>& map);
ROSCPP_DECL void set(const std::string& key, const std::map<std::string, double>& map);
ROSCPP_DECL void set(const std::string& key, const std::map<std::string, float>& map);
ROSCPP_DECL void set(const std::string& key, const std::map<std::string, int>& map);
ROSCPP_DECL void set(const std::string& key, const std::map<std::string, bool>& map);


ROSCPP_DECL bool get(const std::string& key, std::string& s);
ROSCPP_DECL bool get(const std::string& key, double& d);
ROSCPP_DECL bool get(const std::string& key, float& f);
ROSCPP_DECL bool get(const std::string& key, int& i);
ROSCPP_DECL bool get(const std::string& key, bool& b);
ROSCPP_DECL bool get(const std::string& key, XmlRpc::XmlRpcValue& v);

ROSCPP_DECL bool getCached(const std::string& key, std::string& s);
ROSCPP_DECL bool getCached(const std::string& key, double& d);
ROSCPP_DECL bool getCached(const std::string& key, float& f);
ROSCPP_DECL bool getCached(const std::string& key, int& i);
ROSCPP_DECL bool getCached(const std::string& key, bool& b);
ROSCPP_DECL bool getCached(const std::string& key, XmlRpc::XmlRpcValue& v);

ROSCPP_DECL bool get(const std::string& key, std::vector<std::string>& vec);
ROSCPP_DECL bool get(const std::string& key, std::vector<double>& vec);
ROSCPP_DECL bool get(const std::string& key, std::vector<float>& vec);
ROSCPP_DECL bool get(const std::string& key, std::vector<int>& vec);
ROSCPP_DECL bool get(const std::string& key, std::vector<bool>& vec);

ROSCPP_DECL bool getCached(const std::string& key, std::vector<std::string>& vec);
ROSCPP_DECL bool getCached(const std::string& key, std::vector<double>& vec);
ROSCPP_DECL bool getCached(const std::string& key, std::vector<float>& vec);
ROSCPP_DECL bool getCached(const std::string& key, std::vector<int>& vec);
ROSCPP_DECL bool getCached(const std::string& key, std::vector<bool>& vec);

ROSCPP_DECL bool get(const std::string& key, std::map<std::string, std::string>& map);
ROSCPP_DECL bool get(const std::string& key, std::map<std::string, double>& map);
ROSCPP_DECL bool get(const std::string& key, std::map<std::string, float>& map);
ROSCPP_DECL bool get(const std::string& key, std::map<std::string, int>& map);
ROSCPP_DECL bool get(const std::string& key, std::map<std::string, bool>& map);

ROSCPP_DECL bool getCached(const std::string& key, std::map<std::string, std::string>& map);
ROSCPP_DECL bool getCached(const std::string& key, std::map<std::string, double>& map);
ROSCPP_DECL bool getCached(const std::string& key, std::map<std::string, float>& map);
ROSCPP_DECL bool getCached(const std::string& key, std::map<std::string, int>& map);
ROSCPP_DECL bool getCached(const std::string& key, std::map<std::string, bool>& map);

ROSCPP_DECL bool has(const std::string& key);
ROSCPP_DECL bool del(const std::string& key);

ROSCPP_DECL bool search(const std::string& ns, const std::string& key, std::string& result);

ROSCPP_DECL bool search(const std::string& key, std::string& result);

ROSCPP_DECL bool getParamNames(std::vector<std::string>& keys);

ROSCPP_DECL void unsubscribeCachedParam(const std::string& key);

ROSCPP_DECL void unsubscribeCachedParam(void);

template<typename T>
bool param(const std::string& param_name, T& param_val, const T& default_val)
{
  if (has(param_name))
  {
    if (get(param_name, param_val))
    {
      return true;
    }
  }

  param_val = default_val;
  return false;
}

template<typename T>
T param(const std::string& param_name, const T& default_val)
{
  T param_val;
  param(param_name, param_val, default_val);
  return param_val;
}

} // namespace param

} // namespace ros

#endif // ROSCPP_PARAM_H