Logging Documentation

Logging documentation

Info

The log handler takes in the function name, log message, log level, and time of display as parameters.

Calling the loghandler

To call the log handler function, you need to provide the following parameters:

1. functionName: The name of the function/module where the log message is being generated.
2. message: The log message to be displayed and logged.
3. level: The log level (e.g., Trace, Debug, Info, Warn, Error, or Fatal).
4. timeOfDisplay: The time duration in seconds for which the message should be displayed on the controller screen. (Optional)

Example:

loghandler("MyVeryGoodFuntion", "A very bad message", Log:;Level::Fatal, 2)

Notes

• The log handler function first logs the message into a file called "log.txt" if the configuration allows logging to a file.
• It also prints the log message, along with the time and module name, to the console in a colored format based on the log level.

If the log level is Warn, Error, or Fatal, the function displays the message on the controller screens for the specified duration. If the log level is Fatal, it also interrupts all threads and requests the system to exit the program.