AllInOneConfig::Options Class Reference

#include <Options.h>

Public Member Functions
void	helper (int argc, char *argv[])
	Options (bool getter=false)
void	parser (int argc, char *argv[])

Public Attributes
std::string	config
bool	dry
std::string	key

Private Attributes
boost::program_options::options_description	desc
boost::program_options::options_description	env
boost::program_options::options_description	help
boost::program_options::options_description	hide
boost::program_options::positional_options_description	pos_hide

Detailed Description

Definition at line 8 of file Options.h.

Constructor & Destructor Documentation

Options()

AllInOneConfig::Options::Options

(

bool

getter = false

)

Constructor for PO:

• contains a parser for the help itself
• contains a parser for the options (unless help was displayed)
• and contains a hidden/position option to get the JSON config file

Definition at line 40 of file Options.cc.

                              : help{"Helper"}, desc{"Options"}, hide{"Hidden"} {
    // define all options
    help.add_options()("help,h", "Help screen")("example,e", "Print example of config in JSON format")(
        "tutorial,t", "Explain how to use the command");

    // then (except for getJSON) the running options
    if (!getter)
      desc.add_options()(
          "dry,d", po::bool_switch(&dry)->default_value(false), "Set up everything, but don't run anything")(
          "verbose,v", po::bool_switch()->default_value(false)->notifier(set_verbose), "Enable standard output stream")(
          "silent,s", po::bool_switch()->default_value(false)->notifier(set_silent), "Disable standard error stream");

    // and finally / most importantly, the config file as apositional argument
    hide.add_options()("config,c", po::value<string>(&config)->required()->notifier(check_file), "JSON config file");
    pos_hide.add("config", 1);  // 1 means one (positional) argument
    if (getter) {
      // in case of getIMFO, adding a second positional argument for the key
      hide.add_options()("key,k", po::value<string>(&key)->required(), "key");
      pos_hide.add("key", 1);
    }
  }

Member Function Documentation

helper()

void AllInOneConfig::Options::helper	(	int	argc,
		char *	argv[]
	)

Definition at line 62 of file Options.cc.

References dir2webdir::argc, GCPpyPlots::argv, bold, gather_cfg::cout, desc, beamvalidation::exit(), help, normal, AlcaSiPixelAliHarvester0T_cff::options, and castor_dqm_sourceclient_file_cfg::path.

                                             {
    po::options_description options;
    options.add(help).add(desc);

    po::command_line_parser parser_helper{argc, argv};
    parser_helper
        .options(help)          // don't parse required options before parsing help
        .allow_unregistered();  // ignore unregistered options,

    // defines actions
    po::variables_map vm;
    po::store(parser_helper.run(), vm);
    po::notify(vm);  // necessary for config to be given the value from the cmd line

    if (vm.count("help")) {
      fs::path executable = argv[0];
      cout << "Basic syntax:\n  " << executable.filename().string() << " config.JSON\n"
           << options << '\n'
           << "Boost " << BOOST_LIB_VERSION << endl;
      exit(EXIT_SUCCESS);
    }

    if (vm.count("example")) {
      static const char *bold = "\e[1m", *normal = "\e[0m";
      cout << bold << "Example of HTC condor config:" << normal << '\n' << endl;
      system("cat $CMSSW_BASE/src/Alignment/OfflineValidation/bin/.default.sub");
      cout << '\n' << bold << "Example of JSON config (for `validateAlignment` only):" << normal << '\n' << endl;
      system("cat $CMSSW_BASE/src/Alignment/OfflineValidation/bin/.example.JSON");
      cout << '\n'
           << bold << "NB: " << normal
           << " for examples of inputs to GCPs, DMRs, etc., just make a dry run of the example" << endl;
      exit(EXIT_SUCCESS);
    }
    // TODO: make examples for each executables? (could be examples used in release validation...)

    if (vm.count("tutorial")) {
      cout << "   ______________________\n"
           << "  < Oops! not ready yet! >\n"
           << "   ----------------------\n"
           << "          \\   ^__^\n"
           << "           \\  (oo)\\_______\n"
           << "              (__)\\       )\\/\\\n"
           << "                  ||----w |\n"
           << "                  ||     ||\n"
           << flush;
      exit(EXIT_SUCCESS);
    }
  }

parser()

void AllInOneConfig::Options::parser	(	int	argc,
		char *	argv[]
	)

Definition at line 111 of file Options.cc.

References dir2webdir::argc, GCPpyPlots::argv, desc, hide, and pos_hide.

                                             {
    po::options_description cmd_line;
    cmd_line.add(desc).add(hide);

    po::command_line_parser parser{argc, argv};
    parser.options(cmd_line).positional(pos_hide);

    po::variables_map vm;
    po::store(parser.run(), vm);
    po::notify(vm);  // necessary for config to be given the value from the cmd line
  }

Member Data Documentation

config

std::string AllInOneConfig::Options::config

Definition at line 13 of file Options.h.

Referenced by confdb.HLTProcess::addEras(), confdb.HLTProcess::addGlobalOptions(), confdb.HLTProcess::build_source(), confdb.HLTProcess::buildOptions(), confdb.HLTProcess::customize(), confdb.HLTProcess::dump(), confdb.HLTProcess::fixPrescales(), pkg.AbstractPkg::generate(), pkg.AbstractPkg::get_kwds(), confdb.HLTProcess::getPathList(), confdb.HLTProcess::getRawConfigurationFromDB(), preexistingValidation.PreexistingValidation::getRepMap(), genericValidation.GenericValidation::getRepMap(), confdb.HLTProcess::getSetupConfigurationFromDB(), confdb.HLTProcess::instrumentDQM(), confdb.HLTProcess::instrumentErrorEventType(), confdb.HLTProcess::instrumentOpenMode(), confdb.HLTProcess::instrumentTiming(), confdb.HLTProcess::loadCffCommand(), confdb.HLTProcess::loadSetupCff(), confdb.HLTProcess::overrideGlobalTag(), confdb.HLTProcess::overrideL1MenuXml(), confdb.HLTProcess::overrideOutput(), confdb.HLTProcess::overrideProcessName(), pkg.AbstractPkg::parse_etags(), confdb.HLTProcess::runL1Emulator(), confdb.HLTProcess::specificCustomize(), and zMuMuValidation.ZMuMuValidation::trackcollection().

desc

boost::program_options::options_description AllInOneConfig::Options::desc

private

Definition at line 9 of file Options.h.

Referenced by helper(), and parser().

dry

bool AllInOneConfig::Options::dry

Definition at line 14 of file Options.h.

Referenced by ValidationMatrix_v2.ReleaseComparison::compare().

env

boost::program_options::options_description AllInOneConfig::Options::env

private

Definition at line 9 of file Options.h.

help

boost::program_options::options_description AllInOneConfig::Options::help

private

Definition at line 9 of file Options.h.

Referenced by helper(), core.autovars.NTupleVariable::makeBranch(), core.autovars.NTupleObject::makeBranches(), core.autovars.NTupleCollection::makeBranchesScalar(), and core.autovars.NTupleCollection::makeBranchesVector().

hide

boost::program_options::options_description AllInOneConfig::Options::hide

private

Definition at line 9 of file Options.h.

Referenced by parser().

key

std::string AllInOneConfig::Options::key

Definition at line 13 of file Options.h.

Referenced by das_client.HTTPSClientAuthHandler::get_connection(), and ws_sso_content_reader.HTTPSClientAuthHandler::getConnection().

pos_hide

boost::program_options::positional_options_description AllInOneConfig::Options::pos_hide

private

Definition at line 10 of file Options.h.

Referenced by parser().