QGIS API Documentation 3.39.0-Master (bca3cdb6021)
|
QgsLogger is a class to print debug/warning/error messages to the console. More...
#include <qgslogger.h>
Static Public Member Functions | |
static void | critical (const QString &msg) |
Goes to qCritical. | |
static void | debug (const QString &msg, int debuglevel=1, const char *file=nullptr, const char *function=nullptr, int line=-1) |
Goes to qDebug. | |
static void | debug (const QString &var, double val, int debuglevel=1, const char *file=nullptr, const char *function=nullptr, int line=-1) |
Similar to the previous method, but prints a variable double-value pair. | |
static void | debug (const QString &var, int val, int debuglevel=1, const char *file=nullptr, const char *function=nullptr, int line=-1) |
Similar to the previous method, but prints a variable int-value pair. | |
template<typename T > | |
static void | debug (const QString &var, T val, const char *file=nullptr, const char *function=nullptr, int line=-1, int debuglevel=1) |
Prints out a variable/value pair for types with overloaded operator<<. | |
static int | debugLevel () |
Reads the environment variable QGIS_DEBUG and converts it to int. | |
static void | fatal (const QString &msg) |
Goes to qFatal. | |
static QString | logFile () |
Reads the environment variable QGIS_LOG_FILE. | |
static void | logMessageToFile (const QString &message) |
Logs the message passed in to the logfile defined in QGIS_LOG_FILE if any. | |
static void | warning (const QString &msg) |
Goes to qWarning. | |
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
QGIS_LOG_FILE may contain a file name. If set, all messages will be appended to this file rather than to stdout.
Definition at line 60 of file qgslogger.h.
|
static |
Goes to qCritical.
Definition at line 137 of file qgslogger.cpp.
|
static |
Goes to qDebug.
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 59 of file qgslogger.cpp.
|
static |
Similar to the previous method, but prints a variable double-value pair.
Definition at line 126 of file qgslogger.cpp.
|
static |
Similar to the previous method, but prints a variable int-value pair.
Definition at line 121 of file qgslogger.cpp.
|
inlinestatic |
Prints out a variable/value pair for types with overloaded operator<<.
Definition at line 87 of file qgslogger.h.
|
inlinestatic |
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 108 of file qgslogger.h.
|
static |
Goes to qFatal.
Definition at line 143 of file qgslogger.cpp.
|
static |
Reads the environment variable QGIS_LOG_FILE.
Returns an empty string if the variable is not set, otherwise returns a file name for writing log messages to.
Definition at line 163 of file qgslogger.cpp.
|
static |
Logs the message passed in to the logfile defined in QGIS_LOG_FILE if any.
Definition at line 149 of file qgslogger.cpp.
|
static |
Goes to qWarning.
Definition at line 131 of file qgslogger.cpp.