---

Qmms::Log::LogLog Class Reference

Abstract class of static methods used to output log statements from within the qmmslog package. More...

#include <log.hh>

List of all members.

Public Methods
virtual	~LogLog ()
	Destructor. Does nothing since class is never instantiated. More...
virtual void	dummy () const=0
	This purely virtual function makes this class abstract, which ensures it can never be instantiated. More...
Static Public Methods
void	init (bool enabled, bool quiet)
	Sets debugEnabled and quietMode. More...
void	setInternalDebugging (bool enabled)
	Enable/disable qmmslog internal logging. More...
bool	isEnabled ()
	Accessor method. More...
bool	isQuiet ()
	Accessor method. More...
void	setQuietMode (bool mode)
	In QuietMode, LogLog produces no debug output; it only prints errors and warns. More...
void	debug (QString msg)
	Used to print qmmslog internal debug statements. More...
void	warn (QString msg)
	Used to print qmmslog internal warning statements. More...
void	error (QString msg)
	Used to print qmmslog internal error statements. More...
Static Protected Attributes
bool	debugEnabled
	Controls whether to print internal logging calls or not. More...
bool	quietMode
	In quietMode only errors and warns generate any output. More...
Private Methods
	LogLog ()
	Constuctor. Does nothing since class is abstract. More...
Static Private Attributes
QString	DEBUG_KEY
	Defining this value makes qmmslog components print internal log statements to cout. More...
QString	PREFIX
	The value "qmmslog: ". More...
QString	ERR_PREFIX
	The value "qmmslog:ERROR ". More...
QString	WARN_PREFIX
	The value "qmmslog:WARN ". More...

---

Detailed Description

Abstract class of static methods used to output log statements from within the qmmslog package.

Qmmslog components clearly cannot issue log statements using qmmslog. It is useful, however, for the user to know what qmmslog is doing.

Enable qmmslog internal logging by defining the qmmslog.debug variable.

All internal debug calls go to cout while internal error messages go to cerr. All internal messages are prepended with the string "qmmslog: ".

---

Constructor & Destructor Documentation

Qmms::Log::LogLog::LogLog (    )  [private]

Constuctor. Does nothing since class is abstract.

virtual Qmms::Log::LogLog::~LogLog (    )  [virtual]

Destructor. Does nothing since class is never instantiated.

---

Member Function Documentation

void Qmms::Log::LogLog::debug (  QString    msg )  [static]

Used to print qmmslog internal debug statements. Output goes to cout. Parameters: msg  debug message to print

virtual void Qmms::Log::LogLog::dummy (    )  const [pure virtual]

This purely virtual function makes this class abstract, which ensures it can never be instantiated.

void Qmms::Log::LogLog::error (  QString    msg )  [static]

Used to print qmmslog internal error statements. Output goes to cerr. Parameters: msg  error message to print

void Qmms::Log::LogLog::init (  bool    enabled, bool    quiet )  [static]

Sets debugEnabled and quietMode. Parameters: enabled  set to true enables internal debugging quiet  set to true turns on quietmode

bool Qmms::Log::LogLog::isEnabled (    )  [static]

Accessor method. Returns: true if internal logging is enabled (i.e., if debugEnabled is true), false otherwise

bool Qmms::Log::LogLog::isQuiet (    )  [static]

Accessor method. Returns: true if quietMode is set, false otherwise

void Qmms::Log::LogLog::setInternalDebugging (  bool    enabled )  [static]

Enable/disable qmmslog internal logging. Parameters: enabled  set to true to enable, false to disable

void Qmms::Log::LogLog::setQuietMode (  bool    mode )  [static]

In QuietMode, LogLog produces no debug output; it only prints errors and warns. Parameters: mode  use true to set QuietMode, false otherwise.

void Qmms::Log::LogLog::warn (  QString    msg )  [static]

Used to print qmmslog internal warning statements. Output goes to cerr. Parameters: msg  warning message to print

---

Member Data Documentation

QString Qmms::Log::LogLog::DEBUG_KEY [static, private]

Defining this value makes qmmslog components print internal log statements to cout. The value of this string is qmmslog.debug

bool Qmms::Log::LogLog::debugEnabled [static, protected]

Controls whether to print internal logging calls or not.

QString Qmms::Log::LogLog::ERR_PREFIX [static, private]

The value "qmmslog:ERROR ".

QString Qmms::Log::LogLog::PREFIX [static, private]

The value "qmmslog: ".

bool Qmms::Log::LogLog::quietMode [static, protected]

In quietMode only errors and warns generate any output.

QString Qmms::Log::LogLog::WARN_PREFIX [static, private]

The value "qmmslog:WARN ".

---

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

• log.hh

---