#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 () noexcept=default

	ResultsProducer () noexcept(false)

void	doBeginJob ()

void	doEndJob ()

void	doBeginRun (RunPrincipal const &)

void	doEndRun (RunPrincipal const &)

void	doBeginSubRun (SubRunPrincipal const &)

void	doEndSubRun (SubRunPrincipal const &)

void	doEvent (EventPrincipal const &)

void	doReadResults (ResultsPrincipal const &)

void	doWriteResults (ResultsPrincipal &)

void	doClear ()

void	registerProducts (ProductDescriptions &producedProducts, ModuleDescription const &md)

ModuleDescription const &	moduleDescription () const

void	setModuleDescription (ModuleDescription const &)

std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const

void	sortConsumables (std::string const &current_process_name)

std::unique_ptr< Worker >	makeWorker (WorkerParams const &wp)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Protected Member Functions
template<class P >
void	produces (std::string const &instanceName={})

ConsumesCollector &	consumesCollector ()

template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)

template<typename T , BranchType = InEvent>
void	consumesMany ()

template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)

template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Private Member Functions
std::unique_ptr< Worker >	doMakeWorker (WorkerParams const &wp) final

virtual void	readResults (Results const &)

virtual void	writeResults (Results &)=0

virtual void	clear ()=0

virtual void	beginJob ()

virtual void	endJob ()

virtual void	beginRun (Run const &)

virtual void	endRun (Run const &)

virtual void	beginSubRun (SubRun const &)

virtual void	endSubRun (SubRun const &)

virtual void	event (Event const &)

hep::concurrency::SerialTaskQueueChain *	serialTaskQueueChain () const

std::set< std::string > const &	sharedResources () const

void	createQueues (SharedResources const &resources)

template<BranchType BT = InEvent, typename... T>
void	serialize (T const &...)

template<BranchType , typename... T>
void	serialize (T const &...resources)

template<BranchType BT = InEvent, typename... T>
void	serializeExternal (T const &...)

template<BranchType , typename... T>
void	serializeExternal (T const &...resources)

template<BranchType BT = InEvent>
void	async ()

void	productList (std::unique_ptr< ProductList > p)

void	fillDescriptions (ModuleDescription const &md)

template<typename P , BranchType B>
TypeLabel const &	reconstitutes (std::string const &modLabel, std::string const &instanceName={})

template<BranchType B>
TypeLabelLookup_t const &	expectedProducts () const

template<typename P , BranchType B = InEvent>
void	produces (std::string const &instanceName={}, Persistable const persistable=Persistable::Yes)

ProducesCollector &	producesCollector () noexcept

Detailed Description

Definition at line 93 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 102 of file ResultsProducer.h.

Constructor & Destructor Documentation

virtual art::ResultsProducer::~ResultsProducer ( )

virtualdefaultnoexcept

art::ResultsProducer::ResultsProducer ( )

noexcept

Definition at line 33 of file ResultsProducer.cc.

References art::detail::LegacyResource.

     : ProductRegistryHelper{product_creation_mode::produces}
   {
     serialize(detail::LegacyResource);
   }

Member Function Documentation

template<BranchType BT = InEvent>

void art::detail::SharedModule::async ( )

inlineprotectedinherited

Definition at line 38 of file SharedModule.h.

References art::detail::SharedModule::asyncDeclared_, art::detail::SharedModule::implicit_serialize(), art::InEvent, and art::detail::SharedModule::serialize_for().

     {
       static_assert(
         BT == InEvent,
         "async is currently supported only for the 'InEvent' level.");
       asyncDeclared_ = true;
     }

void art::ResultsProducer::beginJob ( )

privatevirtual

Definition at line 124 of file ResultsProducer.cc.

125 {}

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

privatevirtual

Definition at line 132 of file ResultsProducer.cc.

133 {}

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

privatevirtual

Definition at line 140 of file ResultsProducer.cc.

141 {}

virtual void art::ResultsProducer::clear ( )

privatepure virtual

template<typename T , BranchType BT>

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

protectedinherited

Definition at line 61 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumes().

   {
     return collector_.consumes<T, BT>(tag);
   }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

   {
     return collector_;
   }

template<typename T , BranchType BT>

void art::ModuleBase::consumesMany ( )

protectedinherited

Definition at line 75 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesMany().

   {
     collector_.consumesMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

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

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::consumesView ( InputTag const & tag )

inherited

Definition at line 68 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesView().

   {
     return collector_.consumesView<T, BT>(tag);
   }

void art::detail::SharedModule::createQueues ( SharedResources const & resources )

inherited

Definition at line 34 of file SharedModule.cc.

References art::detail::SharedModule::asyncDeclared_, util::cbegin(), util::cend(), art::detail::SharedModule::chain_, art::detail::SharedResources::createQueues(), e, util::empty(), art::errors::LogicError, and art::detail::SharedModule::resourceNames_.

Referenced by art::OutputModule::doBeginJob(), art::SharedFilter::setupQueues(), art::SharedProducer::setupQueues(), art::SharedAnalyzer::setupQueues(), art::EDFilter::setupQueues(), art::EDProducer::setupQueues(), and art::EDAnalyzer::setupQueues().

   {
     Exception e{errors::LogicError,
                 "An error occurred while processing scheduling options for a "
                 "module.\n"};
     if (asyncDeclared_) {
       if (empty(resourceNames_)) {
         return;
       }
       throw e
         << "async<art::InEvent>() cannot be called in combination with any "
            "serialize<art::InEvent>(...) calls.\n";
     }
 
     if (empty(resourceNames_)) {
       throw e << "Either 'async<art::InEvent>()' or "
                  "'serialize<art::InEvent>(...)'\n"
                  "must be called in a shared module's constructor.\n";
     }
     std::vector<std::string> const names(cbegin(resourceNames_),
                                          cend(resourceNames_));
     auto queues = resources.createQueues(names);
     chain_ = std::make_unique<SerialTaskQueueChain>(queues);
   }

void art::ResultsProducer::doBeginJob ( )

Definition at line 48 of file ResultsProducer.cc.

References breakpoints::beginJob().

   {
     // If results producers ever become eligible for multi-threaded
     // execution, the serial task queues will need to be setup here.
     beginJob();
   }

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

Definition at line 62 of file ResultsProducer.cc.

References art::RunPrincipal::makeRun().

   {
     ModuleContext const mc{moduleDescription()};
     beginRun(rp.makeRun(mc));
   }

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

Definition at line 76 of file ResultsProducer.cc.

References art::SubRunPrincipal::makeSubRun().

   {
     ModuleContext const mc{moduleDescription()};
     beginSubRun(srp.makeSubRun(mc));
   }

void art::ResultsProducer::doClear ( )

Definition at line 113 of file ResultsProducer.cc.

References clear().

   {
     clear();
   }

void art::ResultsProducer::doEndJob ( )

Definition at line 56 of file ResultsProducer.cc.

   {
     endJob();
   }

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

Definition at line 69 of file ResultsProducer.cc.

References art::RunPrincipal::makeRun().

   {
     ModuleContext const mc{moduleDescription()};
     endRun(rp.makeRun(mc));
   }

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

Definition at line 83 of file ResultsProducer.cc.

References art::SubRunPrincipal::makeSubRun().

   {
     ModuleContext const mc{moduleDescription()};
     endSubRun(srp.makeSubRun(mc));
   }

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

Definition at line 90 of file ResultsProducer.cc.

References art::EventPrincipal::makeEvent().

   {
     ModuleContext const mc{moduleDescription()};
     event(ep.makeEvent(mc));
   }

std::unique_ptr< Worker > art::ResultsProducer::doMakeWorker ( WorkerParams const & wp )

finalprivatevirtual

Implements art::ModuleBase.

Definition at line 27 of file ResultsProducer.cc.

References art::errors::LogicError.

   {
     throw Exception{errors::LogicError}
       << "Cannot call ResultsProducer::doMakeWorker\n";
   }

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

Definition at line 97 of file ResultsProducer.cc.

References art::ResultsPrincipal::makeResults().

   {
     ModuleContext const mc{moduleDescription()};
     readResults(resp.makeResults(mc));
   }

void art::ResultsProducer::doWriteResults ( ResultsPrincipal & resp )

Definition at line 104 of file ResultsProducer.cc.

References art::ResultsPrincipal::makeResults().

   {
     ModuleContext const mc{moduleDescription()};
     auto res = resp.makeResults(mc);
     writeResults(res);
     res.commitProducts();
   }

void art::ResultsProducer::endJob ( )

privatevirtual

Definition at line 128 of file ResultsProducer.cc.

129 {}

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

privatevirtual

Definition at line 136 of file ResultsProducer.cc.

137 {}

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

privatevirtual

Definition at line 144 of file ResultsProducer.cc.

145 {}

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

privatevirtual

Definition at line 148 of file ResultsProducer.cc.

149 {}

template<BranchType B>

TypeLabelLookup_t const & art::ProductRegistryHelper::expectedProducts ( ) const

inlineinherited

Definition at line 93 of file ProductRegistryHelper.h.

Referenced by art::ProductRegistryHelper::registerProducts().

   {
     return collector_.expectedProducts(B);
   }

void art::ProductRegistryHelper::fillDescriptions ( ModuleDescription const & md )

inherited

Definition at line 48 of file ProductRegistryHelper.cc.

References art::ProductRegistryHelper::collector_, and art::ProducesCollector::fillDescriptions().

Referenced by art::Modifier::fillProductDescriptions(), and art::ProductRegistryHelper::registerProducts().

   {
     collector_.fillDescriptions(md);
   }

std::array< std::vector< ProductInfo >, NumBranchTypes > const & art::ModuleBase::getConsumables ( ) const

inherited

Definition at line 43 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::getConsumables().

   {
     return collector_.getConsumables();
   }

std::unique_ptr< Worker > art::ModuleBase::makeWorker ( WorkerParams const & wp )

inherited

Definition at line 37 of file ModuleBase.cc.

References art::ModuleBase::doMakeWorker(), and art::NumBranchTypes.

   {
     return doMakeWorker(wp);
   }

template<typename T , BranchType BT>

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

protectedinherited

Definition at line 82 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsume().

   {
     return collector_.mayConsume<T, BT>(tag);
   }

template<typename T , BranchType BT>

void art::ModuleBase::mayConsumeMany ( )

protectedinherited

Definition at line 96 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeMany().

   {
     collector_.mayConsumeMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

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

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::mayConsumeView ( InputTag const & tag )

inherited

Definition at line 89 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeView().

   {
     return collector_.mayConsumeView<T, BT>(tag);
   }

ModuleDescription const & art::ModuleBase::moduleDescription ( ) const

inherited

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::registerProducts(), and art::OutputModule::registerProducts().

   {
     if (md_.has_value()) {
       return *md_;
     }
 
     throw Exception{errors::LogicError,
                     "There was an error while calling moduleDescription().\n"}
       << "The moduleDescription() base-class member function cannot be called\n"
          "during module construction.  To determine which module is "
          "responsible\n"
          "for calling it, find the '<module type>:<module "
          "label>@Construction'\n"
          "tag in the message prefix above.  Please contact artists@fnal.gov\n"
          "for guidance.\n";
   }

template<typename P , art::BranchType B>

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

inlineinherited

Definition at line 100 of file ProductRegistryHelper.h.

References art::errors::ProductRegistrationFailure, and art::reconstitutes.

Referenced by larg4::LArG4::LArG4(), trkf::PMAlgTrackMaker::PMAlgTrackMaker(), trkf::PMAlgTrajFitter::PMAlgTrajFitter(), and trkf::Track3DKalmanHit::Track3DKalmanHit().

   {
     if (mode_ == product_creation_mode::reconstitutes) {
       throw Exception{errors::ProductRegistrationFailure,
                       "An error occurred while registering a product.\n"}
         << "The following product was registered with 'produces' when\n"
            "'reconstitutes' should have been called instead.\n"
         << "  Branch type: " << B << '\n'
         << "  Class name: " << cet::demangle_symbol(typeid(P).name()) << '\n'
         << "  Instance name: '" << instanceName << "'\n";
     }
     collector_.produces<P, B>(instanceName, persistable);
   }

template<class P >

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

inlineprotected

Definition at line 150 of file ResultsProducer.h.

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

ProducesCollector& art::ProductRegistryHelper::producesCollector ( )

inlinenoexceptinherited

Definition at line 80 of file ProductRegistryHelper.h.

Referenced by apa::APAHitFinder::APAHitFinder(), artg4tk::artg4tkMain::artg4tkMain(), lar_cluster3d::Cluster3D::Cluster3D(), cluster::ClusterCrawler::ClusterCrawler(), CRHitRemoval::CRHitRemoval(), hit::DisambigCheater::DisambigCheater(), hit::DPRawHitFinder::DPRawHitFinder(), nnet::EmTrackClusterId::EmTrackClusterId(), nnet::EmTrackClusterId2out::EmTrackClusterId2out(), nnet::EmTrackClusterId2outTl::EmTrackClusterId2outTl(), nnet::EmTrackClusterId3outTl::EmTrackClusterId3outTl(), nnet::EmTrackMichelId::EmTrackMichelId(), nnet::EmTrackMichelIdTl::EmTrackMichelIdTl(), hit::FFTHitFinder::FFTHitFinder(), hit::GausHitFinder::GausHitFinder(), hit::HitCheater::HitCheater(), hit::HitFinder::HitFinder(), larg4::larg4Main::larg4Main(), reco::shower::LArPandoraModularShowerCreation::LArPandoraModularShowerCreation(), cluster::LineCluster::LineCluster(), art::MixFilter< T, IOPolicy >::MixFilter(), hit::RawHitFinder::RawHitFinder(), wcls::WireCellToolkit::reconfigure(), hit::RFFHitFinder::RFFHitFinder(), cluster::TrajCluster::TrajCluster(), and hit::TTHitFinder::TTHitFinder().

     {
       return collector_;
     }

void art::ProductRegistryHelper::productList ( std::unique_ptr< ProductList > p )

inlineinherited

Definition at line 52 of file ProductRegistryHelper.h.

References art::produces, art::reconstitutes, and art::Yes.

     {
       productList_ = std::move(p);
     }

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

privatevirtual

Definition at line 120 of file ResultsProducer.cc.

121 {}

template<typename P , BranchType B>

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

inherited

Definition at line 117 of file ProductRegistryHelper.h.

References art::produces, and art::errors::ProductRegistrationFailure.

Referenced by lris::LArRawInputDriver::LArRawInputDriver(), lris::LArRawInputDriverJP250L::LArRawInputDriverJP250L(), lris::LArRawInputDriverLongBo::LArRawInputDriverLongBo(), lris::LArRawInputDriverShortBo::LArRawInputDriverShortBo(), and fluxr::PPFXFluxReader::PPFXFluxReader().

   {
     if (mode_ == product_creation_mode::produces) {
       throw Exception{errors::ProductRegistrationFailure,
                       "An error occurred while registering a product.\n"}
         << "The following product was registered with 'reconstitutes' when\n"
            "'produces' should have been called instead.\n"
         << "  Branch type: " << B << '\n'
         << "  Class name: " << cet::demangle_symbol(typeid(P).name()) << '\n'
         << "  Emulated module name: '" << emulatedModule << "'\n"
         << "  Instance name: '" << instanceName << "'\n";
     }
     return collector_.reconstitutes<P, B>(emulatedModule, instanceName);
   }

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

Definition at line 40 of file ResultsProducer.cc.

   {
     ProductRegistryHelper::registerProducts(productsToProduce, md);
     setModuleDescription(md);
   }

template<BranchType BT = InEvent, typename... T>

void art::detail::SharedModule::serialize ( T const & ... )

protectedinherited

Referenced by simfilter::FilterSimPhotonLiteTime::FilterSimPhotonLiteTime(), simfilter::FilterSimPhotonTime::FilterSimPhotonTime(), art::detail::LegacyModule::LegacyModule(), and art::OutputModule::OutputModule().

template<BranchType , typename... T>

void art::detail::SharedModule::serialize ( T const &... resources )

inherited

Definition at line 83 of file SharedModule.h.

References art::detail::SharedModule::serialize_for_resource().

   {
     serialize_for_resource(resources...);
   }

template<BranchType BT = InEvent, typename... T>

void art::detail::SharedModule::serializeExternal ( T const & ... )

protectedinherited

Referenced by wcls::WireCellToolkit::WireCellToolkit().

template<BranchType , typename... T>

void art::detail::SharedModule::serializeExternal ( T const &... resources )

inherited

Definition at line 90 of file SharedModule.h.

References art::detail::SharedModule::serialize_for_external_resource().

   {
     serialize_for_external_resource(resources...);
   }

SerialTaskQueueChain * art::detail::SharedModule::serialTaskQueueChain ( ) const

inherited

Definition at line 22 of file SharedModule.cc.

References art::detail::SharedModule::chain_.

   {
     return chain_.get();
   }

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

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

std::set< std::string > const & art::detail::SharedModule::sharedResources ( ) const

inherited

Definition at line 28 of file SharedModule.cc.

References art::detail::SharedModule::resourceNames_.

   {
     return resourceNames_;
   }

void art::ModuleBase::sortConsumables ( std::string const & current_process_name )

inherited

Definition at line 49 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::sortConsumables().

   {
     // Now that we know we have seen all the consumes declarations,
     // sort the results for fast lookup later.
     collector_.sortConsumables(current_process_name);
   }

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

privatepure virtual

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

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

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation