yaml_util.h
Go to the documentation of this file.
1 // *****************************************************************************
2 //
3 // Copyright (c) 2014, Southwest Research Institute® (SwRI®)
4 // All rights reserved.
5 //
6 // Redistribution and use in source and binary forms, with or without
7 // modification, are permitted provided that the following conditions are met:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of Southwest Research Institute® (SwRI®) nor the
14 // names of its contributors may be used to endorse or promote products
15 // derived from this software without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 // ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
21 // DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 // (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 // LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 // ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 //
28 // *****************************************************************************
29 
30 #ifndef YAML_UTIL_YAML_UTIL_H_
31 #define YAML_UTIL_YAML_UTIL_H_
32 
33 #include <stdint.h>
34 #include <memory>
35 #include <ros/common.h>
36 
37 #include <yaml-cpp/yaml.h>
38 
39 #include <swri_yaml_util/version.h>
40 
41 #ifndef YAMLCPP_OLD_API
42 namespace YAML
43 {
44  void operator >> (const YAML::Node& node, float& value);
45  void operator >> (const YAML::Node& node, double& value);
46  void operator >> (const YAML::Node& node, bool& value);
47  void operator >> (const YAML::Node& node, int16_t& value);
48  void operator >> (const YAML::Node& node, uint16_t& value);
49  void operator >> (const YAML::Node& node, int32_t& value);
50  void operator >> (const YAML::Node& node, uint32_t& value);
51  void operator >> (const YAML::Node& node, int64_t& value);
52  void operator >> (const YAML::Node& node, uint64_t& value);
53  void operator >> (const YAML::Node& node, std::string& value);
54 }
55 #endif // YAMLCPP_OLD_API
56 
57 namespace swri_yaml_util
58 {
59  typedef std::unique_ptr<YAML::Node> YamlNodePtr;
60 
61  bool LoadFile(const std::string& path, YAML::Node& yaml);
62  bool LoadString(const std::string& input, YAML::Node& yaml);
63  bool LoadMap(const std::map<std::string, std::string>& dict, YAML::Node& yaml);
64  bool FindValue(const YAML::Node& node, const std::string& name);
65 
66  YamlNodePtr Clone(const YAML::Node& node);
67 
68  std::string ToString(double value, int32_t precision);
69 }
70 
71 #endif // YAML_UTIL_YAML_UTIL_H_
YAML::operator>>
void operator>>(const YAML::Node &node, float &value)
Definition: yaml_util.cpp:43
swri_yaml_util::FindValue
bool FindValue(const YAML::Node &node, const std::string &name)
Definition: yaml_util.cpp:169
swri_yaml_util::LoadFile
bool LoadFile(const std::string &path, YAML::Node &yaml)
Definition: yaml_util.cpp:97
swri_yaml_util::YamlNodePtr
std::unique_ptr< YAML::Node > YamlNodePtr
Definition: yaml_util.h:59
swri_yaml_util
Definition: yaml_util.h:57
YAML
Definition: yaml_util.h:42
swri_yaml_util::ToString
std::string ToString(double value, int32_t precision)
Definition: yaml_util.cpp:187
swri_yaml_util::Clone
YamlNodePtr Clone(const YAML::Node &node)
Definition: yaml_util.cpp:178
swri_yaml_util::LoadMap
bool LoadMap(const std::map< std::string, std::string > &dict, YAML::Node &yaml)
Definition: yaml_util.cpp:142
swri_yaml_util::LoadString
bool LoadString(const std::string &input, YAML::Node &yaml)
Definition: yaml_util.cpp:122


swri_yaml_util
Author(s): Marc Alban
autogenerated on Fri Aug 2 2024 08:39:24