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

Detailed Description

Definition at line 44 of file yaml_config_reader.h.

Constructor & Destructor Documentation

rviz::YamlConfigReader::YamlConfigReader ( )

Constructor. Object begins in a no-error state.

Definition at line 45 of file yaml_config_reader.cpp.

bool rviz::YamlConfigReader::error ( )

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

Definition at line 140 of file yaml_config_reader.cpp.

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 145 of file yaml_config_reader.cpp.

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 49 of file yaml_config_reader.cpp.

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 61 of file yaml_config_reader.cpp.

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 55 of file yaml_config_reader.cpp.

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

Definition at line 83 of file yaml_config_reader.cpp.

Definition at line 70 of file yaml_config_reader.h.

Definition at line 69 of file yaml_config_reader.h.

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