sdf::Console Class Reference

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

#include <Console.hh>

Classes
class	ConsoleStream
	An ostream-like class that we'll use for logging. More...

Public Member Functions
virtual	~Console ()
	Destructor. More...
ConsoleStream &	ColorMsg (const std::string &lbl, const std::string &file, unsigned int line, int color)
	Use this to output a colored message to the terminal. More...
ConsoleStream &	Log (const std::string &lbl, const std::string &file, unsigned int line)
	Use this to output a message to a log file. More...
void	SetQuiet (bool _q)
	Set quiet output. More...

Static Public Member Functions
static void	Clear ()
	Clear out the current console to make room for a new one. More...
static ConsolePtr	Instance ()
	Return an instance to this class. More...

Detailed Description

Message, error, warning, and logging functionality.

Constructor & Destructor Documentation

virtual sdf::Console::~Console ( )

virtual

Destructor.

Member Function Documentation

static void sdf::Console::Clear ( )

static

Clear out the current console to make room for a new one.

ConsoleStream& sdf::Console::ColorMsg	(	const std::string &	lbl,
		const std::string &	file,
		unsigned int	line,
		int	color
	)

Use this to output a colored message 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

static ConsolePtr sdf::Console::Instance ( )

static

Return an instance to this class.

Referenced by sdf::Console::ConsoleStream::operator<<().

ConsoleStream& sdf::Console::Log	(	const std::string &	lbl,
		const std::string &	file,
		unsigned int	line
	)

Use this to output a message to a log file.

Returns

Reference to output stream

void sdf::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