ORE Studio 0.0.4
Loading...
Searching...
No Matches
Static Public Member Functions | List of all members
logging_configuration Class Referencefinal

Centralized manager for logging configuration parsing. More...

#include <logging_configuration.hpp>

Collaboration diagram for logging_configuration:
Collaboration graph

Static Public Member Functions

static boost::program_options::options_description make_options_description (const std::string &log_file)
 Creates the boost::program_options description for logging CLI arguments.
 
static std::optional< logging_optionsread_options (const boost::program_options::variables_map &vm)
 Reads logging options from parsed variables map.
 

Detailed Description

Centralized manager for logging configuration parsing.

Provides utilities for creating command-line option descriptions, reading configuration from parsed options.

Member Function Documentation

◆ make_options_description()

boost::program_options::options_description make_options_description ( const std::string &  log_file)
static

Creates the boost::program_options description for logging CLI arguments.

Parameters
log_filename of the file to log to by default.
Returns
options_description for logging configuration.

◆ read_options()

std::optional< logging_options > read_options ( const boost::program_options::variables_map &  vm)
static

Reads logging options from parsed variables map.

If logging is not enabled (no –log-enabled flag), returns std::nullopt.

Parameters
vmParsed command-line options.
default_filenameDefault log filename to use if not specified
default_directoryDefault log directory (defaults to "log")
Returns
logging_options if logging was enabled, std::nullopt otherwise.