INFM HIL Interface
Interface between Artery simulation and DuTs
Public Member Functions | Public Attributes | Friends | List of all members
sim_interface::LoggerConfig Class Reference

The logger needs a configuration before it can start logging. More...

#include <InterfaceLoggerConfig.h>

Public Member Functions

 LoggerConfig ()=default
 
 LoggerConfig (bool enableDebugMode, std::string pathConsoleLog, std::string pathDataLog, int fileBackupCount, LOG_LEVEL fileLogLevel, LOG_LEVEL consoleLogLevel)
 

Public Attributes

bool enableDebugMode = false
 
std::string pathConsoleLog = "/logs/console"
 
std::string pathDataLog = "/logs/data"
 
int fileBackupCount = 10
 
LOG_LEVEL fileLogLevel = LOG_LEVEL::INFO
 
LOG_LEVEL consoleLogLevel = LOG_LEVEL::INFO
 

Friends

class boost::serialization::access
 

Detailed Description

The logger needs a configuration before it can start logging.

This configuration has to store all required information that the logger needs. Default settings are provided.

Constructor & Destructor Documentation

◆ LoggerConfig() [1/2]

sim_interface::LoggerConfig::LoggerConfig ( )
default

Creates the essential configuration for the logger with default settings.

◆ LoggerConfig() [2/2]

sim_interface::LoggerConfig::LoggerConfig ( bool  enableDebugMode,
std::string  pathConsoleLog,
std::string  pathDataLog,
int  fileBackupCount,
LOG_LEVEL  fileLogLevel,
LOG_LEVEL  consoleLogLevel 
)
inline

Create the essential configuration for the logger.
For the logging paths it's possible to enter relative and absolute file paths. Both variants will be accepted. An example for a relative path is "/logs/console". Please notice that there is no '/' at the end. If you rather want to define an absolute path please add an additional '#' in front of your absolute path. An example for an absolute path is "#/home/user/project/logs/console"

Parameters
enableDebugMode- enables debug mode for logging. Logging levels will be ignored.
pathConsoleLog- contains the path to write the console log into a file
pathDataLog- contains the path to write the data log into a file
fileBackupCount- defines maximum amount of files in a logging directory. Old files will be deleted.
fileLogLevel- defines the logging level for the file log
consoleLogLevel- defines the logging level for the console log

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