The LogFileParent class logs progress as well as information about a process (e.g. Inport, Algorithm, Exoprt,...)
More...
#include <LogFileParent.h>
|
| virtual QString | getName ()=0 |
| | getName Returns the name
|
| |
| virtual QString | getCreationTime ()=0 |
| | getCreationTime Returns the time and date when the file was initalized
|
| |
| virtual bool | getIsPlugin ()=0 |
| | getIsPlugin Returns true if the logged process is a plugin
|
| |
| virtual void | setSettings (QMap< QString, QVariant > settings)=0 |
| | setSettings Allows to log the used settings
|
| |
| virtual void | setInputInfo (std::vector< uint > inputFrames)=0 |
| | setInputInfo allows to log the used input
|
| |
| virtual void | setResultsInfo (std::vector< uint > keyframes)=0 |
| | setResultsInfo allows to log the returned result of the process
|
| |
| virtual void | addCustomEntry (QString entryName, QVariant entryValue, QString type=EMPTY_TYPE)=0 |
| | addCustomEntry allows to log with custom entries and types
|
| |
| virtual void | startTimer (QString timerName)=0 |
| | startTimer Starts a timer to measure a specific internal process
|
| |
|
virtual void | stopTimer ()=0 |
| | stopTimer Stops the currently running timer and logs the surpassed timespan
|
| |
| virtual QJsonObject | toQJSON ()=0 |
| | toQJSON Returns the current state of the log file in form of a QJsonObject
|
| |
| virtual bool | print (QString path)=0 |
| | print Saves the current sate of the log file as a file at the given path
|
| |
The LogFileParent class logs progress as well as information about a process (e.g. Inport, Algorithm, Exoprt,...)
- Author
- Dominic Zahn
- Date
- 2021/06/24
◆ addCustomEntry()
| virtual void LogFileParent::addCustomEntry |
( |
QString |
entryName, |
|
|
QVariant |
entryValue, |
|
|
QString |
type = EMPTY_TYPE |
|
) |
| |
|
pure virtual |
addCustomEntry allows to log with custom entries and types
- Parameters
-
| entryName | is a QString which identifies the entry |
| entryValue | is a QVaraint that holds the custom value |
| type | is an optional QString which could be used to classify custom entries |
Implemented in LogFile.
◆ getCreationTime()
| virtual QString LogFileParent::getCreationTime |
( |
| ) |
|
|
pure virtual |
getCreationTime Returns the time and date when the file was initalized
- Returns
- QString in form "dd.MM.yyyy h:m:s ap" which holds creation time and date
Implemented in LogFile.
◆ getIsPlugin()
| virtual bool LogFileParent::getIsPlugin |
( |
| ) |
|
|
pure virtual |
getIsPlugin Returns true if the logged process is a plugin
- Returns
- bool with is true if the logged process is a plugin
Implemented in LogFile.
◆ getName()
| virtual QString LogFileParent::getName |
( |
| ) |
|
|
pure virtual |
getName Returns the name
- Returns
- QString with the name
Implemented in LogFile.
◆ print()
| virtual bool LogFileParent::print |
( |
QString |
path | ) |
|
|
pure virtual |
print Saves the current sate of the log file as a file at the given path
- Parameters
-
| path | is the place where the log file will be saved |
- Returns
- true if creation was successfull
Implemented in LogFile.
◆ setInputInfo()
| virtual void LogFileParent::setInputInfo |
( |
std::vector< uint > |
inputFrames | ) |
|
|
pure virtual |
setInputInfo allows to log the used input
- Parameters
-
| inputInfo | is a QVariant which holds a summary of information about the result which is the process is generating |
Implemented in LogFile.
◆ setResultsInfo()
| virtual void LogFileParent::setResultsInfo |
( |
std::vector< uint > |
keyframes | ) |
|
|
pure virtual |
setResultsInfo allows to log the returned result of the process
- Parameters
-
| resultInfo | is a QVariant which holds a summary of information about the input which is given to the process |
Implemented in LogFile.
◆ setSettings()
| virtual void LogFileParent::setSettings |
( |
QMap< QString, QVariant > |
settings | ) |
|
|
pure virtual |
setSettings Allows to log the used settings
- Parameters
-
| settings | Includes all used settings in form of a QMap<QString, QVariant> |
Implemented in LogFile.
◆ startTimer()
| virtual void LogFileParent::startTimer |
( |
QString |
timerName | ) |
|
|
pure virtual |
startTimer Starts a timer to measure a specific internal process
- Parameters
-
| timerName | is a QString which identifies the internal process and is later displayed in the log file |
Implemented in LogFile.
◆ toQJSON()
| virtual QJsonObject LogFileParent::toQJSON |
( |
| ) |
|
|
pure virtual |
toQJSON Returns the current state of the log file in form of a QJsonObject
- Returns
- QJsonObject which holds all currently locked informationf from this process
Implemented in LogFile.
The documentation for this class was generated from the following file:
1.9.8