yaml_config_writer.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_WRITER_H
30 #define YAML_CONFIG_WRITER_H
31 
32 #include <ostream>
33 
34 #include <rviz/config.h>
35 
36 namespace YAML
37 {
38 class Emitter;
39 }
40 
41 namespace rviz
42 {
44 {
45 public:
48 
51  void writeFile(const Config& config, const QString& filename);
52 
56  QString writeString(const Config& config, const QString& filename = "data string");
57 
60  void writeStream(const Config& config, std::ostream& out, const QString& filename = "data stream");
61 
63  bool error();
64 
67  QString errorMessage();
68 
69 private:
70  void writeConfigNode(const Config& config, YAML::Emitter& emitter);
71 
72  QString message_;
73  bool error_;
74 };
75 
76 } // end namespace rviz
77 
78 #endif // YAML_CONFIG_WRITER_H
rviz::YamlConfigWriter::YamlConfigWriter
YamlConfigWriter()
Constructor. Writer starts in a non-error state.
Definition: yaml_config_writer.cpp:39
rviz::YamlConfigWriter::error_
bool error_
Definition: yaml_config_writer.h:73
YAML
Definition: yaml_config_reader.h:36
rviz::YamlConfigWriter::writeStream
void writeStream(const Config &config, std::ostream &out, const QString &filename="data stream")
Write config data to a std::ostream. This potentially changes the return values of error() and status...
Definition: yaml_config_writer.cpp:86
rviz::YamlConfigWriter::errorMessage
QString errorMessage()
Return an error message if the latest write call had an error, or the empty string if there was no er...
Definition: yaml_config_writer.cpp:104
rviz
Definition: add_display_dialog.cpp:54
rviz::YamlConfigWriter
Definition: yaml_config_writer.h:43
rviz::YamlConfigWriter::error
bool error()
Return true if the latest write operation had an error.
Definition: yaml_config_writer.cpp:99
rviz::YamlConfigWriter::writeConfigNode
void writeConfigNode(const Config &config, YAML::Emitter &emitter)
Definition: yaml_config_writer.cpp:109
rviz::YamlConfigWriter::writeString
QString writeString(const Config &config, const QString &filename="data string")
Write config data to a string, and return it. This potentially changes the return values of error() a...
Definition: yaml_config_writer.cpp:70
rviz::YamlConfigWriter::message_
QString message_
Definition: yaml_config_writer.h:72
config.h
rviz::YamlConfigWriter::writeFile
void writeFile(const Config &config, const QString &filename)
Write config data to a file. This potentially changes the return values of error() and statusMessage(...
Definition: yaml_config_writer.cpp:45
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 Fri Dec 13 2024 03:31:03