Public Member Functions | Private Member Functions | Private Attributes
rviz::YamlConfigWriter Class Reference

#include <yaml_config_writer.h>

List of all members.

Public Member Functions

bool error ()
 Return true if the latest write operation had an error.
QString errorMessage ()
 Return an error message if the latest write call had an error, or the empty string if there was no error.
void writeFile (const Config &config, const QString &filename)
 Write config data to a file. This potentially changes the return values of error() and statusMessage().
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 statusMessage().
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() and statusMessage().
 YamlConfigWriter ()
 Constructor. Writer starts in a non-error state.

Private Member Functions

void writeConfigNode (const Config &config, YAML::Emitter &emitter)

Private Attributes

bool error_
QString message_

Detailed Description

Definition at line 44 of file yaml_config_writer.h.


Constructor & Destructor Documentation

Constructor. Writer starts in a non-error state.

Constructor. Writer starts in a non-error state with no status message.

Definition at line 40 of file yaml_config_writer.cpp.


Member Function Documentation

Return true if the latest write operation had an error.

Definition at line 100 of file yaml_config_writer.cpp.

Return an error message if the latest write call had an error, or the empty string if there was no error.

Definition at line 105 of file yaml_config_writer.cpp.

void rviz::YamlConfigWriter::writeConfigNode ( const Config config,
YAML::Emitter &  emitter 
) [private]

Definition at line 110 of file yaml_config_writer.cpp.

void rviz::YamlConfigWriter::writeFile ( const Config config,
const QString &  filename 
)

Write config data to a file. This potentially changes the return values of error() and statusMessage().

Definition at line 46 of file yaml_config_writer.cpp.

void rviz::YamlConfigWriter::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 statusMessage().

Definition at line 87 of file yaml_config_writer.cpp.

QString rviz::YamlConfigWriter::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() and statusMessage().

Definition at line 71 of file yaml_config_writer.cpp.


Member Data Documentation

Definition at line 74 of file yaml_config_writer.h.

Definition at line 73 of file yaml_config_writer.h.


The documentation for this class was generated from the following files:


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Tue Oct 3 2017 03:19:32