yaml_config_reader.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012, Willow Garage, Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
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 the Willow Garage, Inc. nor the names of its
14  * contributors may be used to endorse or promote products derived from
15  * 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 THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29 #ifndef YAML_CONFIG_READER_H
30 #define YAML_CONFIG_READER_H
31 
32 #include <istream>
33 
34 #include <rviz/config.h>
35 
36 namespace YAML
37 {
38 class Node;
39 }
40 
41 namespace rviz
42 {
44 {
45 public:
48 
51  void readFile(Config& config, const QString& filename);
52 
55  void readString(Config& config, const QString& data, const QString& filename = "data string");
56 
59  void readStream(Config& config, std::istream& in, const QString& filename = "data stream");
60 
62  bool error();
63 
66  QString errorMessage();
67 
68 private:
69  void readYamlNode(Config& config, const YAML::Node& yaml_node);
70 
71  QString message_;
72  bool error_;
73 };
74 
75 } // end namespace rviz
76 
77 #endif // YAML_CONFIG_READER_H
rviz::YamlConfigReader::error
bool error()
Return true if the latest readFile() or readString() call had an error.
Definition: yaml_config_reader.cpp:108
rviz::YamlConfigReader::error_
bool error_
Definition: yaml_config_reader.h:72
rviz::YamlConfigReader::readString
void readString(Config &config, const QString &data, const QString &filename="data string")
Read config data from a string. This potentially changes the return value sof error(),...
Definition: yaml_config_reader.cpp:48
rviz::YamlConfigReader::errorMessage
QString errorMessage()
Return an error message if the latest read call had an error, or the empty string if not.
Definition: yaml_config_reader.cpp:113
YAML
Definition: yaml_config_reader.h:36
rviz::YamlConfigReader::readStream
void readStream(Config &config, std::istream &in, const QString &filename="data stream")
Read config data from a std::istream. This potentially changes the return value sof error(),...
Definition: yaml_config_reader.cpp:54
rviz
Definition: add_display_dialog.cpp:54
rviz::YamlConfigReader::readFile
void readFile(Config &config, const QString &filename)
Read config data from a file. This potentially changes the return value sof error(),...
Definition: yaml_config_reader.cpp:42
rviz::YamlConfigReader
Definition: yaml_config_reader.h:43
rviz::YamlConfigReader::YamlConfigReader
YamlConfigReader()
Constructor. Object begins in a no-error state.
Definition: yaml_config_reader.cpp:38
rviz::YamlConfigReader::readYamlNode
void readYamlNode(Config &config, const YAML::Node &yaml_node)
Definition: yaml_config_reader.cpp:71
config.h
rviz::YamlConfigReader::message_
QString message_
Definition: yaml_config_reader.h:71
config
config
rviz::Config
Configuration data storage class.
Definition: config.h:124


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust, William Woodall
autogenerated on Sat Jun 1 2024 02:31:53