QuasarAppUtils::QALogger Class Reference
The QALogger class is logger handler for app. This class allow to log all message from app to file. More...
#include <qalogger.h>
Collaboration diagram for QuasarAppUtils::QALogger:
Public Member Functions | |
| QALogger () | |
| QALogger This is the default constructor of the QALogger object. After the construction call the init method for enable the logging. | |
| ~QALogger () | |
| ~QALogger This is the destructor of the QALogger object. It removes the message handler and closes the log file if it was opened. | |
| void | init () |
| init This method initialize logging of all qt message into file. | |
Static Public Member Functions | |
| static QString | getLogFilePath () |
| getLogFilePath This method returns the path of the log file that will be used by the logger. The location can be overridden with the "fileLog" option of the Params class. | |
Detailed Description
The QALogger class is logger handler for app. This class allow to log all message from app to file.
Example:
#include <qalogger.h>
QuasarAppUtils::QALogger logger;
QuasarAppUtils::Params::setEnable("fileLog", true); //force enable file writing using efault file location - located in localApplication data.
QuasarAppUtils::Params::parseParams(argc, argv);
logger.init();
static void setEnable(const QString &key, bool enable)
setEnable This method sets boolean value of key.
Definition params.cpp:356
static bool parseParams(const int argc, const char *argv[], const OptionsDataList &options={})
parseParams Parse input data of started application.
Definition params.cpp:193
The QALogger class is logger handler for app. This class allow to log all message from app to file.
Definition qalogger.h:46
void init()
init This method initialize logging of all qt message into file.
Definition qalogger.cpp:85
Standard file log locations per platforms :
- Windows: APPDATA%/OrganisationName/YourAppName/YourAppName.log
- Linux: $HOME/.config/OrganisationName/YourAppName/YourAppName.log
- Mac: $HOME/Library/Application Support/OrganisationName/YourAppName/YourAppName.log
- Android: /data/data/com.organisationName.yourAppName/files/YourAppName.log
- iOS: /var/mobile/Applications/Data/YourAppName/YourAppName.log
you can overiwite this location by setting "fileLog" option in Params.
Definition at line 45 of file qalogger.h.
Constructor & Destructor Documentation
◆ QALogger()
| QuasarAppUtils::QALogger::QALogger | ( | ) |
QALogger This is the default constructor of the QALogger object. After the construction call the init method for enable the logging.
Definition at line 31 of file qalogger.cpp.
◆ ~QALogger()
| QuasarAppUtils::QALogger::~QALogger | ( | ) |
~QALogger This is the destructor of the QALogger object. It removes the message handler and closes the log file if it was opened.
Definition at line 34 of file qalogger.cpp.
Member Function Documentation
◆ getLogFilePath()
|
static |
getLogFilePath This method returns the path of the log file that will be used by the logger. The location can be overridden with the "fileLog" option of the Params class.
- Returns
- path of the log file.
Definition at line 110 of file qalogger.cpp.
◆ init()
| void QuasarAppUtils::QALogger::init | ( | ) |
init This method initialize logging of all qt message into file.
- Note
- This function should be invokae after parsing arguments. if you invoke this before parsing arguments, verbose level of logs will not created correct.
Definition at line 85 of file qalogger.cpp.
Here is the call graph for this function:
The documentation for this class was generated from the following files:
