art::ResultsProducer Class Reference

#include "ResultsProducer.h"

Inheritance diagram for art::ResultsProducer:

Public Types
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::PluginConfig, KeysToIgnore >

Public Member Functions
virtual	~ResultsProducer ()=default
void	doBeginJob ()
void	doEndJob ()
void	doBeginSubRun (SubRunPrincipal const &)
void	doEndSubRun (SubRunPrincipal const &)
void	doBeginRun (RunPrincipal const &)
void	doEndRun (RunPrincipal const &)
void	doEvent (EventPrincipal const &)
void	doReadResults (ResultsPrincipal const &)
void	doWriteResults (ResultsPrincipal &)
void	doClear ()
void	registerProducts (MasterProductRegistry &mpr, ProductDescriptions &producedProducts, ModuleDescription const &md)
template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)
template<typename T , art::BranchType BT>
art::ProductToken< T >	consumes (InputTag const &it)
template<typename T , BranchType = InEvent>
void	consumesMany ()
template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)
template<typename T , art::BranchType BT>
art::ViewToken< T >	consumesView (InputTag const &it)
template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)
template<typename T , art::BranchType BT>
art::ProductToken< T >	mayConsume (InputTag const &it)
template<typename T , BranchType = InEvent>
void	mayConsumeMany ()
template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)
template<typename T , art::BranchType BT>
art::ViewToken< T >	mayConsumeView (InputTag const &it)

Static Public Member Functions
static cet::exempt_ptr< Consumer >	non_module_context ()

Protected Member Functions
template<class P >
void	produces (std::string const &instanceName={})
void	validateConsumedProduct (BranchType const bt, ProductInfo const &pi)
void	setModuleDescription (ModuleDescription const &md)
void	prepareForJob (fhicl::ParameterSet const &pset)
void	showMissingConsumes () const

Private Member Functions
virtual void	beginJob ()
virtual void	endJob ()
virtual void	beginSubRun (SubRun const &)
virtual void	endSubRun (SubRun const &)
virtual void	beginRun (Run const &)
virtual void	endRun (Run const &)
virtual void	event (Event const &)
virtual void	readResults (Results const &)
virtual void	writeResults (Results &)=0
virtual void	clear ()=0
void	productList (ProductList *p)
template<typename P , BranchType B = InEvent>
void	produces (std::string const &instanceName={}, Persistable const persistable=Persistable::Yes)
template<typename P , BranchType B>
TypeLabel const &	reconstitutes (std::string const &modLabel, std::string const &instanceName={})
template<typename P , art::BranchType B>
art::TypeLabel const &	reconstitutes (std::string const &emulatedModule, std::string const &instanceName)
template<BranchType B>
std::set< TypeLabel > const &	expectedProducts () const

Private Attributes
cet::exempt_ptr< ModuleDescription const >	moduleDescription_ {nullptr}

Detailed Description

Definition at line 105 of file ResultsProducer.h.

Member Typedef Documentation

template<typename UserConfig , typename KeysToIgnore = void>

using art::ResultsProducer::Table = ProducerTable<UserConfig, detail::PluginConfig, KeysToIgnore>

Definition at line 114 of file ResultsProducer.h.

Constructor & Destructor Documentation

virtual art::ResultsProducer::~ResultsProducer ( )

virtualdefault

Member Function Documentation

void art::ResultsProducer::beginJob ( )

privatevirtual

Definition at line 17 of file ResultsProducer.cc.

{}

void art::ResultsProducer::beginRun ( Run const &  )

privatevirtual

Definition at line 33 of file ResultsProducer.cc.

{}

void art::ResultsProducer::beginSubRun ( SubRun const &  )

privatevirtual

Definition at line 25 of file ResultsProducer.cc.

{}

virtual void art::ResultsProducer::clear ( )

privatepure virtual

template<typename T , BranchType = InEvent>

ProductToken<T> art::Consumer::consumes ( InputTag const &  )

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::consumes ( InputTag const &  it )

inherited

Definition at line 147 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  if (!moduleContext_)
    return ProductToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::Product,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ProductToken<T>{it};
}

template<typename T , art::BranchType BT>

void art::Consumer::consumesMany ( )

inherited

Definition at line 162 of file Consumer.h.

{
  if (!moduleContext_)
    return;

  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
}

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::Consumer::consumesView ( InputTag const &  )

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::consumesView ( InputTag const &  it )

inherited

Definition at line 172 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  if (!moduleContext_)
    return ViewToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ViewToken<T>{it};
}

void art::ResultsProducer::doBeginJob ( )

inline

Definition at line 165 of file ResultsProducer.h.

References breakpoints::beginJob(), fhicl::ParameterSetRegistry::get(), and art::Consumer::setModuleDescription().

Referenced by art::RootOutput::beginJob().

{
  assert(moduleDescription_);
  // Preparing the consumer for the job must be done after the
  // constructer has been called.
  auto const& mainID = moduleDescription_->mainParameterSetID();
  auto const& scheduler_pset =
    fhicl::ParameterSetRegistry::get(mainID).get<fhicl::ParameterSet>(
      "services.scheduler");
  Consumer::setModuleDescription(*moduleDescription_);
  prepareForJob(scheduler_pset);
  beginJob();
}

void art::ResultsProducer::doBeginRun ( RunPrincipal const &  rp )

inline

Definition at line 201 of file ResultsProducer.h.

Referenced by art::RootOutput::beginRun().

{
  Run const r{rp, *moduleDescription_, this};
  beginRun(r);
}

void art::ResultsProducer::doBeginSubRun ( SubRunPrincipal const &  srp )

inline

Definition at line 187 of file ResultsProducer.h.

Referenced by art::RootOutput::beginSubRun().

{
  SubRun const sr{srp, *moduleDescription_, this};
  beginSubRun(sr);
}

void art::ResultsProducer::doClear ( )

inline

Definition at line 229 of file ResultsProducer.h.

References clear().

Referenced by art::RootOutput::finishEndFile().

{
  clear();
}

void art::ResultsProducer::doEndJob ( )

inline

Definition at line 180 of file ResultsProducer.h.

Referenced by art::RootOutput::endJob().

{
  endJob();
  showMissingConsumes();
}

void art::ResultsProducer::doEndRun ( RunPrincipal const &  rp )

inline

Definition at line 208 of file ResultsProducer.h.

Referenced by art::RootOutput::endRun().

{
  Run const r{rp, *moduleDescription_, this};
  endRun(r);
}

void art::ResultsProducer::doEndSubRun ( SubRunPrincipal const &  srp )

inline

Definition at line 194 of file ResultsProducer.h.

Referenced by art::RootOutput::endSubRun().

{
  SubRun const sr{srp, *moduleDescription_, this};
  endSubRun(sr);
}

void art::ResultsProducer::doEvent ( EventPrincipal const &  ep )

inline

Definition at line 215 of file ResultsProducer.h.

References e.

Referenced by art::RootOutput::event().

{
  Event const e{ep, *moduleDescription_, this};
  event(e);
}

void art::ResultsProducer::doReadResults ( ResultsPrincipal const &  resp )

inline

Definition at line 222 of file ResultsProducer.h.

Referenced by art::RootOutput::readResults().

{
  Results const res{resp, *moduleDescription_, this};
  readResults(res);
}

void art::ResultsProducer::doWriteResults

(

ResultsPrincipal &

resp

)

Definition at line 9 of file ResultsProducer.cc.

References moduleDescription_, and writeResults().

Referenced by art::RootOutput::startEndFile().

{
  Results res{resp, *moduleDescription_, this};
  writeResults(res);
  res.commit(resp);
}

void art::ResultsProducer::endJob ( )

privatevirtual

Definition at line 21 of file ResultsProducer.cc.

{}

void art::ResultsProducer::endRun ( Run const &  )

privatevirtual

Definition at line 37 of file ResultsProducer.cc.

{}

void art::ResultsProducer::endSubRun ( SubRun const &  )

privatevirtual

Definition at line 29 of file ResultsProducer.cc.

{}

void art::ResultsProducer::event ( Event const &  )

privatevirtual

Definition at line 41 of file ResultsProducer.cc.

{}

template<BranchType B>

std::set<TypeLabel> const& art::ProductRegistryHelper::expectedProducts ( ) const

inlineinherited

Definition at line 111 of file ProductRegistryHelper.h.

References B, and art::ProductRegistryHelper::typeLabelList_.

  {
    return typeLabelList_[B];
  }

template<typename T , BranchType = InEvent>

ProductToken<T> art::Consumer::mayConsume ( InputTag const &  )

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::mayConsume ( InputTag const &  it )

inherited

Definition at line 190 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  if (!moduleContext_)
    return ProductToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::Product,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ProductToken<T>{it};
}

template<typename T , art::BranchType BT>

void art::Consumer::mayConsumeMany ( )

inherited

Definition at line 205 of file Consumer.h.

{
  if (!moduleContext_)
    return;

  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
}

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::Consumer::mayConsumeView ( InputTag const &  )

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::mayConsumeView ( InputTag const &  it )

inherited

Definition at line 215 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  if (!moduleContext_)
    return ViewToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ViewToken<T>{it};
}

cet::exempt_ptr< art::Consumer > art::Consumer::non_module_context ( )

staticinherited

Definition at line 76 of file Consumer.cc.

Referenced by art::RootOutput::beginSubRun(), art::OutputModule::doBeginRun(), art::OutputModule::doBeginSubRun(), art::OutputModule::doEndRun(), art::OutputModule::doEndSubRun(), art::ProducingService::doPostReadEvent(), art::ProducingService::doPostReadRun(), art::ProducingService::doPostReadSubRun(), art::OutputModule::doWriteEvent(), art::ProcessPackage< L >::postScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::Run >::End::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::End::postScheduleSignal(), art::ProcessPackage< L >::preScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::preScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::preScheduleSignal(), art::EventProcessor::readEvent(), art::EventProcessor::readRun(), art::EmptyEvent::readRun_(), art::EventProcessor::readSubRun(), and art::EmptyEvent::readSubRun_().

{
  static Consumer invalid{InvalidTag{}};
  return &invalid;
}

void art::Consumer::prepareForJob ( fhicl::ParameterSet const &  pset )

protectedinherited

Definition at line 89 of file Consumer.cc.

References fhicl::ParameterSet::get_if_present().

Referenced by art::EDProducer::doBeginJob(), art::EDFilter::doBeginJob(), and art::EDAnalyzer::doBeginJob().

{
  if (!moduleContext_)
    return;

  pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
  for (auto& consumablesPerBranch : consumables_) {
    cet::sort_all(consumablesPerBranch);
  }
}

template<typename P , art::BranchType B>

void art::ProductRegistryHelper::produces ( std::string const &  instanceName = {}, Persistable const  persistable = Persistable::Yes  )

inlineinherited

Definition at line 141 of file ProductRegistryHelper.h.

References B, art::ProductRegistryHelper::insertOrThrow(), art::No, art::detail::verifyFriendlyClassName(), and art::detail::verifyInstanceName().

Referenced by larg4::LArG4::LArG4(), art::MixHelper::produces(), recob::ChargedSpacePointCollectionCreator::produces(), and art::ProductRegistryHelper::productList().

{
  verifyInstanceName(instanceName);
  TypeID const productType{typeid(P)};
  verifyFriendlyClassName(productType.friendlyClassName());
  bool const isTransient = (persistable == Persistable::No);
  insertOrThrow(
    B,
    TypeLabel{productType, instanceName, SupportsView<P>::value, isTransient});
}

template<class P >

void art::ResultsProducer::produces ( std::string const &  instanceName = {} )

inlineprotected

Definition at line 159 of file ResultsProducer.h.

{
  ProductRegistryHelper::produces<P, InResults>(instanceName);
}

void art::ProductRegistryHelper::productList ( ProductList *  p )

inlineinherited

Definition at line 86 of file ProductRegistryHelper.h.

References art::ProductRegistryHelper::produces(), art::ProductRegistryHelper::productList_, art::ProductRegistryHelper::reconstitutes(), art::ProductRegistryHelper::registerProducts(), and art::Yes.

  {
    productList_.reset(p);
  }

void art::ResultsProducer::readResults ( Results const &  )

privatevirtual

Definition at line 45 of file ResultsProducer.cc.

{}

template<typename P , BranchType B>

TypeLabel const& art::ProductRegistryHelper::reconstitutes ( std::string const &  modLabel, std::string const &  instanceName = {}  )

inherited

Referenced by lris::LArRawInputDriver::LArRawInputDriver(), lris::LArRawInputDriverJP250L::LArRawInputDriverJP250L(), lris::LArRawInputDriverLongBo::LArRawInputDriverLongBo(), lris::LArRawInputDriverShortBo::LArRawInputDriverShortBo(), and art::ProductRegistryHelper::productList().

template<typename P , art::BranchType B>

art::TypeLabel const& art::ProductRegistryHelper::reconstitutes ( std::string const &  emulatedModule, std::string const &  instanceName  )

inherited

Definition at line 155 of file ProductRegistryHelper.h.

References B, art::ProductRegistryHelper::insertOrThrow(), art::detail::verifyFriendlyClassName(), and art::detail::verifyInstanceName().

{
  verifyModuleLabel(emulatedModule);
  verifyInstanceName(instanceName);
  TypeID const productType{typeid(P)};
  verifyFriendlyClassName(productType.friendlyClassName());
  return insertOrThrow(
    B,
    TypeLabel{
      productType, instanceName, SupportsView<P>::value, emulatedModule});
}

void art::ResultsProducer::registerProducts ( MasterProductRegistry &  mpr, ProductDescriptions &  producedProducts, ModuleDescription const &  md  )

inline

Definition at line 128 of file ResultsProducer.h.

References art::ProductRegistryHelper::registerProducts().

Referenced by art::RootOutput::doRegisterProducts().

  {
    ProductRegistryHelper::registerProducts(mpr, producedProducts, md);
    moduleDescription_ = &md;
  }

void art::Consumer::setModuleDescription ( ModuleDescription const &  md )

protectedinherited

Definition at line 83 of file Consumer.cc.

Referenced by doBeginJob(), art::EDProducer::setModuleDescription(), art::EDFilter::setModuleDescription(), and art::EDAnalyzer::setModuleDescription().

{
  moduleDescription_ = &md;
}

void art::Consumer::showMissingConsumes ( ) const

protectedinherited

Definition at line 125 of file Consumer.cc.

Referenced by art::EDProducer::doEndJob(), art::EDFilter::doEndJob(), art::EDAnalyzer::doEndJob(), and art::RootOutput::endJob().

{
  if (!moduleContext_)
    return;

  // If none of the branches have missing consumes statements, exit early.
  if (std::all_of(cbegin(missingConsumes_),
                  cend(missingConsumes_),
                  [](auto const& perBranch) { return perBranch.empty(); }))
    return;

  constexpr cet::HorizontalRule rule{60};
  mf::LogPrint log{"MTdiagnostics"};
  log << '\n'
      << rule('=') << '\n'
      << "The following consumes (or mayConsume) statements are missing from\n"
      << module_context(moduleDescription_) << '\n'
      << rule('-') << '\n';

  cet::for_all_with_index(
    missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
      for (auto const& pi : perBranch) {
        log << "  "
            << assemble_consumes_statement(static_cast<BranchType>(i), pi)
            << '\n';
      }
    });
  log << rule('=');
}

void art::Consumer::validateConsumedProduct ( BranchType const  bt, ProductInfo const &  pi  )

protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

{
  // Early exits if consumes tracking has been disabled or if the
  // consumed product is an allowed consumable.
  if (!moduleContext_)
    return;

  if (cet::binary_search_all(consumables_[bt], pi))
    return;

  if (requireConsumes_) {
    throw Exception(errors::ProductRegistrationFailure,
                    "Consumer: an error occurred during validation of a "
                    "retrieved product\n\n")
      << "The following consumes (or mayConsume) statement is missing from\n"
      << module_context(moduleDescription_) << ":\n\n"
      << "  " << assemble_consumes_statement(bt, pi) << "\n\n";
  }

  missingConsumes_[bt].insert(pi);
}

virtual void art::ResultsProducer::writeResults ( Results &  )

privatepure virtual

Referenced by doWriteResults().

Member Data Documentation

cet::exempt_ptr<ModuleDescription const> art::ResultsProducer::moduleDescription_ {nullptr}

private

Definition at line 137 of file ResultsProducer.h.

Referenced by doWriteResults().

---

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

• art/Framework/Core/ResultsProducer.h
• art/Framework/Core/ResultsProducer.cc