Processes and controls user options provided in the command line.
More...
#include <ProgramOptions.h>
Processes and controls user options provided in the command line.
Definition at line 21 of file ProgramOptions.h.
ProgramOptions::ProgramOptions |
( |
int |
argc, |
|
|
char ** |
argv |
|
) |
| |
unsigned int tvx::ProgramOptions::GetMaxEventsUser |
( |
| ) |
const |
|
inline |
std::string ProgramOptions::GetOutFileName |
( |
std::string |
suffix = "hist" | ) |
const |
Form the name of the output file from the input file name by appending a suffix to it.
The following rules applied depending on the input file extension:
input_file_name -> input_file_name.<suffix>.root input_file_name.blah -> input_file_name.blah.<suffix>.root input_file_name.root -> input_file_name.<suffix>.root
Definition at line 114 of file ProgramOptions.cxx.
std::string tvx::ProgramOptions::GetOutPrefix |
( |
| ) |
const |
|
inline |
float tvx::ProgramOptions::GetSparsity |
( |
| ) |
const |
|
inline |
std::string tvx::ProgramOptions::PathToInputFile |
( |
| ) |
const |
|
inline |
void ProgramOptions::Print |
( |
| ) |
const |
void ProgramOptions::ProcessOptions |
( |
| ) |
|
Takes the standard command line arguments and parses them with the boost program_options utility.
Additional checks are implemented to verify the validity of the supplied arguments.
Definition at line 41 of file ProgramOptions.cxx.
bool tvx::ProgramOptions::SaveGraphics |
( |
| ) |
const |
|
inline |
void ProgramOptions::VerifyOptions |
( |
| ) |
|
|
protected |
Verifies user submitted values.
Performs basic test of values provided by the user in the command line to maker sure that they are valid.
Definition at line 72 of file ProgramOptions.cxx.
int tvx::ProgramOptions::fArgc |
|
protected |
char** tvx::ProgramOptions::fArgv |
|
protected |
std::string tvx::ProgramOptions::fInFilePath |
|
protected |
Full path to either a root file with event tree or a text file with a list of such root files.
Definition at line 49 of file ProgramOptions.h.
unsigned int tvx::ProgramOptions::fMaxEventsUser |
|
protected |
The maximum number of input events to process.
Definition at line 55 of file ProgramOptions.h.
po::options_description tvx::ProgramOptions::fOptions |
|
protected |
po::variables_map tvx::ProgramOptions::fOptionsValues |
|
protected |
std::string tvx::ProgramOptions::fOutPrefix |
|
protected |
A prefix to specify the location of the output files.
Definition at line 52 of file ProgramOptions.h.
bool tvx::ProgramOptions::fSaveGraphics |
|
protected |
This flag controls whether to produce images for created histograms.
Definition at line 61 of file ProgramOptions.h.
float tvx::ProgramOptions::fSparsity |
|
protected |
An approximate fraction of events to read and process.
Definition at line 58 of file ProgramOptions.h.
The documentation for this class was generated from the following files: