rosparam_utils.h

Go to the documentation of this file.

// -*- mode: c++ -*-
/*********************************************************************
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2014, JSK Lab
 *  All rights reserved.
 *
 *  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/o2r other materials provided
 *     with the distribution.
 *   * Neither the name of the JSK Lab 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 JSK_TOPIC_TOOLS_ROSPARAM_UTILS_H_
#define JSK_TOPIC_TOOLS_ROSPARAM_UTILS_H_

#include <ros/ros.h>

namespace jsk_topic_tools
{
  // a function to read vector of double parameters
  // from ros parameter servers.
  bool readVectorParameter(
    ros::NodeHandle& nh,
    const std::string& param_name,
    std::vector<double>& result);

  // a function to read vector of vector of double
  // parameters. (nested)
  // from ros parameter servers.
  bool readVectorParameter(
    ros::NodeHandle& nh,
    const std::string& param_name,
    std::vector<std::vector<double> >& result);
  
  // a function to read vector of string parameters
  // from ros parameter servers.
  bool readVectorParameter(
    ros::NodeHandle& nh,
    const std::string& param_name,
    std::vector<std::string>& result);
  
  // a function to read vector of vector of string
  // parameters. (nested)
  // from ros parameter servers.
  bool readVectorParameter(
    ros::NodeHandle& nh,
    const std::string& param_name,
    std::vector<std::vector<std::string> >& result);
  
  // a function to convert from XmlRpc type to double
  double getXMLDoubleValue(XmlRpc::XmlRpcValue val);
}

#endif