art::BasicOutputOptionsHandler Class Reference

#include "BasicOutputOptionsHandler.h"

Inheritance diagram for art::BasicOutputOptionsHandler:

Public Member Functions
	BasicOutputOptionsHandler (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

Private Attributes
std::string	tmpDir_ {}

Detailed Description

Definition at line 12 of file BasicOutputOptionsHandler.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 32 of file BasicOutputOptionsHandler.cc.

References art::add_opt().

{
  bpo::options_description output_options{"Output options"};
  auto options = output_options.add_options();
  add_opt(options,
          "TFileName,T",
          bpo::value<std::string>(),
          "File name for TFileService.");
  add_opt(
    options,
    "tmpdir",
    bpo::value<std::string>(&tmpDir_),
    "Temporary directory for in-progress output files (defaults to directory "
    "of specified output file names).");
  add_opt(options,
          "tmpDir",
          bpo::value<std::string>(&tmpDir_),
          "Synonym for --tmpdir.");
  add_opt(options,
          "output,o",
          bpo::value<stringvec>()->composing(),
          "Event output stream file (optionally specify stream with "
          "stream-label:fileName in which case multiples are OK).");
  add_opt(options, "no-output", "Disable all output streams.");
  desc.add(output_options);
}

Member Function Documentation

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

inherited

Definition at line 51 of file OptionsHandler.cc.

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

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

overrideprivatevirtual

Implements art::OptionsHandler.

Definition at line 61 of file BasicOutputOptionsHandler.cc.

References art::errors::Configuration, e, art::ensureTable(), fhicl::intermediate_table::erase(), art::detail::exists_outside_prolog(), fhicl::intermediate_table::get(), n, fhicl::intermediate_table::put(), s, fhicl::SEQUENCE, art::setRootErrorHandler(), and util::flags::to_string().

{
  return 0;
}

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

overrideprivatevirtual

Implements art::OptionsHandler.

Definition at line 240 of file BasicOutputOptionsHandler.cc.

References art::completeRootHandlers(), art::detail::exists_outside_prolog(), art::detail::fhicl_key(), fhicl::intermediate_table::get(), art::module, fhicl::intermediate_table::put(), art::service, art::detail::supports_key(), and art::unloadRootSigHandler().

{
  // TFileService output.
  if (vm.count("TFileName") == 1) {
    std::string tFileName(vm["TFileName"].as<std::string>());
    std::string const& key{"services.TFileService"};
    if (tFileName.empty() && detail::exists_outside_prolog(raw_config, key) &&
        raw_config.get<table_t const&>(key).empty()) {
      tFileName = "hist.root";
    }
    if (!tFileName.empty()) {
      raw_config.put(key + ".fileName", tFileName);
    }
  }
  // Output stream options.
  processFileOutputOptions(vm, raw_config);
  // tmpDir option for TFileService and output streams.
  if (!tmpDir_.empty()) {
    std::string const& tfile_key = fhicl_key("services", "TFileService");
    if (detail::exists_outside_prolog(raw_config, tfile_key)) {
      assert(detail::supports_key(
        art::suffix_type::service, "TFileService", "tmpDir"));
      raw_config.put(fhicl_key(tfile_key, "tmpDir"), tmpDir_);
    }

    // Inject tmpDir for output modules that support the 'tmpDir' parameter.
    std::string const outputs_stem{"outputs"};
    if (detail::exists_outside_prolog(raw_config, outputs_stem)) {
      auto const& table = raw_config.get<table_t const&>(outputs_stem);
      for (auto const& output : table) {
        auto const& module_label = fhicl_key(outputs_stem, output.first);
        auto const& module_type = fhicl_key(module_label, "module_type");
        if (!detail::exists_outside_prolog(raw_config, module_type))
          continue;

        auto const& spec = raw_config.get<std::string>(module_type);
        if (!detail::supports_key(art::suffix_type::module, spec, "tmpDir"))
          continue;

        raw_config.put(fhicl_key(module_label, "tmpDir"), tmpDir_);
      }
    }
  }

  // Init ROOT handlers facility
  auto const unload_key = fhicl_key("scheduler", "unloadRootSigHandler");
  auto const unloadRSHandler =
    detail::exists_outside_prolog(raw_config, unload_key) ?
      raw_config.get<bool>(unload_key) :
      true;
  if (unloadRSHandler) {
    art::unloadRootSigHandler();
  }

  auto const reset_key = fhicl_key("scheduler", "resetRootErrHandler");
  auto const maybe_reset =
    detail::exists_outside_prolog(raw_config, reset_key) ?
      raw_config.get<bool>(reset_key) :
      true;
  RootErrorHandlerSentry re_sentry{maybe_reset};
  art::completeRootHandlers();

  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.

Referenced by art::run_art_string_config().

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

Member Data Documentation

std::string art::BasicOutputOptionsHandler::tmpDir_ {}

private

Definition at line 23 of file BasicOutputOptionsHandler.h.

---

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

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