LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
art::ReplicatedAnalyzer Class Referenceabstract

#include "ReplicatedAnalyzer.h"

Inheritance diagram for art::ReplicatedAnalyzer:
art::detail::Analyzer art::detail::EngineCreator art::Observer art::ModuleBase

Public Types

using ModuleType = ReplicatedAnalyzer
 

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

 ReplicatedAnalyzer (fhicl::ParameterSet const &pset, ProcessingFrame const &frame)
 
template<typename Config >
 ReplicatedAnalyzer (Table< Config > const &config, ProcessingFrame const &frame)
 
std::string const & processName () const
 
bool wantAllEvents () const noexcept
 
bool wantEvent (ScheduleID id, Event const &e) const
 
Handle< TriggerResultsgetTriggerResults (Event const &e) const
 
ConsumesCollectorconsumesCollector ()
 
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 = CLHEP::HepRandomEngine
 
using label_t = RNGsnapshot::label_t
 
using seed_t = long
 
using engine_state_t = RNGsnapshot::engine_state_t
 

Private Member Functions

std::unique_ptr< WorkerdoMakeWorker (WorkerParams const &wp) final
 
void setupQueues (detail::SharedResources const &resources) 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 (ProcessingFrame const &)
 
virtual void endJob (ProcessingFrame const &)
 
virtual void respondToOpenInputFile (FileBlock const &, ProcessingFrame const &)
 
virtual void respondToCloseInputFile (FileBlock const &, ProcessingFrame const &)
 
virtual void respondToOpenOutputFiles (FileBlock const &, ProcessingFrame const &)
 
virtual void respondToCloseOutputFiles (FileBlock const &, ProcessingFrame const &)
 
virtual void beginRun (Run const &, ProcessingFrame const &)
 
virtual void endRun (Run const &, ProcessingFrame const &)
 
virtual void beginSubRun (SubRun const &, ProcessingFrame const &)
 
virtual void endSubRun (SubRun const &, ProcessingFrame const &)
 
virtual void analyze (Event const &, ProcessingFrame const &)=0
 
base_engine_tcreateEngine (seed_t seed)
 
base_engine_tcreateEngine (seed_t seed, std::string const &kind_of_engine_to_make)
 
base_engine_tcreateEngine (seed_t seed, std::string const &kind_of_engine_to_make, label_t const &engine_label)
 

Detailed Description

Definition at line 22 of file ReplicatedAnalyzer.h.

Member Typedef Documentation

using art::detail::EngineCreator::base_engine_t = CLHEP::HepRandomEngine
inherited

Definition at line 36 of file EngineCreator.h.

Definition at line 37 of file EngineCreator.h.

using art::detail::EngineCreator::seed_t = long
inherited

Definition at line 38 of file EngineCreator.h.

Constructor & Destructor Documentation

art::ReplicatedAnalyzer::ReplicatedAnalyzer ( fhicl::ParameterSet const &  pset,
ProcessingFrame const &  frame 
)
explicitprotected

Definition at line 6 of file ReplicatedAnalyzer.cc.

8  : Analyzer{pset}
9  , EngineCreator{pset.get<std::string>("module_label"), frame.scheduleID()}
10  {}
EngineCreator(std::string const &label, ScheduleID sid)
Analyzer(fhicl::ParameterSet const &pset)
Definition: Analyzer.cc:22

Member Function Documentation

virtual void art::ReplicatedAnalyzer::analyze ( Event const &  ,
ProcessingFrame const &   
)
privatepure virtual
void art::ReplicatedAnalyzer::analyzeWithFrame ( Event const &  e,
ProcessingFrame const &  frame 
)
finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 97 of file ReplicatedAnalyzer.cc.

References analyze().

Referenced by ReplicatedAnalyzer().

99  {
100  analyze(e, frame);
101  }
virtual void analyze(Event const &, ProcessingFrame const &)=0
Float_t e
Definition: plot.C:35
void art::ReplicatedAnalyzer::beginJob ( ProcessingFrame const &  )
privatevirtual

Definition at line 104 of file ReplicatedAnalyzer.cc.

Referenced by beginJobWithFrame(), and ReplicatedAnalyzer().

105  {}
void art::ReplicatedAnalyzer::beginJobWithFrame ( ProcessingFrame const &  frame)
finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 57 of file ReplicatedAnalyzer.cc.

References beginJob().

Referenced by ReplicatedAnalyzer().

58  {
59  beginJob(frame);
60  }
virtual void beginJob(ProcessingFrame const &)
void art::ReplicatedAnalyzer::beginRun ( Run const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 132 of file ReplicatedAnalyzer.cc.

Referenced by beginRunWithFrame(), and ReplicatedAnalyzer().

133  {}
void art::ReplicatedAnalyzer::beginRunWithFrame ( Run const &  r,
ProcessingFrame const &  frame 
)
finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 69 of file ReplicatedAnalyzer.cc.

References beginRun().

Referenced by ReplicatedAnalyzer().

71  {
72  beginRun(r, frame);
73  }
TRandom r
Definition: spectrum.C:23
virtual void beginRun(Run const &, ProcessingFrame const &)
void art::ReplicatedAnalyzer::beginSubRun ( SubRun const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 140 of file ReplicatedAnalyzer.cc.

Referenced by beginSubRunWithFrame(), and ReplicatedAnalyzer().

141  {}
void art::ReplicatedAnalyzer::beginSubRunWithFrame ( SubRun const &  sr,
ProcessingFrame const &  frame 
)
finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 83 of file ReplicatedAnalyzer.cc.

References beginSubRun().

Referenced by ReplicatedAnalyzer().

85  {
86  beginSubRun(sr, frame);
87  }
virtual void beginSubRun(SubRun const &, ProcessingFrame const &)
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().

62  {
63  return collector_.consumes<T, BT>(tag);
64  }
ConsumesCollector collector_
Definition: ModuleBase.h:56
ProductToken< T > consumes(InputTag const &)
ConsumesCollector & art::ModuleBase::consumesCollector ( )
protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

58  {
59  return collector_;
60  }
ConsumesCollector collector_
Definition: ModuleBase.h:56
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().

76  {
77  collector_.consumesMany<T, BT>();
78  }
ConsumesCollector collector_
Definition: ModuleBase.h:56
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().

69  {
70  return collector_.consumesView<T, BT>(tag);
71  }
ConsumesCollector collector_
Definition: ModuleBase.h:56
ViewToken< Element > consumesView(InputTag const &)
EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t  seed)
inherited

Definition at line 20 of file EngineCreator.cc.

References art::detail::EngineCreator::rng().

Referenced by evg::AddGenieEventsToArt::AddGenieEventsToArt(), artg4tk::artg4tkMain::artg4tkMain(), evgen::BaseRadioGen::BaseRadioGen(), evgen::CORSIKAGen::CORSIKAGen(), evgen::CosmicsGen::CosmicsGen(), art::MixHelper::createEngine(), detsim::DriftElectronstoPlane::DriftElectronstoPlane(), art::EDAnalyzer::EDAnalyzer(), art::EDFilter::EDFilter(), art::EDProducer::EDProducer(), artg4tk::EventGenerator::EventGenerator(), evwgh::EventWeight::EventWeight(), evgen::GaisserParam::GaisserParam(), cluster::HoughLineFinder::HoughLineFinder(), art::MixHelper::initEngine_(), larg4::IonAndScint::IonAndScint(), larg4::ISCalcAna::ISCalcAna(), larg4::LArG4::LArG4(), larg4::larg4Main::larg4Main(), evgen::larg4SingleGen::larg4SingleGen(), evgen::LightSource::LightSource(), evgen::MUSUN::MUSUN(), evgen::NDKGen::NDKGen(), evgen::NeutronOsc::NeutronOsc(), nnet::NoiseWaveformDump::NoiseWaveformDump(), evgen::NucleonDecay::NucleonDecay(), opdet::OpMCDigi::OpMCDigi(), opdet::OptDetDigitizer::OptDetDigitizer(), phot::PDFastSimANN::PDFastSimANN(), phot::PDFastSimPAR::PDFastSimPAR(), phot::PDFastSimPVS::PDFastSimPVS(), evgen::PhotonGen::PhotonGen(), phot::PhotonLibraryPropagation::PhotonLibraryPropagation(), evgen::RadioGen::RadioGen(), nnet::RawWaveformClnSigDump::RawWaveformClnSigDump(), nnet::RawWaveformDump::RawWaveformDump(), ReplicatedAnalyzer(), art::ReplicatedFilter::ReplicatedFilter(), art::ReplicatedProducer::ReplicatedProducer(), detsim::SimDriftElectrons::SimDriftElectrons(), detsim::SimWire::SimWire(), evgen::SingleGen::SingleGen(), evgen::SNNueAr40CCGen::SNNueAr40CCGen(), and trkf::Track3DKalman::Track3DKalman().

21 {
22  return createEngine(seed, rng()->defaultEngineKind());
23 }
base_engine_t & createEngine(seed_t seed)
long seed
Definition: chem4.cc:67
static ServiceHandle< RandomNumberGenerator > & rng()
EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t  seed,
std::string const &  kind_of_engine_to_make 
)
inherited

Definition at line 26 of file EngineCreator.cc.

References art::detail::EngineCreator::moduleLabel_, art::detail::EngineCreator::requireValid(), art::detail::EngineCreator::rng(), and art::detail::EngineCreator::sid_.

28 {
29  requireValid();
30  return rng()->createEngine(sid_, moduleLabel_, seed, kind_of_engine_to_make);
31 }
long seed
Definition: chem4.cc:67
std::string const moduleLabel_
Definition: EngineCreator.h:53
static ServiceHandle< RandomNumberGenerator > & rng()
EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t  seed,
std::string const &  kind_of_engine_to_make,
label_t const &  engine_label 
)
inherited

Definition at line 34 of file EngineCreator.cc.

References art::detail::EngineCreator::moduleLabel_, art::detail::EngineCreator::requireValid(), art::detail::EngineCreator::rng(), and art::detail::EngineCreator::sid_.

37 {
38  requireValid();
39  return rng()->createEngine(
40  sid_, moduleLabel_, seed, kind_of_engine_to_make, engine_label);
41 }
long seed
Definition: chem4.cc:67
std::string const moduleLabel_
Definition: EngineCreator.h:53
static ServiceHandle< RandomNumberGenerator > & rng()
void art::detail::Analyzer::doBeginJob ( SharedResources const &  resources)
inherited

Definition at line 25 of file Analyzer.cc.

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

26  {
27  setupQueues(resources);
28  ProcessingFrame const frame{ScheduleID{}};
29  beginJobWithFrame(frame);
30  }
virtual void beginJobWithFrame(ProcessingFrame const &)=0
virtual void setupQueues(SharedResources const &)=0
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().

69  {
70  ProcessingFrame const frame{mc.scheduleID()};
71  beginRunWithFrame(std::as_const(rp).makeRun(mc), frame);
72  return true;
73  }
virtual void beginRunWithFrame(Run const &, ProcessingFrame const &)=0
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().

85  {
86  ProcessingFrame const frame{mc.scheduleID()};
87  beginSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
88  return true;
89  }
virtual void beginSubRunWithFrame(SubRun const &, ProcessingFrame const &)=0
void art::detail::Analyzer::doEndJob ( )
inherited

Definition at line 33 of file Analyzer.cc.

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

34  {
35  ProcessingFrame const frame{ScheduleID{}};
36  endJobWithFrame(frame);
37  }
virtual void endJobWithFrame(ProcessingFrame const &)=0
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().

77  {
78  ProcessingFrame const frame{mc.scheduleID()};
79  endRunWithFrame(std::as_const(rp).makeRun(mc), frame);
80  return true;
81  }
virtual void endRunWithFrame(Run const &, ProcessingFrame const &)=0
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().

93  {
94  ProcessingFrame const frame{mc.scheduleID()};
95  endSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
96  return true;
97  }
virtual void endSubRunWithFrame(SubRun const &, ProcessingFrame const &)=0
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().

105  {
106  auto const e = std::as_const(ep).makeEvent(mc);
107  if (wantEvent(mc.scheduleID(), e)) {
108  ++counts_run;
109  ProcessingFrame const frame{mc.scheduleID()};
110  analyzeWithFrame(e, frame);
111  ++counts_passed;
112  }
113  return true;
114  }
bool wantEvent(ScheduleID id, Event const &e) const
Definition: Observer.cc:63
Float_t e
Definition: plot.C:35
virtual void analyzeWithFrame(Event const &, ProcessingFrame const &)=0
std::unique_ptr< Worker > art::ReplicatedAnalyzer::doMakeWorker ( WorkerParams const &  wp)
finalprivatevirtual

Implements art::ModuleBase.

Definition at line 13 of file ReplicatedAnalyzer.cc.

Referenced by ReplicatedAnalyzer().

14  {
15  return std::make_unique<WorkerT<ReplicatedAnalyzer>>(this, wp);
16  }
void art::detail::Analyzer::doRespondToCloseInputFile ( FileBlock const &  fb)
inherited

Definition at line 47 of file Analyzer.cc.

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

48  {
49  ProcessingFrame const frame{ScheduleID{}};
51  }
TFile fb("Li6.root")
virtual void respondToCloseInputFileWithFrame(FileBlock const &, ProcessingFrame const &)=0
void art::detail::Analyzer::doRespondToCloseOutputFiles ( FileBlock const &  fb)
inherited

Definition at line 61 of file Analyzer.cc.

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

62  {
63  ProcessingFrame const frame{ScheduleID{}};
65  }
virtual void respondToCloseOutputFilesWithFrame(FileBlock const &, ProcessingFrame const &)=0
TFile fb("Li6.root")
void art::detail::Analyzer::doRespondToOpenInputFile ( FileBlock const &  fb)
inherited

Definition at line 40 of file Analyzer.cc.

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

41  {
42  ProcessingFrame const frame{ScheduleID{}};
44  }
TFile fb("Li6.root")
virtual void respondToOpenInputFileWithFrame(FileBlock const &, ProcessingFrame const &)=0
void art::detail::Analyzer::doRespondToOpenOutputFiles ( FileBlock const &  fb)
inherited

Definition at line 54 of file Analyzer.cc.

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

55  {
56  ProcessingFrame const frame{ScheduleID{}};
58  }
virtual void respondToOpenOutputFilesWithFrame(FileBlock const &, ProcessingFrame const &)=0
TFile fb("Li6.root")
void art::ReplicatedAnalyzer::endJob ( ProcessingFrame const &  )
privatevirtual

Definition at line 108 of file ReplicatedAnalyzer.cc.

Referenced by endJobWithFrame(), and ReplicatedAnalyzer().

109  {}
void art::ReplicatedAnalyzer::endJobWithFrame ( ProcessingFrame const &  frame)
finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 63 of file ReplicatedAnalyzer.cc.

References endJob().

Referenced by ReplicatedAnalyzer().

64  {
65  endJob(frame);
66  }
virtual void endJob(ProcessingFrame const &)
void art::ReplicatedAnalyzer::endRun ( Run const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 136 of file ReplicatedAnalyzer.cc.

Referenced by endRunWithFrame(), and ReplicatedAnalyzer().

137  {}
void art::ReplicatedAnalyzer::endRunWithFrame ( Run const &  r,
ProcessingFrame const &  frame 
)
finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 76 of file ReplicatedAnalyzer.cc.

References endRun().

Referenced by ReplicatedAnalyzer().

78  {
79  endRun(r, frame);
80  }
TRandom r
Definition: spectrum.C:23
virtual void endRun(Run const &, ProcessingFrame const &)
void art::ReplicatedAnalyzer::endSubRun ( SubRun const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 144 of file ReplicatedAnalyzer.cc.

Referenced by endSubRunWithFrame(), and ReplicatedAnalyzer().

145  {}
void art::ReplicatedAnalyzer::endSubRunWithFrame ( SubRun const &  sr,
ProcessingFrame const &  frame 
)
finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 90 of file ReplicatedAnalyzer.cc.

References endSubRun().

Referenced by ReplicatedAnalyzer().

92  {
93  endSubRun(sr, frame);
94  }
virtual void endSubRun(SubRun const &, ProcessingFrame const &)
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().

44  {
45  return collector_.getConsumables();
46  }
ConsumesCollector collector_
Definition: ModuleBase.h:56
std::array< std::vector< ProductInfo >, NumBranchTypes > const & getConsumables() const
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().

76  {
77  if (selectors_) {
78  return selectors_->getOneTriggerResults(e);
79  }
80 
81  // The following applies for cases where no SelectEvents entries
82  // exist.
83  Handle<TriggerResults> h;
84  if (e.get(empty_process_name, h)) {
85  return h;
86  }
87  return Handle<TriggerResults>{};
88  }
Float_t e
Definition: plot.C:35
std::optional< detail::ProcessAndEventSelectors > selectors_
Definition: Observer.h:79
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.

38  {
39  return doMakeWorker(wp);
40  }
virtual std::unique_ptr< Worker > doMakeWorker(WorkerParams const &wp)=0
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().

83  {
84  return collector_.mayConsume<T, BT>(tag);
85  }
ProductToken< T > mayConsume(InputTag const &)
ConsumesCollector collector_
Definition: ModuleBase.h:56
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().

97  {
98  collector_.mayConsumeMany<T, BT>();
99  }
ConsumesCollector collector_
Definition: ModuleBase.h:56
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().

90  {
91  return collector_.mayConsumeView<T, BT>(tag);
92  }
ConsumesCollector collector_
Definition: ModuleBase.h:56
ViewToken< Element > mayConsumeView(InputTag const &)
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().

14  {
15  if (md_.has_value()) {
16  return *md_;
17  }
18 
20  "There was an error while calling moduleDescription().\n"}
21  << "The moduleDescription() base-class member function cannot be called\n"
22  "during module construction. To determine which module is "
23  "responsible\n"
24  "for calling it, find the '<module type>:<module "
25  "label>@Construction'\n"
26  "tag in the message prefix above. Please contact artists@fnal.gov\n"
27  "for guidance.\n";
28  }
cet::coded_exception< errors::ErrorCodes, ExceptionDetail::translate > Exception
Definition: Exception.h:66
std::optional< ModuleDescription > md_
Definition: ModuleBase.h:55
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().

58  {
59  return process_name_;
60  }
std::string process_name_
Definition: Observer.h:76
void art::ReplicatedAnalyzer::respondToCloseInputFile ( FileBlock const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 117 of file ReplicatedAnalyzer.cc.

Referenced by ReplicatedAnalyzer(), and respondToCloseInputFileWithFrame().

119  {}
void art::ReplicatedAnalyzer::respondToCloseInputFileWithFrame ( FileBlock const &  fb,
ProcessingFrame const &  frame 
)
finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 33 of file ReplicatedAnalyzer.cc.

References respondToCloseInputFile().

Referenced by ReplicatedAnalyzer().

36  {
38  }
virtual void respondToCloseInputFile(FileBlock const &, ProcessingFrame const &)
TFile fb("Li6.root")
void art::ReplicatedAnalyzer::respondToCloseOutputFiles ( FileBlock const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 127 of file ReplicatedAnalyzer.cc.

Referenced by ReplicatedAnalyzer(), and respondToCloseOutputFilesWithFrame().

129  {}
void art::ReplicatedAnalyzer::respondToCloseOutputFilesWithFrame ( FileBlock const &  fb,
ProcessingFrame const &  frame 
)
finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 49 of file ReplicatedAnalyzer.cc.

References respondToCloseOutputFiles().

Referenced by ReplicatedAnalyzer().

52  {
54  }
virtual void respondToCloseOutputFiles(FileBlock const &, ProcessingFrame const &)
TFile fb("Li6.root")
void art::ReplicatedAnalyzer::respondToOpenInputFile ( FileBlock const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 112 of file ReplicatedAnalyzer.cc.

Referenced by ReplicatedAnalyzer(), and respondToOpenInputFileWithFrame().

114  {}
void art::ReplicatedAnalyzer::respondToOpenInputFileWithFrame ( FileBlock const &  fb,
ProcessingFrame const &  frame 
)
finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 25 of file ReplicatedAnalyzer.cc.

References respondToOpenInputFile().

Referenced by ReplicatedAnalyzer().

28  {
29  respondToOpenInputFile(fb, frame);
30  }
virtual void respondToOpenInputFile(FileBlock const &, ProcessingFrame const &)
TFile fb("Li6.root")
void art::ReplicatedAnalyzer::respondToOpenOutputFiles ( FileBlock const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 122 of file ReplicatedAnalyzer.cc.

Referenced by ReplicatedAnalyzer(), and respondToOpenOutputFilesWithFrame().

124  {}
void art::ReplicatedAnalyzer::respondToOpenOutputFilesWithFrame ( FileBlock const &  fb,
ProcessingFrame const &  frame 
)
finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 41 of file ReplicatedAnalyzer.cc.

References respondToOpenOutputFiles().

Referenced by ReplicatedAnalyzer().

44  {
46  }
virtual void respondToOpenOutputFiles(FileBlock const &, ProcessingFrame const &)
TFile fb("Li6.root")
void art::ModuleBase::setModuleDescription ( ModuleDescription const &  md)
inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

32  {
33  md_ = md;
34  }
std::optional< ModuleDescription > md_
Definition: ModuleBase.h:55
void art::ReplicatedAnalyzer::setupQueues ( detail::SharedResources const &  resources)
finalprivatevirtual

Implements art::detail::Analyzer.

Definition at line 19 of file ReplicatedAnalyzer.cc.

Referenced by ReplicatedAnalyzer().

20  {
21  // For art 3.0, replicated modules will not have queues.
22  }
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().

50  {
51  // Now that we know we have seen all the consumes declarations,
52  // sort the results for fast lookup later.
53  collector_.sortConsumables(current_process_name);
54  }
ConsumesCollector collector_
Definition: ModuleBase.h:56
void sortConsumables(std::string const &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().

32  {
33  return wantAllEvents_;
34  }
bool wantAllEvents_
Definition: Observer.h:75
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().

64  {
65  if (wantAllEvents_) {
66  return true;
67  }
68  bool const select_event = selectors_ ? selectors_->matchEvent(id, e) : true;
69  bool const reject_event =
70  rejectors_ ? rejectors_->matchEvent(id, e) : false;
71  return select_event and not reject_event;
72  }
bool wantAllEvents_
Definition: Observer.h:75
std::optional< detail::ProcessAndEventSelectors > rejectors_
Definition: Observer.h:80
Float_t e
Definition: plot.C:35
std::optional< detail::ProcessAndEventSelectors > selectors_
Definition: Observer.h:79

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