common_configuration Class Reference

Provides common command-line options for all applications. More...

#include <common_configuration.hpp>

Collaboration diagram for common_configuration:

Static Public Member Functions
static boost::program_options::options_description	make_options_description ()
	Creates the options description for common CLI arguments.
static common_options	read_options (const boost::program_options::variables_map &vm)
	Reads common options from parsed variables map.

Detailed Description

Provides common command-line options for all applications.

This configuration provides the standard options that every application should support: help, version, and verbose output.

Standard options: -h, –help Display help and exit -v, –version Display version and exit –verbose Enable verbose output

Member Function Documentation

make_options_description()

boost::program_options::options_description make_options_description ( )

static

Creates the options description for common CLI arguments.

Note: Help and version are typically handled by the application's main parser before other options are processed. This method provides them for consistency and documentation purposes.

Returns

options_description containing help, version, and verbose.

read_options()

common_options read_options ( const boost::program_options::variables_map &  vm )

static

Reads common options from parsed variables map.

Parameters

vm	Parsed command-line options.

Returns

common_options with verbose flag set appropriately.