art::BasicSourceOptionsHandler Class Reference

#include "BasicSourceOptionsHandler.h"

Inheritance diagram for art::BasicSourceOptionsHandler:

Public Member Functions
	BasicSourceOptionsHandler (bpo::options_description &desc)
int	checkOptions (bpo::variables_map const &vm)
int	processOptions (bpo::variables_map const &vm, fhicl::intermediate_table &raw_config)

Private Member Functions
int	doCheckOptions (bpo::variables_map const &vm) override
int	doProcessOptions (bpo::variables_map const &vm, fhicl::intermediate_table &raw_config) override
bool	processSourceListArg_ (bpo::variables_map const &vm, std::vector< std::string > &source_list)

Detailed Description

Definition at line 14 of file BasicSourceOptionsHandler.h.

Constructor & Destructor Documentation

art::BasicSourceOptionsHandler::BasicSourceOptionsHandler ( bpo::options_description &  desc )

explicit

Definition at line 12 of file BasicSourceOptionsHandler.cc.

{
  bpo::options_description source_options{"Source options"};
  // clang-format off
  source_options.add_options()
    ("source,s",
       bpo::value<std::vector<std::string>>()->composing(),
       "Source data file (multiple OK); precludes -S.")
    ("source-list,S",
       bpo::value<std::string>(),
       "file containing a list of source files to read, one per line; "
       "precludes -s.")
    ("estart,e",
       bpo::value<std::string>(),
       "EventID of first event to process (e.g. '1:2:4' starts event "
       "processing at run 1, subrun2, event 4).")
    ("nevts,n", bpo::value<int>(), "Number of events to process.")
    ("nskip", bpo::value<unsigned long>(), "Number of events to skip.");
  // clang-format on
  desc.add(source_options);
}

Member Function Documentation

int art::OptionsHandler::checkOptions ( bpo::variables_map const &  vm )

inherited

Definition at line 51 of file OptionsHandler.cc.

References art::OptionsHandler::doCheckOptions().

{
  std::string const thisClass(cet::demangle_symbol(typeid(*this).name()));
  return exceptionCatcher([&vm, this] { return doCheckOptions(vm); },
                          thisClass + "::doCheckOptions()",
                          89);
}

int art::BasicSourceOptionsHandler::doCheckOptions ( bpo::variables_map const &  vm )

overrideprivatevirtual

Implements art::OptionsHandler.

Definition at line 36 of file BasicSourceOptionsHandler.cc.

{
  return 0;
}

int art::BasicSourceOptionsHandler::doProcessOptions ( bpo::variables_map const &  vm, fhicl::intermediate_table &  raw_config  )

overrideprivatevirtual

Implements art::OptionsHandler.

Definition at line 42 of file BasicSourceOptionsHandler.cc.

References art::detail::event_start(), processSourceListArg_(), and fhicl::intermediate_table::put().

{
  std::vector<std::string> source_list;
  if (vm.count("source")) {
    source_list = vm["source"].as<std::vector<std::string>>();
  }
  auto have_source_list_file = processSourceListArg_(vm, source_list);
  // Post-process the config.
  if (source_list.size() > 0 || have_source_list_file) {
    // Empty source list file will override non-empty FHiCL spec.
    raw_config.put("source.fileNames", source_list);
  }
  if (vm.count("nevts")) {
    raw_config.put("source.maxEvents", vm["nevts"].as<int>());
  }
  if (vm.count("estart")) {
    auto const [run, subRun, event] =
      detail::event_start(vm["estart"].as<std::string>());
    raw_config.put("source.firstRun", run);
    raw_config.put("source.firstSubRun", subRun);
    raw_config.put("source.firstEvent", event);
  }
  if (vm.count("nskip")) {
    raw_config.put("source.skipEvents", vm["nskip"].as<unsigned long>());
  }
  return 0;
}

int art::OptionsHandler::processOptions ( bpo::variables_map const &  vm, fhicl::intermediate_table &  raw_config  )

inherited

Definition at line 60 of file OptionsHandler.cc.

References art::OptionsHandler::doProcessOptions().

{
  std::string const thisClass(cet::demangle_symbol(typeid(*this).name()));
  return exceptionCatcher(
    [&, this] { return doProcessOptions(vm, raw_config); },
    thisClass + "::doProcessOptions()",
    90);
}

bool art::BasicSourceOptionsHandler::processSourceListArg_ ( bpo::variables_map const &  vm, std::vector< std::string > &  source_list  )

private

Definition at line 73 of file BasicSourceOptionsHandler.cc.

References art::errors::Configuration, and art::detail::fillSourceList().

Referenced by doProcessOptions().

{
  bool result = !!vm.count("source-list");
  if (result) {
    if (!source_list.empty()) {
      throw Exception(errors::Configuration)
        << "--source-list (-S) and --source (-s) or non-option arguments are "
        << "incompatible due to ordering ambiguities.\n";
    }
    auto const filename = vm["source-list"].as<std::string>();
    std::ifstream flist{filename};
    if (!flist) {
      throw Exception(errors::Configuration)
        << "Specified source-list file \"" << filename
        << "\" cannot be read.\n";
    }
    art::detail::fillSourceList(flist, source_list);
  }
  return result;
}

---

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

• art/Framework/Art/BasicSourceOptionsHandler.h
• art/Framework/Art/BasicSourceOptionsHandler.cc