cbm::reco::offline::ProgramOptions Class Reference

#include <ProgramOptions.h>

Collaboration diagram for cbm::reco::offline::ProgramOptions:

Public Member Functions
	ProgramOptions (int argc, char *argv[])
	Standard constructor with command line arguments.
	ProgramOptions (const ProgramOptions &)=delete
	Copy constructor forbidden.
ProgramOptions &	operator= (const ProgramOptions &)=delete
	Assignment operator forbidden.
	~ProgramOptions ()=default
	Destructor.
const std::string &	RawFile () const
	Get digitization (raw) file name.
const std::string &	OutputFile () const
	Get output file name (.root format)
const std::string &	ConfigFile () const
	Get configuration file name (YAML format)
bool	Overwrite () const
	Get overwrite option.
const std::string &	ParFile () const
	Get parameter file name.
const std::string &	SetupTag () const
	Get geometry setup tag.

Private Member Functions
void	ParseOptions (int argc, char *argv[])
	Parse command line arguments using boost program_options.

Private Attributes
std::string	fRaw = ""
	Input raw (digi) file name (ROOT format)
std::string	fOutput = ""
	Output file name (ROOT format)
std::string	fPar = ""
	Parameter file name (ROOT format)
std::string	fConfig = ""
	Configuration file name (YAML format)
std::string	fSetup = ""
	Geometry setup tag.
bool	fOverwrite = false
	Enable overwriting of existing output file.

Detailed Description

Author

Volker Friese v.fri.nosp@m.ese@.nosp@m.gsi.d.nosp@m.e

Since

9 June 2023

Program option class for the application cbmreco_offline

Definition at line 30 of file reco/offline/app/ProgramOptions.h.

Constructor & Destructor Documentation

ProgramOptions() [1/2]

cbm::reco::offline::ProgramOptions::ProgramOptions ( int argc, char * argv[] )

inline

Standard constructor with command line arguments.

Definition at line 33 of file reco/offline/app/ProgramOptions.h.

References ParseOptions().

ProgramOptions() [2/2]

cbm::reco::offline::ProgramOptions::ProgramOptions ( const ProgramOptions & )

delete

Copy constructor forbidden.

~ProgramOptions()

cbm::reco::offline::ProgramOptions::~ProgramOptions ( )

default

Destructor.

Member Function Documentation

ConfigFile()

const std::string & cbm::reco::offline::ProgramOptions::ConfigFile ( ) const

inlinenodiscard

Get configuration file name (YAML format)

Definition at line 51 of file reco/offline/app/ProgramOptions.h.

References fConfig.

Referenced by cbm::reco::offline::Application::Exec().

operator=()

ProgramOptions & cbm::reco::offline::ProgramOptions::operator= ( const ProgramOptions & )

delete

Assignment operator forbidden.

OutputFile()

const std::string & cbm::reco::offline::ProgramOptions::OutputFile ( ) const

inlinenodiscard

Get output file name (.root format)

Definition at line 48 of file reco/offline/app/ProgramOptions.h.

References fOutput.

Referenced by cbm::reco::offline::Application::Exec().

Overwrite()

bool cbm::reco::offline::ProgramOptions::Overwrite ( ) const

inlinenodiscard

Get overwrite option.

Definition at line 54 of file reco/offline/app/ProgramOptions.h.

References fOverwrite.

Referenced by cbm::reco::offline::Application::Exec().

ParFile()

const std::string & cbm::reco::offline::ProgramOptions::ParFile ( ) const

inlinenodiscard

Get parameter file name.

Definition at line 57 of file reco/offline/app/ProgramOptions.h.

References fPar.

Referenced by cbm::reco::offline::Application::Exec().

ParseOptions()

void ProgramOptions::ParseOptions ( int argc, char * argv[] )

private

Parse command line arguments using boost program_options.

Definition at line 28 of file reco/offline/app/ProgramOptions.cxx.

References DEFAULT_CONFIG, DEFAULT_SETUP, fConfig, fOutput, fOverwrite, fPar, fRaw, and fSetup.

Referenced by ProgramOptions().

RawFile()

const std::string & cbm::reco::offline::ProgramOptions::RawFile ( ) const

inlinenodiscard

Get digitization (raw) file name.

Definition at line 45 of file reco/offline/app/ProgramOptions.h.

References fRaw.

Referenced by cbm::reco::offline::Application::Exec().

SetupTag()

const std::string & cbm::reco::offline::ProgramOptions::SetupTag ( ) const

inlinenodiscard

Get geometry setup tag.

Definition at line 60 of file reco/offline/app/ProgramOptions.h.

References fSetup.

Referenced by cbm::reco::offline::Application::Exec().

Member Data Documentation

fConfig

std::string cbm::reco::offline::ProgramOptions::fConfig = ""

private

Configuration file name (YAML format)

Definition at line 72 of file reco/offline/app/ProgramOptions.h.

Referenced by ConfigFile(), and ParseOptions().

fOutput

std::string cbm::reco::offline::ProgramOptions::fOutput = ""

private

Output file name (ROOT format)

Definition at line 70 of file reco/offline/app/ProgramOptions.h.

Referenced by OutputFile(), and ParseOptions().

fOverwrite

bool cbm::reco::offline::ProgramOptions::fOverwrite = false

private

Enable overwriting of existing output file.

Definition at line 74 of file reco/offline/app/ProgramOptions.h.

Referenced by Overwrite(), and ParseOptions().

fPar

std::string cbm::reco::offline::ProgramOptions::fPar = ""

private

Parameter file name (ROOT format)

Definition at line 71 of file reco/offline/app/ProgramOptions.h.

Referenced by ParFile(), and ParseOptions().

fRaw

std::string cbm::reco::offline::ProgramOptions::fRaw = ""

private

Input raw (digi) file name (ROOT format)

Definition at line 69 of file reco/offline/app/ProgramOptions.h.

Referenced by ParseOptions(), and RawFile().

fSetup

std::string cbm::reco::offline::ProgramOptions::fSetup = ""

private

Geometry setup tag.

Definition at line 73 of file reco/offline/app/ProgramOptions.h.

Referenced by ParseOptions(), and SetupTag().

---

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

• reco/offline/app/ProgramOptions.h
• reco/offline/app/ProgramOptions.cxx