LogParams Class Documentation

classLogParams

Namespace:datalogics_interface

Detailed Description

The messages include the date and time, the source of the error, and the error type: debug, info, warning, error, or fatal. This class also defines the log file name and path.

Referenced by

Library

Uses types

LogOutputFlags

Constructor & Destructor Documentation

LogParams

LogParams()

The LogParams object contains all settings required for logging. The log output, log file name and log string format can be configured with it.

~LogParams

~LogParams()

Member Function Documentation

get_log_file_name

std::stringget_log_file_name()

Returns:

Path to the file to write the log to.

Gets the path to the file to write the log to.

get_log_format

std::stringget_log_format()

Returns:

string Log record format.

NOTE: PDFL supports the following markers to form output string:

"%d" - current date (mmddyyyy). Example: 07292013 "%t" - current time (hhmmss). Example: 121311 "%s" - error source. Example: "DLFramework" "%e" - error type. It can be debug, info, warning, error, fatal. The value which will be output within this marker depends on severity value. It always outputs "error" string.

"%m" - error message. Example: "Exception: InExistent.pdf: This file
cannot be found. Error number: 1074397201" "%T" - full date. It contains current date, current time and the timezone (yyyy-mm- ddThh:mm:ss+/-hh:mm). Example: 2013-07-29T12:13:11+03:00

By default "%T | %s | %e | %m" string format is used.

get_log_output_flags

LogOutputFlagsget_log_output_flags()

Returns:

currently used flags.

Supported types of logging are: console, file and Event Log (for Windows only). The outputs can be mixed by ORing corresponding flags. It is also possible to suppress any logging using LogOutputFlags::None.

set_log_file_name

voidset_log_file_name(const std::string &file_name)

Parameters

file_name: const std::string &

Path to the file to write the log to.

Returns:

void

NOTE: Ignored if LogOuputFlag::File flag is not set.

set_log_format

voidset_log_format(const std::string &format)

Parameters

format: const std::string &

string Log record format.

Returns:

void

NOTE: PDFL supports the following markers to form output string:

"%d" - current date (mmddyyyy). Example: 07292013 "%t" - current time (hhmmss). Example: 121311 "%s" - error source. Example: "DLFramework" "%e" - error type. It can be debug, info, warning, error, fatal. The value which will be output within this marker depends on severity value. Currently it always outputs "error" string.

"%m" - error message. Example: "Exception: InExistent.pdf: This file
cannot be found. Error number: 1074397201" "%T" - full date. It contains current date, current time and the timezone (yyyy-mm- ddThh:mm:ss+/-hh:mm). Example: 2013-07-29T12:13:11+03:00

By default "%T | %s | %e | %m" string format is used.

set_log_output_flags

voidset_log_output_flags(LogOutputFlagsflags)

Parameters

flags: LogOutputFlags

the flags containing outputs to write the log to.

Returns:

void

Supported types of logging are: console, file and Event Log (for Windows only). The outputs can be mixed by ORing corresponding flags. It is also possible to suppress any logging using LogOutputFlags::None.