gazebo::common::Console Class Reference

Message, error, warning, and logging functionality. More...

#include <Console.hh>

Public Member Functions
std::ostream &	ColorErr (const std::string &_lbl, const std::string &_file, unsigned int _line, int _color)
	Use this to output an error to the terminal.
std::ostream &	ColorMsg (const std::string &_lbl, int _color)
	Use this to output a colored message to the terminal.
void	Load ()
	Load the message parameters.
std::ofstream &	Log ()
	Use this to output a message to a log file.
void	SetQuiet (bool _q)
	Set quiet output.

Static Public Member Functions
static Console *	Instance ()
	Return an instance to this class.

Detailed Description

Message, error, warning, and logging functionality.

Member Function Documentation

std::ostream& gazebo::common::Console::ColorErr	(	const std::string &	_lbl,
		const std::string &	_file,
		unsigned int	_line,
		int	_color
	)

Use this to output an error to the terminal.

Parameters

[in]	_lbl	Text label
[in]	_file	File containing the error
[in]	_line	Line containing the error
[in]	_color	Color to make the label

Returns

Reference to an output stream

std::ostream& gazebo::common::Console::ColorMsg	(	const std::string &	_lbl,
		int	_color
	)

Use this to output a colored message to the terminal.

Parameters

[in]	_lbl	Text label
[in]	_color	Color to make the label

Returns

Reference to an output stream

static Console* gazebo::common::Console::Instance ( )

static

Return an instance to this class.

void gazebo::common::Console::Load

(

)

Load the message parameters.

std::ofstream& gazebo::common::Console::Log

(

)

Use this to output a message to a log file.

Returns

Reference to output stream

void gazebo::common::Console::SetQuiet

(

bool

_q

)

Set quiet output.

Parameters

[in]

q

True to prevent warning

---

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

• Console.hh