dunedaq::appfwk::CommandLineInterpreter Struct Reference

CommandLineInterpreter parses the command-line options given to the application and stores the results as validated data members. More...

#include <CommandLineInterpreter.hpp>

Static Public Member Functions
static CommandLineInterpreter	parse (int argc, char **argv)
	Parse the command line and return a CommandLineInterpreter struct.

Public Attributes
bool	help_requested { false }
std::string	app_name { "" }
std::string	session_name { "" }
std::string	configuration_id { "" }
std::string	command_facility_plugin_name { "" }
std::string	conf_service_plugin_name { "" }
std::vector< std::string >	other_options {}
	Any other options which were passed and not recognized.

Detailed Description

CommandLineInterpreter parses the command-line options given to the application and stores the results as validated data members.

Please note that contrary to the rest of the framework this class is not supposed to use ERS because the ERS cannot be instantiated until the command line is parsed

Definition at line 31 of file CommandLineInterpreter.hpp.

Member Function Documentation

parse()

static CommandLineInterpreter dunedaq::appfwk::CommandLineInterpreter::parse ( int argc, char ** argv )

inlinestatic

Parse the command line and return a CommandLineInterpreter struct.

Parameters

argc	Number of arguments
argv	Command-line arguments

Returns

CommandLineInterpreter structure with parsed arguments

Definition at line 40 of file CommandLineInterpreter.hpp.

  {
    CommandLineInterpreter output;
 
    std::ostringstream descstr;
    descstr << *argv
            << " known arguments (additional arguments will be stored and "
               "passed on)";
    bpo::options_description desc(descstr.str());
    desc.add_options()("name,n", bpo::value<std::string>()->required(), "Application name")(
      "sessionName,s", bpo::value<std::string>()->required(), "Session name")(
      "configurationId,k", bpo::value<std::string>()->required(), "Configuration id")(
      "commandFacility,c", bpo::value<std::string>()->required(), "CommandFacility URI")(
      "configurationService,d", bpo::value<std::string>()->required(), "Configuration Service URI")(
      "help,h", "produce help message");
 
    bpo::variables_map vm;
    auto parsed = bpo::command_line_parser(argc, argv).options(desc).allow_unregistered().run();
 
    output.other_options = bpo::collect_unrecognized(parsed.options, bpo::include_positional);
    bpo::store(parsed, vm);
 
    if (vm.count("help")) {
      std::cout << desc << std::endl; // NOLINT
      output.help_requested = true;
      return output;
    }
 
    bpo::notify(vm);
 
    output.app_name = vm["name"].as<std::string>();
    output.session_name = vm["sessionName"].as<std::string>();
    output.configuration_id = vm["configurationId"].as<std::string>();
    output.command_facility_plugin_name = vm["commandFacility"].as<std::string>();
    output.conf_service_plugin_name = vm["configurationService"].as<std::string>();
    return output;
  }

Member Data Documentation

app_name

std::string dunedaq::appfwk::CommandLineInterpreter::app_name { "" }

Definition at line 80 of file CommandLineInterpreter.hpp.

{ "" };

command_facility_plugin_name

std::string dunedaq::appfwk::CommandLineInterpreter::command_facility_plugin_name { "" }

Definition at line 83 of file CommandLineInterpreter.hpp.

{ "" };

conf_service_plugin_name

std::string dunedaq::appfwk::CommandLineInterpreter::conf_service_plugin_name { "" }

Definition at line 84 of file CommandLineInterpreter.hpp.

{ "" };

configuration_id

std::string dunedaq::appfwk::CommandLineInterpreter::configuration_id { "" }

Definition at line 82 of file CommandLineInterpreter.hpp.

{ "" };

help_requested

bool dunedaq::appfwk::CommandLineInterpreter::help_requested { false }

Definition at line 78 of file CommandLineInterpreter.hpp.

{ false };

other_options

std::vector<std::string> dunedaq::appfwk::CommandLineInterpreter::other_options {}

Any other options which were passed and not recognized.

Definition at line 86 of file CommandLineInterpreter.hpp.

{}; 

session_name

std::string dunedaq::appfwk::CommandLineInterpreter::session_name { "" }

Definition at line 81 of file CommandLineInterpreter.hpp.

{ "" };

---

The documentation for this struct was generated from the following file:

• /github/workspace/dunedaq/sourcecode/appfwk/src/CommandLineInterpreter.hpp