QgsLogger Class Reference
[QGIS core library]

QgsLogger is a class to print debug/warning/error messages to the console. More...

#include <qgslogger.h>

List of all members.

Static Public Member Functions
static void	debug (const QString &msg, int debuglevel=1, const char *file=NULL, const char *function=NULL, int line=-1)
	Goes to qDebug.
static void	debug (const QString &var, int val, int debuglevel=1, const char *file=NULL, const char *function=NULL, int line=-1)
	Similar to the previous method, but prints a variable int-value pair.
static void	debug (const QString &var, double val, int debuglevel=1, const char *file=NULL, const char *function=NULL, int line=-1)
	Similar to the previous method, but prints a variable double-value pair.
template<typename T>
static void	debug (const QString &var, T val, const char *file=0, const char *function=0, int line=-1, int debuglevel=1)
	Prints out a variable/value pair for types with overloaded operator<<.
static void	warning (const QString &msg)
	Goes to qWarning.
static void	critical (const QString &msg)
	Goes to qCritical.
static void	fatal (const QString &msg)
	Goes to qFatal.
Static Private Member Functions
static int	debugLevel ()
	Reads the environment variable QGIS_DEBUG and converts it to int.
static const char *	debugFile ()
	Reads the environment variable QGIS_DEBUG_FILE.

---

Detailed Description

QgsLogger is a class to print debug/warning/error messages to the console.

The advantage of this class over iostream & co. is that the output can be controlled with environment variables: QGIS_DEBUG is an int describing what debug messages are written to the console. If the debug level of a message is <= QGIS_DEBUG, the message is written to the console. It the variable QGIS_DEBUG is not defined, it defaults to 1 for debug mode and to 0 for release mode QGIS_DEBUG_FILE may contain a file name. Only the messages from this file are printed (provided they have the right debuglevel). If QGIS_DEBUG_FILE is not set, messages from all files are printed

Definition at line 47 of file qgslogger.h.

---

Member Function Documentation

void QgsLogger::debug	(	const QString &	msg,
		int	debuglevel = 1,
		const char *	file = NULL,
		const char *	function = NULL,
		int	line = -1
	)			[static]

Goes to qDebug.

Parameters:

	msg	the message to be printed
	debuglevel
	file	file name where the message comes from
	function	function where the message comes from
	line	place in file where the message comes from

Definition at line 22 of file qgslogger.cpp.

References debugFile(), and debugLevel().

Referenced by QgsRasterLayer::bandStatistics(), QgsRasterLayer::buildPyramidList(), QgsRasterLayer::buildPyramids(), QgsRasterLayer::hasBand(), QgsRasterLayer::identify(), and QgsCoordinateTransform::transform().

void QgsLogger::debug	(	const QString &	var,
		int	val,
		int	debuglevel = 1,
		const char *	file = NULL,
		const char *	function = NULL,
		int	line = -1
	)			[static]

Similar to the previous method, but prints a variable int-value pair.

Definition at line 59 of file qgslogger.cpp.

References debugFile(), and debugLevel().

void QgsLogger::debug	(	const QString &	var,
		double	val,
		int	debuglevel = 1,
		const char *	file = NULL,
		const char *	function = NULL,
		int	line = -1
	)			[static]

Similar to the previous method, but prints a variable double-value pair.

Definition at line 96 of file qgslogger.cpp.

References debugFile(), and debugLevel().

template<typename T>

static void QgsLogger::debug	(	const QString &	var,
		T	val,
		const char *	file = 0,
		const char *	function = 0,
		int	line = -1,
		int	debuglevel = 1
	)			[inline, static]

Prints out a variable/value pair for types with overloaded operator<<.

Definition at line 66 of file qgslogger.h.

void QgsLogger::warning

(

const QString &

msg

)

[static]

Goes to qWarning.

Definition at line 133 of file qgslogger.cpp.

Referenced by QgsRasterLayer::buildPyramids(), QgsRasterLayer::buildSupportedRasterFileFilter(), QgsProviderRegistry::getProvider(), QgsRasterLayer::identify(), QgsDistanceArea::measureLine(), QgsDistanceArea::measurePolygon(), QgsProject::read(), QgsRasterLayer::readData(), QgsRasterLayer::readFile(), QgsRasterLayer::readValue(), QgsRasterLayer::readXml(), QgsRasterLayer::setDataProvider(), QgsVectorFileWriter::writeAsVectorFormat(), and QgsRasterLayer::writeXml().

void QgsLogger::critical

(

const QString &

msg

)

[static]

Goes to qCritical.

Definition at line 138 of file qgslogger.cpp.

Referenced by QgsCoordinateTransform::transformCoords().

void QgsLogger::fatal

(

const QString &

msg

)

[static]

Goes to qFatal.

Definition at line 143 of file qgslogger.cpp.

int QgsLogger::debugLevel

(

)

[static, private]

Reads the environment variable QGIS_DEBUG and converts it to int.

If QGIS_DEBUG is not set, the function returns 1 if QGISDEBUG is defined and 0 if not

Definition at line 148 of file qgslogger.cpp.

Referenced by debug().

const char * QgsLogger::debugFile

(

)

[static, private]

Reads the environment variable QGIS_DEBUG_FILE.

Returns NULL if the variable is not set

Definition at line 169 of file qgslogger.cpp.

Referenced by debug().

---

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

• src/core/qgslogger.h
• src/core/qgslogger.cpp