Public Member Functions | Private Member Functions | Private Attributes | List of all members
rviz::YamlConfigWriter Class Reference

#include <yaml_config_writer.h>

Public Member Functions

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

Private Member Functions

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

Private Attributes

bool error_
 
QString message_
 

Detailed Description

Definition at line 43 of file yaml_config_writer.h.

Constructor & Destructor Documentation

◆ YamlConfigWriter()

rviz::YamlConfigWriter::YamlConfigWriter ( )

Constructor. Writer starts in a non-error state.

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

Definition at line 39 of file yaml_config_writer.cpp.

Member Function Documentation

◆ error()

bool rviz::YamlConfigWriter::error ( )

Return true if the latest write operation had an error.

Definition at line 99 of file yaml_config_writer.cpp.

◆ errorMessage()

QString rviz::YamlConfigWriter::errorMessage ( )

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

Definition at line 104 of file yaml_config_writer.cpp.

◆ writeConfigNode()

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

Definition at line 109 of file yaml_config_writer.cpp.

◆ writeFile()

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 45 of file yaml_config_writer.cpp.

◆ writeStream()

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 86 of file yaml_config_writer.cpp.

◆ writeString()

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 70 of file yaml_config_writer.cpp.

Member Data Documentation

◆ error_

bool rviz::YamlConfigWriter::error_
private

Definition at line 73 of file yaml_config_writer.h.

◆ message_

QString rviz::YamlConfigWriter::message_
private

Definition at line 72 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 Sat Dec 18 2021 03:05:55