Base::ConsoleSingleton Class Reference

#include <Base/Console.h>

Detailed Description

The console class This class manage all the stdio stuff. This includes Messages, Warnings, Log entries and Errors. The incoming Messages are distributed with the FCConsoleObserver. The FCConsole class itself makes no IO, it's more like a manager.

ConsoleSingleton is a singleton! That means you can access the only instance of the class from every where in c++ by simply using:

#include <Base/Console.h>
Base::Console().Log("Stage: %d",i);

ConsoleSingleton is able to switch between several modes to, e.g. switch the logging on or off, or treat Warnings as Errors, and so on...

See also

ConsoleObserver

Public Types
enum	ConsoleMode
	enumaration for the console modes

Public Member Functions
virtual void	Message (const char *pMsg,...)
	Prints a Message.
virtual void	Warning (const char *pMsg,...)
	Prints a warning Message.
virtual void	Error (const char *pMsg,...)
	Prints a error Message.
virtual void	Log (const char *pMsg,...)
	Prints a log Message.
const char *	Time (void)
	Delivers a time/date string.
void	AttachObserver (ConsoleObserver *pcObserver)
	Attaches an Observer to FCConsole.
void	DetachObserver (ConsoleObserver *pcObserver)
	Detaches an Observer from FCConsole.
void	SetConsoleMode (ConsoleMode m)
	Change mode.
void	UnsetConsoleMode (ConsoleMode m)
	Change mode.
ConsoleMsgFlags	SetEnabledMsgType (const char *sObs, ConsoleMsgFlags type, bool b)
	Enables or disables message types of a certain console observer.
bool	IsMsgTypeEnabled (const char *sObs, FreeCAD_ConsoleMsgType type) const
	Enables or disables message types of a certain console observer.

Static Public Member Functions
static ConsoleSingleton &	Instance (void)
	singleton