precice::logging::BackendConfiguration Struct Reference

Holds the configuration for one logging backend (sink) and takes care of default values. More...

#include <LogConfiguration.hpp>

Collaboration diagram for precice::logging::BackendConfiguration:

Public Member Functions
void	setOption (std::string key, std::string value)
	Sets on option, overwrites default values.
void	setEnabled (bool enabled)
	Sets weather the sink is enabled or disabled.

Static Public Member Functions
static bool	isValidOption (std::string key)
	Checks if an option is usable.

Public Attributes
std::string	type = default_type
std::string	output = default_output
std::string	filter = default_filter
std::string	format = default_formatter
bool	enabled = true

Static Public Attributes
static const std::string	default_type = "stream"
static const std::string	default_output = "stdout"
static const std::string	default_filter = "(%Severity% > debug) and not ((%Severity% = info) and (%Rank% != 0))"
static const std::string	default_formatter = "(%Rank%) %TimeStamp(format=\"%H:%M:%S\")% [%Module%]:%Line% in %Function%: %ColorizedSeverity%%Message%"

Detailed Description

Holds the configuration for one logging backend (sink) and takes care of default values.

Definition at line 9 of file LogConfiguration.hpp.

Member Function Documentation

isValidOption()

bool precice::logging::BackendConfiguration::isValidOption ( std::string key )

static

Checks if an option is usable.

Definition at line 216 of file LogConfiguration.cpp.

setEnabled()

void precice::logging::BackendConfiguration::setEnabled

(

bool

enabled

)

Sets weather the sink is enabled or disabled.

Definition at line 222 of file LogConfiguration.cpp.

setOption()

void precice::logging::BackendConfiguration::setOption	(	std::string	key,
		std::string	value )

Sets on option, overwrites default values.

Definition at line 201 of file LogConfiguration.cpp.

Member Data Documentation

default_filter

const std::string precice::logging::BackendConfiguration::default_filter = "(%Severity% > debug) and not ((%Severity% = info) and (%Rank% != 0))"

static

Definition at line 12 of file LogConfiguration.hpp.

default_formatter

const std::string precice::logging::BackendConfiguration::default_formatter = "(%Rank%) %TimeStamp(format=\"%H:%M:%S\")% [%Module%]:%Line% in %Function%: %ColorizedSeverity%%Message%"

static

Definition at line 13 of file LogConfiguration.hpp.

default_output

const std::string precice::logging::BackendConfiguration::default_output = "stdout"

static

Definition at line 11 of file LogConfiguration.hpp.

default_type

const std::string precice::logging::BackendConfiguration::default_type = "stream"

static

Definition at line 10 of file LogConfiguration.hpp.

enabled

bool precice::logging::BackendConfiguration::enabled = true

Definition at line 19 of file LogConfiguration.hpp.

filter

std::string precice::logging::BackendConfiguration::filter = default_filter

Definition at line 17 of file LogConfiguration.hpp.

format

std::string precice::logging::BackendConfiguration::format = default_formatter

Definition at line 18 of file LogConfiguration.hpp.

output

std::string precice::logging::BackendConfiguration::output = default_output

Definition at line 16 of file LogConfiguration.hpp.

type

std::string precice::logging::BackendConfiguration::type = default_type

Definition at line 15 of file LogConfiguration.hpp.

---

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

• src/logging/LogConfiguration.hpp
• src/logging/LogConfiguration.cpp