Skip to main content

DPF Cpp Client Library 2026 R1

Class ansys::dpf::core::logging::LoggerConfig

Last update: 25.03.2026

The configuration associated to a Logger. It allows setting the log level and the sinks of a logger.

Members

Public functions

Function LoggerConfig

ansys::dpf::core::logging::LoggerConfig::LoggerConfig()

Construct a new Logger Config object.

Return type:

Function getLogLevel

eLogLevel ansys::dpf::core::logging::LoggerConfig::getLogLevel() const

Get the loglevel for the Logger.

Returns:

eLogLevel

Return type: eLogLevel

Function getSinks

std::set< eLoggerSink > const  & ansys::dpf::core::logging::LoggerConfig::getSinks() const

Get the list of sink types supported by the Logger.

Returns:

std::set<eLoggerSink> const&

Return type: std::set< eLoggerSink > const &

Function withLogLevel

LoggerConfig & ansys::dpf::core::logging::LoggerConfig::withLogLevel(eLogLevel log_level)

Sets the log level for the Logger.

Parameters:

  • log_level: The Logger loglevel.

Returns:

LoggerConfig&

Parameters:

  • eLogLevel log_level

Return type: LoggerConfig &

Function withSinks

LoggerConfig & ansys::dpf::core::logging::LoggerConfig::withSinks(eLoggerSink sink)

Sets a single sink for the Logger to write to.

Parameters:

  • sink: The sink to write to.

Returns:

LoggerConfig&

Parameters:

  • eLoggerSink sink

Return type: LoggerConfig &

Function withSinks

LoggerConfig & ansys::dpf::core::logging::LoggerConfig::withSinks(std::set< eLoggerSink > const &sinks)

Sets a list of sinks for the Logger to write to.

Parameters:

  • sinks: The sinks to write to.

Returns:

LoggerConfig&

Parameters:

  • std::set< eLoggerSink > const & sinks

Return type: LoggerConfig &

Public static functions

Function defaultConfig

static LoggerConfig ansys::dpf::core::logging::LoggerConfig::defaultConfig()

Returns the default config for logging.

Returns:

LoggerConfig

Return type: LoggerConfig

Connect with Ansys