Description:

Definition of the multi-line message mode for class textlogger::TextLogger and its derivates. This struct is used to define an external configuration variable named ALOX/LOGGERNAME/FORMAT_MULTILINE. This variable can be accessed programatically with TextLogger::GetFormatMultiLine or by accessing the variable's value through the configuration object found in camp singleton alib::ALOX.

Definition at line 206 of file variables.hpp.

#include <variables.hpp>

Collaboration diagram for FormatMultiLine:

[legend]

Public Field Index:
AStringPA	Delimiter

AStringPA	DelimiterReplacement

AStringPA	Headline

int	Mode

AStringPA	Prefix

AStringPA	Suffix

Public Method Index:
	FormatMultiLine (PoolAllocator &pool)

Field Details:

◆ Delimiter

AStringPA Delimiter

This is the string interpreted as line delimiter within log messages. If nulled, then '\n', '\r' or '\r\n' is recognized.
Important: Can be set to an empty string, to stop any multi line processing of TextLogger, even the replacements of the delimiter character.

Definition at line 233 of file variables.hpp.

◆ DelimiterReplacement

AStringPA DelimiterReplacement

This is the readable (!) separator string, for logging out multi line messages into a single line (Mode==0). Defaults to "\\r".

Definition at line 255 of file variables.hpp.

◆ Headline

AStringPA Headline

Headline for multi line messages (depending on Mode) . Defaults to "ALox: Multi line message follows: "

Definition at line 237 of file variables.hpp.

◆ Mode

int Mode

Determines if multi line messages should be split into different log lines. Possible values are:

0: No line split is performed, delimiters can be replaced by readable delimiters (depending on setting of Delimiter and DelimiterReplacement).
1: Each log line contains all meta-information
2: Starting with second log line, meta-information is replaced by blanks (default)
3: The headline Headline is logged and all lines of the multi line text are logged at position zero (without further meta-information)
4: Just the multi line text is logged, starting at column zero (no meta-information is logged)

Note: In modes 3 and 4, no ESC::EOMETA is included at the beginning of the message. Loggers that need such info, have to implement method TextLogger::notifyMultiLineOp.

Definition at line 227 of file variables.hpp.

◆ Prefix

AStringPA Prefix

Prefix for multi line messages. This is also used if multi line messages logging is switched off (MultiLineMsgMode == 0) but replacing of a set MultiLineDelimiter takes place. Defaults to ">> ".

Definition at line 243 of file variables.hpp.

◆ Suffix

AStringPA Suffix

Suffix for multi line messages. This is also used if multi line messages logging is switched off (MultiLineMsgMode == 0) and replacing of a set Delimiter takes place.
Note that at the end of the last line, in addition Suffix is added.
Defaults to "".

Definition at line 250 of file variables.hpp.

Constructor(s) / Destructor Details:

◆ FormatMultiLine()

FormatMultiLine ( PoolAllocator & pool )

inline

Constructor taking an object pool which is passed to each string member.

Parameters

pool	The pool object of the Configuration.

Definition at line 259 of file variables.hpp.

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

variables.hpp