The console class This class manage all the stdio stuff. More...

#include <Console.h>

Public Types
enum	ConnectionMode { Direct = 0 , Queued =1 }

enum	ConsoleMode { Verbose = 1 }
	enumaration for the console modes More...

enum	FreeCAD_ConsoleMsgType { MsgType_Txt = 1 , MsgType_Log = 2 , MsgType_Wrn = 4 , MsgType_Err = 8 }

Public Member Functions
void	AttachObserver (ILogger *pcObserver)
	Attaches an Observer to FCConsole. More...

void	DetachObserver (ILogger *pcObserver)
	Detaches an Observer from FCConsole. More...

void	EnableRefresh (bool enable)

virtual void	Error (const char *pMsg,...)
	Prints a error Message. More...

ILogger *	Get (const char *Name) const

int *	GetLogLevel (const char *tag, bool create=true)

bool	IsMsgTypeEnabled (const char *sObs, FreeCAD_ConsoleMsgType type) const
	Enables or disables message types of a certain console observer. More...

virtual void	Log (const char *pMsg,...)
	Prints a log Message. More...

int	LogLevel (int level) const

virtual void	Message (const char *pMsg,...)
	Prints a Message. More...

void	NotifyError (const char *sMsg)

void	NotifyLog (const char *sMsg)

void	NotifyMessage (const char *sMsg)

void	NotifyWarning (const char *sMsg)

void	Refresh ()

void	SetConnectionMode (ConnectionMode mode)

void	SetConsoleMode (ConsoleMode m)
	Change mode. More...

void	SetDefaultLogLevel (int level)

ConsoleMsgFlags	SetEnabledMsgType (const char *sObs, ConsoleMsgFlags type, bool b)
	Enables or disables message types of a certain console observer. More...

void	UnsetConsoleMode (ConsoleMode m)
	Change mode. More...

virtual void	Warning (const char *pMsg,...)
	Prints a warning Message. More...

Static Public Member Functions
static ConsoleSingleton &	Instance ()
	singleton More...

Static Public Attributes
static const unsigned int	BufferSize = 4024

static PyMethodDef	Methods []

Protected Member Functions
	ConsoleSingleton ()

virtual	~ConsoleSingleton ()

Static Protected Member Functions
static PyObject *	sPyError (PyObject self, PyObject args)

static PyObject *	sPyGetStatus (PyObject self, PyObject args)

static PyObject *	sPyLog (PyObject self, PyObject args)

static PyObject *	sPyMessage (PyObject self, PyObject args)

static PyObject *	sPySetStatus (PyObject self, PyObject args)

static PyObject *	sPyWarning (PyObject self, PyObject args)

Protected Attributes
ConnectionMode	connectionMode

Friends
class	ConsoleOutput

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

Member Enumeration Documentation

◆ ConnectionMode

enum Base::ConsoleSingleton::ConnectionMode

Enumerator
Direct
Queued

◆ ConsoleMode

enum Base::ConsoleSingleton::ConsoleMode

enumaration for the console modes

Enumerator
Verbose

◆ FreeCAD_ConsoleMsgType

enum Base::ConsoleSingleton::FreeCAD_ConsoleMsgType

Enumerator
MsgType_Txt
MsgType_Log
MsgType_Wrn
MsgType_Err

Constructor & Destructor Documentation

◆ ConsoleSingleton()

ConsoleSingleton::ConsoleSingleton ( )

protected

Referenced by Instance().

◆ ~ConsoleSingleton()

ConsoleSingleton::~ConsoleSingleton ( )

protectedvirtual

References Base::ConsoleOutput::destruct().

Member Function Documentation

◆ AttachObserver()

void ConsoleSingleton::AttachObserver ( ILogger * pcObserver )

Attaches an Observer to FCConsole.

Attaches an Observer to Console Use this method to attach a ILogger derived class to the Console.

After the observer is attached all messages will also be forwarded to it.

See also: ILogger

Referenced by CmdTestConsoleOutput::activated(), Gui::DockWnd::ReportOutput::ReportOutput(), Gui::SplashObserver::SplashObserver(), and Gui::StatusBarObserver::StatusBarObserver().

◆ DetachObserver()

void ConsoleSingleton::DetachObserver ( ILogger * pcObserver )

Detaches an Observer from FCConsole.

Detaches an Observer from Console Use this method to detach a ILogger derived class.

After detaching you can destruct the Observer or reinsert it later.

See also: ILogger

Referenced by CmdTestConsoleOutput::activated(), App::Application::destructObserver(), ILoggerBlockerTest::~ILoggerBlockerTest(), Gui::DockWnd::ReportOutput::~ReportOutput(), Gui::SplashObserver::~SplashObserver(), and Gui::StatusBarObserver::~StatusBarObserver().

◆ EnableRefresh()

void ConsoleSingleton::EnableRefresh ( bool enable )

Referenced by Base::ConsoleRefreshDisabler::ConsoleRefreshDisabler(), and Base::ConsoleRefreshDisabler::~ConsoleRefreshDisabler().

◆ Error()

void ConsoleSingleton::Error	(	const char *	pMsg,
			...
	)

virtual

Prints a error Message.

Prints a Message This method issues an Error which makes some execution impossible.

Errors are used to get the users attention. That means when FreeCAD is running in GUI mode an Error Message Box pops up. In console mode a colored message is printed to the console! Don't use this carelessly. For information purposes the 'Log' or 'Message' methods are more appropriate.

: You can use a printf like interface like:
Console().Error("Something really bad in %s happened\n",str);

See also: Message; Warning; Log

References Error().

◆ Get()

ILogger * ConsoleSingleton::Get ( const char * Name ) const

References Base::ILogger::Name().

Referenced by IsMsgTypeEnabled(), Base::Builder3D::saveToLog(), SetEnabledMsgType(), sPyGetStatus(), and sPySetStatus().

◆ GetLogLevel()

int * ConsoleSingleton::GetLogLevel	(	const char *	tag,
		bool	create = `true`
	)

References femsolver.elmer.equations.elasticity::create().

◆ Instance()

ConsoleSingleton & ConsoleSingleton::Instance ( )

static

singleton

References ConsoleSingleton().

Referenced by Base::Console(), sPyError(), sPyGetStatus(), sPyLog(), sPyMessage(), sPySetStatus(), and sPyWarning().

◆ IsMsgTypeEnabled()

bool ConsoleSingleton::IsMsgTypeEnabled	(	const char *	sObs,
		FreeCAD_ConsoleMsgType	type
	)		const

Enables or disables message types of a certain console observer.

References Base::ILogger::bErr, Base::ILogger::bLog, Base::ILogger::bMsg, Base::ILogger::bWrn, Get(), MsgType_Err, MsgType_Log, MsgType_Txt, and MsgType_Wrn.

◆ Log()

void ConsoleSingleton::Log	(	const char *	pMsg,
			...
	)

virtual

Prints a log Message.

Prints a Message This method is appropriate for development and tracking purposes.

It can be used to track execution of algorithms and functions. The normal user doesn't need to see it, it's more for developers and experienced users. So in normal user mode the logging is switched off.

: You can use a printf-like interface for example:
Console().Log("Execute part %d in algorithm %s\n",i,str);

See also: Message; Warning; Error

References Log().

◆ LogLevel()

int Base::ConsoleSingleton::LogLevel ( int level ) const

Referenced by Base::LogLevel::level().

◆ Message()

void ConsoleSingleton::Message	(	const char *	pMsg,
			...
	)

virtual

Prints a Message.

Prints a Message This method issues a Message.

Messages are used to show some non vital information. That means when FreeCAD is running in GUI mode a Message appears on the status bar. In console mode a message is printed to the console.

: You can use a printf like interface like:
Console().Message("Doing something important %d times\n",i);

See also: Warning; Error; Log

References Message().

◆ NotifyError()

void ConsoleSingleton::NotifyError ( const char * sMsg )

References Base::Error.

Referenced by Base::ConsoleOutput::customEvent().

◆ NotifyLog()

void ConsoleSingleton::NotifyLog ( const char * sMsg )

References Base::Log.

Referenced by Base::ConsoleOutput::customEvent().

◆ NotifyMessage()

void ConsoleSingleton::NotifyMessage ( const char * sMsg )

References Base::Message.

Referenced by Base::ConsoleOutput::customEvent().

◆ NotifyWarning()

void ConsoleSingleton::NotifyWarning ( const char * sMsg )

References Base::Warning.

Referenced by Base::ConsoleOutput::customEvent().

◆ Refresh()

void ConsoleSingleton::Refresh ( )

◆ SetConnectionMode()

void ConsoleSingleton::SetConnectionMode ( ConnectionMode mode )

References connectionMode, Base::ConsoleOutput::getInstance(), and Queued.

◆ SetConsoleMode()

void ConsoleSingleton::SetConsoleMode ( ConsoleMode m )

Change mode.

sets the console in a special mode

References Verbose.

◆ SetDefaultLogLevel()

void Base::ConsoleSingleton::SetDefaultLogLevel ( int level )

◆ SetEnabledMsgType()

ConsoleMsgFlags ConsoleSingleton::SetEnabledMsgType	(	const char *	sObs,
		ConsoleMsgFlags	type,
		bool	b
	)

Enables or disables message types of a certain console observer.

type can be OR'ed with any of the FreeCAD_ConsoleMsgType flags to enable – if b is true – or to disable – if b is false – a console observer with name sObs.

The return value is an OR'ed value of all message types that have changed their state. For example

// switch off warnings and error messages
ConsoleMsgFlags ret = Base::Console().SetEnabledMsgType("myObs",
                      Base:ConsoleSingleton::MsgType_Wrn|Base::ConsoleSingleton::MsgType_Err, false);
// do something without notifying observer myObs
...
// restore the former configuration again
Base::Console().SetEnabledMsgType("myObs", ret, true);

switches off warnings and error messages and restore the state before the modification. If the observer sObs doesn't exist then nothing happens.

References Base::ILogger::bErr, Base::ILogger::bLog, Base::ILogger::bMsg, Base::ILogger::bWrn, Get(), MsgType_Err, MsgType_Log, MsgType_Txt, and MsgType_Wrn.

Referenced by Base::ILoggerBlocker::ILoggerBlocker(), ILoggerBlockerTest::runTest(), and Base::ILoggerBlocker::~ILoggerBlocker().

◆ sPyError()

PyObject * ConsoleSingleton::sPyError	(	PyObject *	self,
		PyObject *	args
	)

staticprotected

References Error(), and Instance().

◆ sPyGetStatus()

PyObject * ConsoleSingleton::sPyGetStatus	(	PyObject *	self,
		PyObject *	args
	)

staticprotected

References Base::ILogger::bErr, Base::ILogger::bLog, Base::ILogger::bMsg, Base::ILogger::bWrn, Get(), and Instance().

◆ sPyLog()

PyObject * ConsoleSingleton::sPyLog	(	PyObject *	self,
		PyObject *	args
	)

staticprotected

References Instance(), and Log().

◆ sPyMessage()

PyObject * ConsoleSingleton::sPyMessage	(	PyObject *	self,
		PyObject *	args
	)

staticprotected

References Instance(), and Message().

◆ sPySetStatus()

PyObject * ConsoleSingleton::sPySetStatus	(	PyObject *	self,
		PyObject *	args
	)

staticprotected

References Base::ILogger::bErr, Base::ILogger::bLog, Base::ILogger::bMsg, Base::ILogger::bWrn, Get(), Instance(), and Base::PyExc_FC_GeneralError.

◆ sPyWarning()

PyObject * ConsoleSingleton::sPyWarning	(	PyObject *	self,
		PyObject *	args
	)

staticprotected

References Instance(), and Warning().

◆ UnsetConsoleMode()

void ConsoleSingleton::UnsetConsoleMode ( ConsoleMode m )

Change mode.

unsets the console from a special mode

References Verbose.

◆ Warning()

void ConsoleSingleton::Warning	(	const char *	pMsg,
			...
	)

virtual

Prints a warning Message.

Prints a Message This method issues a Warning.

Messages are used to get the users attention. That means when FreeCAD is in GUI mode a Message Box pops up. In console mode a colored message is returned to the console! Don't use this carelessly. For information purposes the 'Log' or 'Message' methods are more appropriate.

: You can use a printf like interface like:
Console().Warning("Some defects in %s, loading anyway\n",str);

See also: Message; Error; Log

References Warning().

Friends And Related Function Documentation

◆ ConsoleOutput

friend class ConsoleOutput

friend

Member Data Documentation

◆ BufferSize

const unsigned int Base::ConsoleSingleton::BufferSize = 4024

static

Referenced by GCS::SolverReportingManager::LogToConsole().

◆ connectionMode

ConnectionMode Base::ConsoleSingleton::connectionMode

protected

Referenced by SetConnectionMode().

◆ Methods

PyMethodDef ConsoleSingleton::Methods

static

Initial value:

= {
    {"PrintMessage",         ConsoleSingleton::sPyMessage, METH_VARARGS,
     "PrintMessage(string) -- Print a message to the output"},
    {"PrintLog",             ConsoleSingleton::sPyLog, METH_VARARGS,
     "PrintLog(string) -- Print a log message to the output"},
    {"PrintError"  ,         ConsoleSingleton::sPyError, METH_VARARGS,
     "PrintError(string) -- Print an error message to the output"},
    {"PrintWarning",         ConsoleSingleton::sPyWarning, METH_VARARGS,
     "PrintWarning -- Print a warning to the output"},
    {"SetStatus",            ConsoleSingleton::sPySetStatus, METH_VARARGS,
     "Set the status for either Log, Msg, Wrn or Error for an observer"},
    {"GetStatus",            ConsoleSingleton::sPyGetStatus, METH_VARARGS,
     "Get the status for either Log, Msg, Wrn or Error for an observer"},
    {nullptr, nullptr, 0, nullptr}      
}

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

FreeCAD/src/Base/Console.h
FreeCAD/src/Base/Console.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ ConnectionMode

◆ ConsoleMode

◆ FreeCAD_ConsoleMsgType

Constructor & Destructor Documentation

◆ ConsoleSingleton()

◆ ~ConsoleSingleton()

Member Function Documentation

◆ AttachObserver()

◆ DetachObserver()

◆ EnableRefresh()

◆ Error()

◆ Get()

◆ GetLogLevel()

◆ Instance()

◆ IsMsgTypeEnabled()

◆ Log()

◆ LogLevel()

◆ Message()

◆ NotifyError()

◆ NotifyLog()

◆ NotifyMessage()

◆ NotifyWarning()

◆ Refresh()

◆ SetConnectionMode()

◆ SetConsoleMode()

◆ SetDefaultLogLevel()

◆ SetEnabledMsgType()

◆ sPyError()

◆ sPyGetStatus()

◆ sPyLog()

◆ sPyMessage()

◆ sPySetStatus()

◆ sPyWarning()

◆ UnsetConsoleMode()

◆ Warning()

Friends And Related Function Documentation

◆ ConsoleOutput

Member Data Documentation

◆ BufferSize

◆ connectionMode

◆ Methods