#include "EDAnalyzer.h"

Inheritance diagram for art::EDAnalyzer:

Public Types
using	ModuleType = EDAnalyzer

Public Member Functions
void	doBeginJob (SharedResources const &resources)

void	doEndJob ()

void	doRespondToOpenInputFile (FileBlock const &fb)

void	doRespondToCloseInputFile (FileBlock const &fb)

void	doRespondToOpenOutputFiles (FileBlock const &fb)

void	doRespondToCloseOutputFiles (FileBlock const &fb)

bool	doBeginRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)

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
	EDAnalyzer (fhicl::ParameterSet const &pset)

template<typename Config >
	EDAnalyzer (Table< Config > const &config)

std::string const &	processName () const

bool	wantAllEvents () const noexcept

bool	wantEvent (ScheduleID id, Event const &e) const

Handle< TriggerResults >	getTriggerResults (Event const &e) const

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 Types
using	base_engine_t = EngineCreator::base_engine_t

using	seed_t = EngineCreator::seed_t

using	label_t = EngineCreator::label_t

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

void	setupQueues (detail::SharedResources const &) final

void	beginJobWithFrame (ProcessingFrame const &) final

void	endJobWithFrame (ProcessingFrame const &) final

void	respondToOpenInputFileWithFrame (FileBlock const &, ProcessingFrame const &) final

void	respondToCloseInputFileWithFrame (FileBlock const &, ProcessingFrame const &) final

void	respondToOpenOutputFilesWithFrame (FileBlock const &, ProcessingFrame const &) final

void	respondToCloseOutputFilesWithFrame (FileBlock const &, ProcessingFrame const &) final

void	beginRunWithFrame (Run const &, ProcessingFrame const &) final

void	endRunWithFrame (Run const &, ProcessingFrame const &) final

void	beginSubRunWithFrame (SubRun const &, ProcessingFrame const &) final

void	endSubRunWithFrame (SubRun const &, ProcessingFrame const &) final

void	analyzeWithFrame (Event const &, ProcessingFrame const &) final

virtual void	beginJob ()

virtual void	endJob ()

virtual void	respondToOpenInputFile (FileBlock const &)

virtual void	respondToCloseInputFile (FileBlock const &)

virtual void	respondToOpenOutputFiles (FileBlock const &)

virtual void	respondToCloseOutputFiles (FileBlock const &)

virtual void	beginRun (Run const &)

virtual void	endRun (Run const &)

virtual void	beginSubRun (SubRun const &)

virtual void	endSubRun (SubRun const &)

virtual void	analyze (Event const &)=0

ScheduleID	scheduleID () const noexcept

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 ()

Detailed Description

Definition at line 20 of file EDAnalyzer.h.

Member Typedef Documentation

using art::detail::LegacyModule::base_engine_t = EngineCreator::base_engine_t

inherited

Definition at line 19 of file LegacyModule.h.

using art::detail::LegacyModule::label_t = EngineCreator::label_t

inherited

Definition at line 21 of file LegacyModule.h.

using art::EDAnalyzer::ModuleType = EDAnalyzer

Definition at line 22 of file EDAnalyzer.h.

using art::detail::LegacyModule::seed_t = EngineCreator::seed_t

inherited

Definition at line 20 of file LegacyModule.h.

Constructor & Destructor Documentation

art::EDAnalyzer::EDAnalyzer ( fhicl::ParameterSet const & pset )

explicitprotected

Definition at line 6 of file EDAnalyzer.cc.

Referenced by opdet::SimPhotonCounter::isVisible().

7 : Analyzer{pset}, LegacyModule{pset.get<std::string>("module_label")}

8 {}

art::detail::LegacyModule::LegacyModule

LegacyModule(std::string const &module_label)

Definition: LegacyModule.cc:5

art::detail::Analyzer::Analyzer

Analyzer(fhicl::ParameterSet const &pset)

Definition: Analyzer.cc:22

template<typename Config >

art::EDAnalyzer::EDAnalyzer ( Table< Config > const & config )

inlineexplicitprotected

Definition at line 31 of file EDAnalyzer.h.

References analyze(), analyzeWithFrame(), beginJob(), beginJobWithFrame(), beginRun(), beginRunWithFrame(), beginSubRun(), beginSubRunWithFrame(), art::detail::EngineCreator::createEngine(), doMakeWorker(), endJob(), endJobWithFrame(), endRun(), endRunWithFrame(), endSubRun(), endSubRunWithFrame(), art::detail::Analyzer::Table< UserConfig, UserKeysToIgnore >::get_PSet(), respondToCloseInputFile(), respondToCloseInputFileWithFrame(), respondToCloseOutputFiles(), respondToCloseOutputFilesWithFrame(), respondToOpenInputFile(), respondToOpenInputFileWithFrame(), respondToOpenOutputFiles(), respondToOpenOutputFilesWithFrame(), art::detail::LegacyModule::scheduleID(), and setupQueues().

32 : EDAnalyzer{config.get_PSet()}

33 {}

art::EDAnalyzer::EDAnalyzer

EDAnalyzer(fhicl::ParameterSet const &pset)

Definition: EDAnalyzer.cc:6

Member Function Documentation

virtual void art::EDAnalyzer::analyze ( Event const & )

privatepure virtual

Implemented in ClusteringValidation::ClusteringValidation, ems::MultiEMShowers, sim::DumpSimPhotons, evg::GenieOutput, sim::POTaccumulator, nnet::RawWaveformClnSigDump, geo::DumpChannelMap, detsim::DumpRawDigits, caldata::DumpWires, sim::DumpMCShowers, nnet::PointIdEffTest, sim::DumpSimEnergyDeposits, nnet::RawWaveformDump, sim::DumpMCTracks, sim::DumpMCParticles, sim::DumpGTruth, opdet::SimPhotonCounter, sim::DumpMCTruth, recob::DumpChargedSpacePoints, geo::DumpGeometry, lar::example::Exploder, sim::DumpSimPhotonsLite, sim::DumpOpDetBacktrackerRecords, NuShowerEff, sim::DumpSimChannels, RecoProxyUsageExample, nnet::EvaluateROIEff, nnet::NoiseWaveformDump, nnet::WaveformDenoiseTest, rwgt::ReweightAna, cluster::ClusterTrackAna, cheat::RecoCheckAna, hit::HitAnaModule, cluster::ClusterPCA, pdsp::CheckCNNScore, ShowerQuality, opdet::FlashHypothesisAna, opdet::PhotonInf, NuGraphAnalyzer, larg4::ISCalcAna, evd::EVD, trk::TrackContainmentAnalyzer, pid::PIDAAnalyzer, lar_pandora::LArPandoraEventDump, MCBTDemo, opdet::OpFlashSimpleAna, detsim::SimDriftedElectronClusterAna, calo::PrintCalorimetry, cheat::CheckBackTracking, dnn::SaveImageH5, and hit::MCHitAnaExample.

Referenced by analyzeWithFrame(), and EDAnalyzer().

void art::EDAnalyzer::analyzeWithFrame	(	Event const &	e,
		ProcessingFrame const &	frame
	)

finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 87 of file EDAnalyzer.cc.

References analyze(), and art::ProcessingFrame::scheduleID().

Referenced by EDAnalyzer().

   {
     ScheduleIDSentry sentry{*this, frame.scheduleID()};
     analyze(e);
   }

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::EDAnalyzer::beginJob ( )

privatevirtual

Reimplemented in ClusteringValidation::ClusteringValidation, lar::example::AnalysisExample, ems::MultiEMShowers, nnet::PointIdTrainingData, nnet::RawWaveformClnSigDump, nnet::RawWaveformDump, detsim::DumpRawDigits, nnet::PointIdEffTest, opdet::SimPhotonCounter, geo::DumpGeometry, NuShowerEff, nnet::EvaluateROIEff, nnet::NoiseWaveformDump, nnet::WaveformDenoiseTest, lcvn::LArNuCVNZlibMaker, lcvn::ICVNZlibMaker, rwgt::ReweightAna, DUNE::MuonTrackingEff, DUNE::NeutrinoTrackingEff, hit::HitFinderAna, cluster::DBclusterAna, hit::HitAnaModule, hit::GausHitFinderAna, pdsp::CheckCNNScore, opdet::FlashHypothesisAna, caldata::CalWireAna, cluster::ClusterAna, cluster::ClusterPCA, ShowerQuality, pfpf::PFPAna, opreco::OpticalRecoAna, opdet::PhotonInf, artg4tk::CheckDRCalorimeterHits, artg4tk::CheckProtonProduction, artg4tk::CheckTrackerHits, microboone::CosmicRemovalAna, cluster::HoughLineFinderAna, vertex::FeatureVertexFinderAna, artg4tk::CheckInteractions, larg4::ISCalcAna, artg4tk::CheckGenParticle, artg4tk::CheckHits, artg4tk::CheckPhotonHits, detsim::WienerFilterAna, larg4::LArG4Ana, evd::EVD, DUNE::NeutrinoShowerEff, detsim::SimWireAna, pid::PIDAAnalyzer, shower::TCShowerElectronLikelihood, shower::TCShowerTemplateMaker, vertex::AggregateVertexAna, detsim::SimDriftedElectronClusterAna, opdet::OpFlashSimpleAna, artg4tk::CheckCalorimeterHits, larg4::CheckMCParticle, lar_pandora::PFParticleHitDumper, dnn::SaveImageH5, lar_pandora::PFParticleAnalysis, lar_pandora::PFParticleMonitoring, shower::TCShowerAnalysis, lar_pandora::PFParticleCosmicAna, lar_pandora::PFParticleValidation, phot::PhotonLibraryAnalyzer, lar_pandora::PFParticleTrackAna, larg4::CheckAuxDetHit, and larg4::CheckSimEnergyDeposit.

Definition at line 95 of file EDAnalyzer.cc.

Referenced by beginJobWithFrame(), and EDAnalyzer().

96 {}

void art::EDAnalyzer::beginJobWithFrame ( ProcessingFrame const & )

finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 51 of file EDAnalyzer.cc.

References beginJob().

Referenced by EDAnalyzer().

   {
     beginJob();
   }

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

privatevirtual

Reimplemented in geo::DumpChannelMap, geo::DumpGeometry, NuShowerEff, and cheat::RecoCheckAna.

Definition at line 119 of file EDAnalyzer.cc.

Referenced by beginRunWithFrame(), and EDAnalyzer().

120 {}

void art::EDAnalyzer::beginRunWithFrame	(	Run const &	r,
		ProcessingFrame const &
	)

finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 63 of file EDAnalyzer.cc.

References beginRun().

Referenced by EDAnalyzer().

   {
     beginRun(r);
   }

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

privatevirtual

Reimplemented in rwgt::ReweightAna.

Definition at line 127 of file EDAnalyzer.cc.

Referenced by beginSubRunWithFrame(), and EDAnalyzer().

128 {}

void art::EDAnalyzer::beginSubRunWithFrame	(	SubRun const &	sr,
		ProcessingFrame const &
	)

finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 75 of file EDAnalyzer.cc.

References beginSubRun().

Referenced by EDAnalyzer().

   {
     beginSubRun(sr);
   }

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::EDFilter::setupQueues(), art::SharedAnalyzer::setupQueues(), art::EDProducer::setupQueues(), and 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::detail::Analyzer::doBeginJob ( SharedResources const & resources )

inherited

Definition at line 25 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     setupQueues(resources);
     ProcessingFrame const frame{ScheduleID{}};
     beginJobWithFrame(frame);
   }

bool art::detail::Analyzer::doBeginRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 68 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     beginRunWithFrame(std::as_const(rp).makeRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doBeginSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 84 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     beginSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
     return true;
   }

void art::detail::Analyzer::doEndJob ( )

inherited

Definition at line 33 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     endJobWithFrame(frame);
   }

bool art::detail::Analyzer::doEndRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 76 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     endRunWithFrame(std::as_const(rp).makeRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doEndSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 92 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     endSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doEvent	(	EventPrincipal &	ep,
		ModuleContext const &	mc,
		std::atomic< std::size_t > &	counts_run,
		std::atomic< std::size_t > &	counts_passed,
		std::atomic< std::size_t > &	counts_failed
	)

inherited

Definition at line 100 of file Analyzer.cc.

References e, and art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     auto const e = std::as_const(ep).makeEvent(mc);
     if (wantEvent(mc.scheduleID(), e)) {
       ++counts_run;
       ProcessingFrame const frame{mc.scheduleID()};
       analyzeWithFrame(e, frame);
       ++counts_passed;
     }
     return true;
   }

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

finalprivatevirtual

Implements art::ModuleBase.

Definition at line 11 of file EDAnalyzer.cc.

Referenced by EDAnalyzer().

   {
     return std::make_unique<WorkerT<EDAnalyzer>>(this, wp);
   }

void art::detail::Analyzer::doRespondToCloseInputFile ( FileBlock const & fb )

inherited

Definition at line 47 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseInputFileWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToCloseOutputFiles ( FileBlock const & fb )

inherited

Definition at line 61 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseOutputFilesWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToOpenInputFile ( FileBlock const & fb )

inherited

Definition at line 40 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenInputFileWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToOpenOutputFiles ( FileBlock const & fb )

inherited

Definition at line 54 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenOutputFilesWithFrame(fb, frame);
   }

void art::EDAnalyzer::endJob ( )

privatevirtual

Reimplemented in ClusteringValidation::ClusteringValidation, trkf::TrackAna, trkf::SeedAna, ems::MultiEMShowers, nnet::PointIdTrainingData, sim::POTaccumulator, nnet::RawWaveformClnSigDump, nnet::RawWaveformDump, nnet::PointIdEffTest, sim::DumpMCParticles, opdet::SimPhotonCounter, NuShowerEff, nnet::EvaluateROIEff, nnet::NoiseWaveformDump, nnet::WaveformDenoiseTest, wc::CellTree, rwgt::ReweightAna, cluster::ClusterTrackAna, DUNE::MuonTrackingEff, DUNE::NeutrinoTrackingEff, caldata::CalWireAna, cluster::ClusterAna, artg4tk::CheckProtonProduction, opdet::PhotonInf, hit::MagDriftAna, artg4tk::CheckInteractions, artg4tk::CheckGenParticle, opdet::LEDCalibrationAna, larg4::ISCalcAna, artg4tk::CheckPhotonHits, detsim::WienerFilterAna, DUNE::NeutrinoShowerEff, lar_pandora::PFParticleHitDumper, lar_pandora::PFParticleAnalysis, lar_pandora::PFParticleMonitoring, lar_pandora::PFParticleCosmicAna, lar_pandora::PFParticleValidation, and lar_pandora::PFParticleTrackAna.

Definition at line 99 of file EDAnalyzer.cc.

Referenced by EDAnalyzer(), and endJobWithFrame().

100 {}

void art::EDAnalyzer::endJobWithFrame ( ProcessingFrame const & )

finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 57 of file EDAnalyzer.cc.

References endJob().

Referenced by EDAnalyzer().

   {
     endJob();
   }

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

privatevirtual

Definition at line 123 of file EDAnalyzer.cc.

Referenced by EDAnalyzer(), and endRunWithFrame().

124 {}

void art::EDAnalyzer::endRunWithFrame	(	Run const &	r,
		ProcessingFrame const &
	)

finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 69 of file EDAnalyzer.cc.

References endRun().

Referenced by EDAnalyzer().

   {
     endRun(r);
   }

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

privatevirtual

Reimplemented in sim::POTaccumulator, lcvn::LArNuCVNZlibMaker, and rwgt::ReweightAna.

Definition at line 131 of file EDAnalyzer.cc.

Referenced by EDAnalyzer(), and endSubRunWithFrame().

132 {}

void art::EDAnalyzer::endSubRunWithFrame	(	SubRun const &	sr,
		ProcessingFrame const &
	)

finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 81 of file EDAnalyzer.cc.

References endSubRun().

Referenced by EDAnalyzer().

   {
     endSubRun(sr);
   }

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();
   }

Handle< TriggerResults > art::Observer::getTriggerResults ( Event const & e ) const

protectedinherited

Definition at line 75 of file Observer.cc.

References art::ProductRetriever::get(), and art::Observer::selectors_.

Referenced by art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (selectors_) {
       return selectors_->getOneTriggerResults(e);
     }
 
     // The following applies for cases where no SelectEvents entries
     // exist.
     Handle<TriggerResults> h;
     if (e.get(empty_process_name, h)) {
       return h;
     }
     return Handle<TriggerResults>{};
   }

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";
   }

string const & art::Observer::processName ( ) const

protectedinherited

Definition at line 57 of file Observer.cc.

References art::Observer::process_name_.

Referenced by art::FileDumperOutput::printPrincipal().

   {
     return process_name_;
   }

void art::EDAnalyzer::respondToCloseInputFile ( FileBlock const & )

privatevirtual

Definition at line 107 of file EDAnalyzer.cc.

Referenced by EDAnalyzer(), and respondToCloseInputFileWithFrame().

108 {}

void art::EDAnalyzer::respondToCloseInputFileWithFrame	(	FileBlock const &	fb,
		ProcessingFrame const &
	)

finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 30 of file EDAnalyzer.cc.

References respondToCloseInputFile().

Referenced by EDAnalyzer().

   {
     respondToCloseInputFile(fb);
   }

void art::EDAnalyzer::respondToCloseOutputFiles ( FileBlock const & )

privatevirtual

Definition at line 115 of file EDAnalyzer.cc.

Referenced by EDAnalyzer(), and respondToCloseOutputFilesWithFrame().

116 {}

void art::EDAnalyzer::respondToCloseOutputFilesWithFrame	(	FileBlock const &	fb,
		ProcessingFrame const &
	)

finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 44 of file EDAnalyzer.cc.

References respondToCloseOutputFiles().

Referenced by EDAnalyzer().

   {
     respondToCloseOutputFiles(fb);
   }

void art::EDAnalyzer::respondToOpenInputFile ( FileBlock const & )

privatevirtual

Definition at line 103 of file EDAnalyzer.cc.

Referenced by EDAnalyzer(), and respondToOpenInputFileWithFrame().

104 {}

void art::EDAnalyzer::respondToOpenInputFileWithFrame	(	FileBlock const &	fb,
		ProcessingFrame const &
	)

finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 23 of file EDAnalyzer.cc.

References respondToOpenInputFile().

Referenced by EDAnalyzer().

   {
     respondToOpenInputFile(fb);
   }

void art::EDAnalyzer::respondToOpenOutputFiles ( FileBlock const & )

privatevirtual

Definition at line 111 of file EDAnalyzer.cc.

Referenced by EDAnalyzer(), and respondToOpenOutputFilesWithFrame().

112 {}

void art::EDAnalyzer::respondToOpenOutputFilesWithFrame	(	FileBlock const &	fb,
		ProcessingFrame const &
	)

finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 37 of file EDAnalyzer.cc.

References respondToOpenOutputFiles().

Referenced by EDAnalyzer().

   {
     respondToOpenOutputFiles(fb);
   }

ScheduleID art::detail::LegacyModule::scheduleID ( ) const

noexceptinherited

Definition at line 12 of file LegacyModule.cc.

References art::detail::LegacyModule::scheduleID_.

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

   {
     return scheduleID_.load();
   }

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;
   }

void art::EDAnalyzer::setupQueues ( detail::SharedResources const & resources )

finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 17 of file EDAnalyzer.cc.

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

Referenced by EDAnalyzer().

   {
     createQueues(resources);
   }

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);
   }

bool art::Observer::wantAllEvents ( ) const

inlineprotectednoexceptinherited

Definition at line 31 of file Observer.h.

References e, art::Observer::getTriggerResults(), art::Observer::wantAllEvents_, and art::Observer::wantEvent().

     {
       return wantAllEvents_;
     }

bool art::Observer::wantEvent	(	ScheduleID	id,
		Event const &	e
	)		const

protectedinherited

Definition at line 63 of file Observer.cc.

References art::Observer::rejectors_, art::Observer::selectors_, and art::Observer::wantAllEvents_.

Referenced by art::OutputModule::doEvent(), art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (wantAllEvents_) {
       return true;
     }
     bool const select_event = selectors_ ? selectors_->matchEvent(id, e) : true;
     bool const reject_event =
       rejectors_ ? rejectors_->matchEvent(id, e) : false;
     return select_event and not reject_event;
   }

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

art/Framework/Core/EDAnalyzer.h
art/Framework/Core/EDAnalyzer.cc

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation