rosparam_shortcuts.h
Go to the documentation of this file.
1 /*********************************************************************
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2015, University of Colorado, Boulder
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above
14  * copyright notice, this list of conditions and the following
15  * disclaimer in the documentation and/or other materials provided
16  * with the distribution.
17  * * Neither the name of the Univ of CO, Boulder nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *********************************************************************/
34 
35 /* Author: Dave Coleman <dave@dav.ee>
36  Desc: Helpers for loading parameters from the parameter server
37 */
38 
39 #ifndef ROSPARAM_SHORTCUTS_ROSPARAM_SHORTCUTS_H
40 #define ROSPARAM_SHORTCUTS_ROSPARAM_SHORTCUTS_H
41 
42 // C++
43 #include <string>
44 #include <vector>
45 #include <map>
46 
47 // ROS
48 #include <ros/ros.h>
49 
50 // Eigen
51 #include <Eigen/Geometry>
52 
53 // this package
55 
57 {
58 // -------------------------------------------------------------------------------------------------
59 // Helper Functions
60 // -------------------------------------------------------------------------------------------------
61 
71 bool get(const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, bool &value);
72 
73 bool get(const std::string &parent_name, const ros::NodeHandle &nh, const std::string &params_name,
74  std::map<std::string, bool> &parameters);
75 
76 bool get(const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, double &value);
77 
78 bool get(const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name,
79  std::vector<double> &values);
80 
81 bool get(const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, int &value);
82 
83 bool get(const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, std::size_t &value);
84 
85 bool get(const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, std::string &value);
86 
87 bool get(const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name,
88  std::vector<std::string> &values);
89 
90 bool get(const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name,
91  ros::Duration &value);
92 
93 bool get(const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name,
94  Eigen::Affine3d &value);
95 
101 std::string getDebugArrayString(std::vector<double> values);
102 
103 std::string getDebugArrayString(std::vector<std::string> values);
104 
109 bool convertDoublesToEigen(const std::string &parent_name, std::vector<double> values, Eigen::Affine3d &transform);
110 
115 void shutdownIfError(const std::string &parent_name, std::size_t error_count);
116 
117 } // namespace rosparam_shortcuts
118 
119 #endif // ROSPARAM_SHORTCUTS_ROSPARAM_SHORTCUTS_H
bool convertDoublesToEigen(const std::string &parent_name, std::vector< double > values, Eigen::Affine3d &transform)
Convert from 6 doubles of [x,y,z] [r,p,y] or 7 doubles of [x, y, z, qw, qx, qy, qz] to a transform...
void shutdownIfError(const std::string &parent_name, std::size_t error_count)
Check that there were no errors, and if there were, shutdown.
std::string getDebugArrayString(std::vector< double > values)
Output a string of values from an array for debugging.


rosparam_shortcuts
Author(s): Dave Coleman
autogenerated on Mon Jun 10 2019 14:48:25