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

#include <yaml_config_reader.h>

Public Member Functions

bool error ()
 Return true if the latest readFile() or readString() call had an error. More...
 
QString errorMessage ()
 Return an error message if the latest read call had an error, or the empty string if not. More...
 
void readFile (Config &config, const QString &filename)
 Read config data from a file. This potentially changes the return value sof error(), statusMessage(), and config(). More...
 
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(), statusMessage(), and config(). More...
 
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(), statusMessage(), and config(). More...
 
 YamlConfigReader ()
 Constructor. Object begins in a no-error state. More...
 

Private Member Functions

void readYamlNode (Config &config, const YAML::Node &yaml_node)
 

Private Attributes

bool error_
 
QString message_
 

Detailed Description

Definition at line 43 of file yaml_config_reader.h.

Constructor & Destructor Documentation

◆ YamlConfigReader()

rviz::YamlConfigReader::YamlConfigReader ( )

Constructor. Object begins in a no-error state.

Definition at line 38 of file yaml_config_reader.cpp.

Member Function Documentation

◆ error()

bool rviz::YamlConfigReader::error ( )

Return true if the latest readFile() or readString() call had an error.

Definition at line 108 of file yaml_config_reader.cpp.

◆ errorMessage()

QString rviz::YamlConfigReader::errorMessage ( )

Return an error message if the latest read call had an error, or the empty string if not.

Definition at line 113 of file yaml_config_reader.cpp.

◆ readFile()

void rviz::YamlConfigReader::readFile ( Config config,
const QString &  filename 
)

Read config data from a file. This potentially changes the return value sof error(), statusMessage(), and config().

Definition at line 42 of file yaml_config_reader.cpp.

◆ readStream()

void rviz::YamlConfigReader::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(), statusMessage(), and config().

Definition at line 54 of file yaml_config_reader.cpp.

◆ readString()

void rviz::YamlConfigReader::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(), statusMessage(), and config().

Definition at line 48 of file yaml_config_reader.cpp.

◆ readYamlNode()

void rviz::YamlConfigReader::readYamlNode ( Config config,
const YAML::Node &  yaml_node 
)
private

Definition at line 71 of file yaml_config_reader.cpp.

Member Data Documentation

◆ error_

bool rviz::YamlConfigReader::error_
private

Definition at line 72 of file yaml_config_reader.h.

◆ message_

QString rviz::YamlConfigReader::message_
private

Definition at line 71 of file yaml_config_reader.h.


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


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Wed Jul 6 2022 02:05:04