Program options class for the "cbmreco_fairrun" application. More...

#include <ProgramOptions.h>

Collaboration diagram for ProgramOptions:

Public Member Functions
	ProgramOptions (int argc, char *argv[])
	Standard constructor with command line arguments.

	ProgramOptions (const ProgramOptions &)=delete
	Copy constructor forbidden.

void	operator= (const ProgramOptions &)=delete
	Assignment operator forbidden.

const std::string &	MonitorUri () const
	Get URI specifying the monitoring server interface.

const std::vector< std::string > &	InputUri () const
	Get URI specifying input timeslice stream source(s)

const std::string &	OutputRootFile () const
	Get output file name (.root format)

const std::string &	ConfigYamlFile () const
	Get configuration file name (.yaml format)

const std::string &	SaveConfigYamlFile () const
	Get save configuration file name (.yaml format)

bool	DumpSetup () const
	Get flag to dump the readout setup to yaml.

int32_t	MaxNumTs () const
	Get maximum number of timeslices to process.

uint16_t	HttpServerPort () const
	Get the port number for the HTTP server.

	ProgramOptions (int argc, char **argv)

	ProgramOptions (int argc, char **argv)

void	ConvertSysId (const std::string &option)

Public Attributes
cbm::algo::Setup	setup

bool	skipAlignment

std::string	outputDir

std::string	sFullFilename

uint64_t	uNbTimeslices = 0

uint16_t	selSysId = 0x00

size_t	nbMsPerComp = SIZE_MAX

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

Private Attributes
std::string	fMonitorUri
	URI specifying the monitoring server interface.

std::vector< std::string >	fInputUri
	URI(s) specifying input timeslice stream source(s)

std::string	fOutputRootFile = "/dev/null"
	Output file name (.root format)

std::string	fConfigYamlFile
	Configuration file name (.yaml format)

std::string	fSaveConfigYamlFile
	Save configuration file name (.yaml format)

bool	fDumpSetup = false
	Dump the readout setup to yaml.

int32_t	fMaxNumTs = INT32_MAX
	Maximum number of timeslices to process.

uint16_t	fHttpServerPort = 0
	Port number for the HTTP server. If 0, server will not be activated.

Detailed Description

Program options class for the "cbmreco_fairrun" application.

Author: Jan de Cuveland cuvel.nosp@m.and@.nosp@m.compe.nosp@m.ng.u.nosp@m.ni-fr.nosp@m.ankf.nosp@m.urt.d.nosp@m.e

Since: 16 March 2022

Definition at line 28 of file reco/app/cbmreco_fairrun/ProgramOptions.h.

Constructor & Destructor Documentation

◆ ProgramOptions() [1/4]

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

inline

Standard constructor with command line arguments.

Definition at line 31 of file reco/app/cbmreco_fairrun/ProgramOptions.h.

References ParseOptions().

◆ ProgramOptions() [2/4]

ProgramOptions::ProgramOptions ( const ProgramOptions & )

delete

Copy constructor forbidden.

◆ ProgramOptions() [3/4]

ProgramOptions::ProgramOptions	(	int	argc,
		char **	argv )

Definition at line 13 of file services/online_par_dump/ProgramOptions.cxx.

References outputDir, setup, and skipAlignment.

◆ ProgramOptions() [4/4]

ProgramOptions::ProgramOptions	(	int	argc,
		char **	argv )

Member Function Documentation

◆ ConfigYamlFile()

const std::string & ProgramOptions::ConfigYamlFile ( ) const

inlinenodiscard

Get configuration file name (.yaml format)

Definition at line 49 of file reco/app/cbmreco_fairrun/ProgramOptions.h.

References fConfigYamlFile.

Referenced by Application::Application().

◆ ConvertSysId()

void ProgramOptions::ConvertSysId ( const std::string & option )

Definition at line 78 of file services/tsa_dump/ProgramOptions.cxx.

References selSysId.

◆ DumpSetup()

bool ProgramOptions::DumpSetup ( ) const

inlinenodiscard

Get flag to dump the readout setup to yaml.

Definition at line 55 of file reco/app/cbmreco_fairrun/ProgramOptions.h.

References fDumpSetup.

Referenced by Application::Application().

◆ HttpServerPort()

uint16_t ProgramOptions::HttpServerPort ( ) const

inlinenodiscard

Get the port number for the HTTP server.

Definition at line 61 of file reco/app/cbmreco_fairrun/ProgramOptions.h.

References fHttpServerPort.

Referenced by Application::Application().

◆ InputUri()

const std::vector< std::string > & ProgramOptions::InputUri ( ) const

inlinenodiscard

Get URI specifying input timeslice stream source(s)

Definition at line 43 of file reco/app/cbmreco_fairrun/ProgramOptions.h.

References fInputUri.

Referenced by Application::Application().

◆ MaxNumTs()

int32_t ProgramOptions::MaxNumTs ( ) const

inlinenodiscard

Get maximum number of timeslices to process.

Definition at line 58 of file reco/app/cbmreco_fairrun/ProgramOptions.h.

References fMaxNumTs.

Referenced by Application::Application().

◆ MonitorUri()

const std::string & ProgramOptions::MonitorUri ( ) const

inlinenodiscard

Get URI specifying the monitoring server interface.

Definition at line 40 of file reco/app/cbmreco_fairrun/ProgramOptions.h.

References fMonitorUri.

Referenced by Application::Application().

◆ operator=()

void ProgramOptions::operator= ( const ProgramOptions & )

delete

Assignment operator forbidden.

◆ OutputRootFile()

const std::string & ProgramOptions::OutputRootFile ( ) const

inlinenodiscard

Get output file name (.root format)

Definition at line 46 of file reco/app/cbmreco_fairrun/ProgramOptions.h.

References fOutputRootFile.

Referenced by Application::Application().

◆ ParseOptions()

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

private

Parse command line arguments using boost program_options.

Definition at line 16 of file reco/app/cbmreco_fairrun/ProgramOptions.cxx.

References fConfigYamlFile, fDumpSetup, fHttpServerPort, fInputUri, fMaxNumTs, fMonitorUri, fOutputRootFile, fSaveConfigYamlFile, and L_.

Referenced by ProgramOptions().

◆ SaveConfigYamlFile()

const std::string & ProgramOptions::SaveConfigYamlFile ( ) const

inlinenodiscard

Get save configuration file name (.yaml format)

Definition at line 52 of file reco/app/cbmreco_fairrun/ProgramOptions.h.

References fSaveConfigYamlFile.

Referenced by Application::Application().

Member Data Documentation

◆ fConfigYamlFile

std::string ProgramOptions::fConfigYamlFile

private

Configuration file name (.yaml format)

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

Referenced by ConfigYamlFile(), and ParseOptions().

◆ fDumpSetup

bool ProgramOptions::fDumpSetup = false

private

Dump the readout setup to yaml.

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

Referenced by DumpSetup(), and ParseOptions().

◆ fHttpServerPort

uint16_t ProgramOptions::fHttpServerPort = 0

private

Port number for the HTTP server. If 0, server will not be activated.

Definition at line 75 of file reco/app/cbmreco_fairrun/ProgramOptions.h.

Referenced by HttpServerPort(), and ParseOptions().

◆ fInputUri

std::vector<std::string> ProgramOptions::fInputUri

private

URI(s) specifying input timeslice stream source(s)

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

Referenced by InputUri(), and ParseOptions().

◆ fMaxNumTs

int32_t ProgramOptions::fMaxNumTs = INT32_MAX

private

Maximum number of timeslices to process.

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

Referenced by MaxNumTs(), and ParseOptions().

◆ fMonitorUri

std::string ProgramOptions::fMonitorUri

private

URI specifying the monitoring server interface.

Definition at line 67 of file reco/app/cbmreco_fairrun/ProgramOptions.h.

Referenced by MonitorUri(), and ParseOptions().

◆ fOutputRootFile

std::string ProgramOptions::fOutputRootFile = "/dev/null"

private

Output file name (.root format)

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

Referenced by OutputRootFile(), and ParseOptions().

◆ fSaveConfigYamlFile

std::string ProgramOptions::fSaveConfigYamlFile

private

Save configuration file name (.yaml format)

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

Referenced by ParseOptions(), and SaveConfigYamlFile().

◆ nbMsPerComp

size_t ProgramOptions::nbMsPerComp = SIZE_MAX

Definition at line 19 of file services/tsa_dump/ProgramOptions.h.

◆ outputDir

std::string ProgramOptions::outputDir

Definition at line 16 of file services/online_par_dump/ProgramOptions.h.

Referenced by ProgramOptions().

◆ selSysId

uint16_t ProgramOptions::selSysId = 0x00

Definition at line 18 of file services/tsa_dump/ProgramOptions.h.

Referenced by ConvertSysId().

◆ setup

cbm::algo::Setup ProgramOptions::setup

Definition at line 14 of file services/online_par_dump/ProgramOptions.h.

Referenced by ProgramOptions().

◆ sFullFilename

std::string ProgramOptions::sFullFilename

Definition at line 15 of file services/tsa_dump/ProgramOptions.h.

◆ skipAlignment

bool ProgramOptions::skipAlignment

Definition at line 15 of file services/online_par_dump/ProgramOptions.h.

Referenced by ProgramOptions().

◆ uNbTimeslices

uint64_t ProgramOptions::uNbTimeslices = 0

Definition at line 16 of file services/tsa_dump/ProgramOptions.h.

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

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ProgramOptions() [1/4]

◆ ProgramOptions() [2/4]

◆ ProgramOptions() [3/4]

◆ ProgramOptions() [4/4]

Member Function Documentation

◆ ConfigYamlFile()

◆ ConvertSysId()

◆ DumpSetup()

◆ HttpServerPort()

◆ InputUri()

◆ MaxNumTs()

◆ MonitorUri()

◆ operator=()

◆ OutputRootFile()

◆ ParseOptions()

◆ SaveConfigYamlFile()

Member Data Documentation

◆ fConfigYamlFile

◆ fDumpSetup

◆ fHttpServerPort

◆ fInputUri

◆ fMaxNumTs

◆ fMonitorUri

◆ fOutputRootFile

◆ fSaveConfigYamlFile

◆ nbMsPerComp

◆ outputDir

◆ selSysId

◆ setup

◆ sFullFilename

◆ skipAlignment

◆ uNbTimeslices