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

#include "EDFilter.h"

Inheritance diagram for art::EDFilter:
art::detail::Filter art::detail::LegacyModule art::Modifier art::ModuleBase art::ProductRegistryHelper art::MixFilter< T, IOPolicy > cluster::SmallClusterFilter filt::FinalStateParticleFilter filt::LArG4ParticleFilter filter::ADCFilter filter::EventFilter filter::EventTimeFilter filter::MuonFilter simfilter::FilterCryostatNus simfilter::FilterGenInTime simfilter::FilterNoDirtNeutrinos simfilter::FilterPrimaryPDG

Public Types

using ModuleType = EDFilter
 
template<typename UserConfig >
using Table = Modifier::Table< UserConfig >
 

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 &)
 
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)
 
void fillProductDescriptions ()
 
void registerProducts (ProductDescriptions &productsToRegister)
 
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)
 

Static Public Attributes

static constexpr bool Pass {true}
 
static constexpr bool Fail {false}
 

Protected Member Functions

 EDFilter (fhicl::ParameterSet const &pset)
 
template<typename Config >
 EDFilter (Table< Config > const &config)
 
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 = EngineCreator::base_engine_t
 
using seed_t = EngineCreator::seed_t
 
using label_t = EngineCreator::label_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
 
bool beginRunWithFrame (Run &, ProcessingFrame const &) final
 
bool endRunWithFrame (Run &, ProcessingFrame const &) final
 
bool beginSubRunWithFrame (SubRun &, ProcessingFrame const &) final
 
bool endSubRunWithFrame (SubRun &, ProcessingFrame const &) final
 
bool filterWithFrame (Event &, 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 bool beginRun (Run &)
 
virtual bool endRun (Run &)
 
virtual bool beginSubRun (SubRun &)
 
virtual bool endSubRun (SubRun &)
 
virtual bool filter (Event &)=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 16 of file EDFilter.h.

Member Typedef Documentation

Definition at line 21 of file LegacyModule.h.

Definition at line 18 of file EDFilter.h.

Definition at line 20 of file LegacyModule.h.

template<typename UserConfig >
using art::detail::Filter::Table = Modifier::Table<UserConfig>
inherited

Definition at line 32 of file Filter.h.

Constructor & Destructor Documentation

art::EDFilter::EDFilter ( fhicl::ParameterSet const &  pset)
explicitprotected

Definition at line 6 of file EDFilter.cc.

7  : Filter{pset}, LegacyModule{pset.get<std::string>("module_label")}
8  {}
LegacyModule(std::string const &module_label)
Definition: LegacyModule.cc:5
Filter(fhicl::ParameterSet const &)
Definition: Filter.cc:24

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

39  {
40  static_assert(
41  BT == InEvent,
42  "async is currently supported only for the 'InEvent' level.");
43  asyncDeclared_ = true;
44  }
void art::EDFilter::beginJob ( )
privatevirtual

Reimplemented in simfilter::FilterGenInTime, and filt::FinalStateParticleFilter.

Definition at line 95 of file EDFilter.cc.

Referenced by beginJobWithFrame(), and EDFilter().

96  {}
void art::EDFilter::beginJobWithFrame ( ProcessingFrame const &  )
finalprivatevirtual

Implements art::detail::Filter.

Definition at line 51 of file EDFilter.cc.

References beginJob().

Referenced by EDFilter().

52  {
53  beginJob();
54  }
virtual void beginJob()
Definition: EDFilter.cc:95
bool art::EDFilter::beginRun ( Run )
privatevirtual

Reimplemented in art::MixFilter< T, IOPolicy >.

Definition at line 119 of file EDFilter.cc.

Referenced by beginRunWithFrame(), and EDFilter().

120  {
121  return true;
122  }
bool art::EDFilter::beginRunWithFrame ( Run r,
ProcessingFrame const &   
)
finalprivatevirtual

Implements art::detail::Filter.

Definition at line 63 of file EDFilter.cc.

References beginRun().

Referenced by EDFilter().

64  {
65  return beginRun(r);
66  }
TRandom r
Definition: spectrum.C:23
virtual bool beginRun(Run &)
Definition: EDFilter.cc:119
bool art::EDFilter::beginSubRun ( SubRun )
privatevirtual

Reimplemented in art::MixFilter< T, IOPolicy >.

Definition at line 131 of file EDFilter.cc.

Referenced by beginSubRunWithFrame(), and EDFilter().

132  {
133  return true;
134  }
bool art::EDFilter::beginSubRunWithFrame ( SubRun sr,
ProcessingFrame const &   
)
finalprivatevirtual

Implements art::detail::Filter.

Definition at line 75 of file EDFilter.cc.

References beginSubRun().

Referenced by EDFilter().

76  {
77  return beginSubRun(sr);
78  }
virtual bool beginSubRun(SubRun &)
Definition: EDFilter.cc:131
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 &)
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(), setupQueues(), art::EDProducer::setupQueues(), and art::EDAnalyzer::setupQueues().

35  {
37  "An error occurred while processing scheduling options for a "
38  "module.\n"};
39  if (asyncDeclared_) {
40  if (empty(resourceNames_)) {
41  return;
42  }
43  throw e
44  << "async<art::InEvent>() cannot be called in combination with any "
45  "serialize<art::InEvent>(...) calls.\n";
46  }
47 
48  if (empty(resourceNames_)) {
49  throw e << "Either 'async<art::InEvent>()' or "
50  "'serialize<art::InEvent>(...)'\n"
51  "must be called in a shared module's constructor.\n";
52  }
53  std::vector<std::string> const names(cbegin(resourceNames_),
55  auto queues = resources.createQueues(names);
56  chain_ = std::make_unique<SerialTaskQueueChain>(queues);
57  }
decltype(auto) constexpr cend(T &&obj)
ADL-aware version of std::cend.
Definition: StdUtils.h:93
std::set< std::string > resourceNames_
Definition: SharedModule.h:76
std::unique_ptr< hep::concurrency::SerialTaskQueueChain > chain_
Definition: SharedModule.h:78
cet::coded_exception< errors::ErrorCodes, ExceptionDetail::translate > Exception
Definition: Exception.h:66
decltype(auto) constexpr cbegin(T &&obj)
ADL-aware version of std::cbegin.
Definition: StdUtils.h:85
Float_t e
Definition: plot.C:35
decltype(auto) constexpr empty(T &&obj)
ADL-aware version of std::empty.
Definition: StdUtils.h:109
void art::detail::Filter::doBeginJob ( SharedResources const &  resources)
inherited

Definition at line 29 of file Filter.cc.

30  {
31  setupQueues(resources);
32  ProcessingFrame const frame{ScheduleID{}};
33  beginJobWithFrame(frame);
34  }
virtual void setupQueues(SharedResources const &)=0
virtual void beginJobWithFrame(ProcessingFrame const &)=0
bool art::detail::Filter::doBeginRun ( RunPrincipal rp,
ModuleContext const &  mc 
)
inherited

Definition at line 72 of file Filter.cc.

References art::RunPrincipal::makeRun(), r, art::RunPrincipal::runID(), and art::ModuleContext::scheduleID().

73  {
74  auto r = rp.makeRun(mc, RangeSet::forRun(rp.runID()));
75  ProcessingFrame const frame{mc.scheduleID()};
76  bool const rc = beginRunWithFrame(r, frame);
77  r.commitProducts();
78  return rc;
79  }
TRandom r
Definition: spectrum.C:23
virtual bool beginRunWithFrame(Run &, ProcessingFrame const &)=0
static RangeSet forRun(RunID)
Definition: RangeSet.cc:51
bool art::detail::Filter::doBeginSubRun ( SubRunPrincipal srp,
ModuleContext const &  mc 
)
inherited

Definition at line 92 of file Filter.cc.

References art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::SubRunPrincipal::subRunID().

93  {
94  auto sr = srp.makeSubRun(mc, RangeSet::forSubRun(srp.subRunID()));
95  ProcessingFrame const frame{mc.scheduleID()};
96  bool const rc = beginSubRunWithFrame(sr, frame);
97  sr.commitProducts();
98  return rc;
99  }
static RangeSet forSubRun(SubRunID)
Definition: RangeSet.cc:57
virtual bool beginSubRunWithFrame(SubRun &, ProcessingFrame const &)=0
void art::detail::Filter::doEndJob ( )
inherited

Definition at line 37 of file Filter.cc.

38  {
39  ProcessingFrame const frame{ScheduleID{}};
40  endJobWithFrame(frame);
41  }
virtual void endJobWithFrame(ProcessingFrame const &)=0
bool art::detail::Filter::doEndRun ( RunPrincipal rp,
ModuleContext const &  mc 
)
inherited

Definition at line 82 of file Filter.cc.

References art::RunPrincipal::makeRun(), r, art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

83  {
84  auto r = rp.makeRun(mc, rp.seenRanges());
85  ProcessingFrame const frame{mc.scheduleID()};
86  bool const rc = endRunWithFrame(r, frame);
87  r.commitProducts();
88  return rc;
89  }
TRandom r
Definition: spectrum.C:23
virtual bool endRunWithFrame(Run &, ProcessingFrame const &)=0
bool art::detail::Filter::doEndSubRun ( SubRunPrincipal srp,
ModuleContext const &  mc 
)
inherited

Definition at line 102 of file Filter.cc.

References art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

103  {
104  auto sr = srp.makeSubRun(mc, srp.seenRanges());
105  ProcessingFrame const frame{mc.scheduleID()};
106  bool const rc = endSubRunWithFrame(sr, frame);
107  sr.commitProducts();
108  return rc;
109  }
virtual bool endSubRunWithFrame(SubRun &, ProcessingFrame const &)=0
bool art::detail::Filter::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 112 of file Filter.cc.

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

117  {
118  auto e = ep.makeEvent(mc);
119  ++counts_run;
120  ProcessingFrame const frame{mc.scheduleID()};
121  bool const rc = filterWithFrame(e, frame);
122  e.commitProducts(checkPutProducts_, &expectedProducts<InEvent>());
123  if (rc) {
124  ++counts_passed;
125  } else {
126  ++counts_failed;
127  }
128  return rc;
129  }
virtual bool filterWithFrame(Event &, ProcessingFrame const &)=0
bool const checkPutProducts_
Definition: Filter.h:75
Float_t e
Definition: plot.C:35
std::unique_ptr< Worker > art::EDFilter::doMakeWorker ( WorkerParams const &  wp)
finalprivatevirtual

Implements art::ModuleBase.

Definition at line 11 of file EDFilter.cc.

Referenced by EDFilter().

12  {
13  return std::make_unique<WorkerT<EDFilter>>(this, wp);
14  }
void art::detail::Filter::doRespondToCloseInputFile ( FileBlock const &  fb)
inherited

Definition at line 51 of file Filter.cc.

52  {
53  ProcessingFrame const frame{ScheduleID{}};
55  }
TFile fb("Li6.root")
virtual void respondToCloseInputFileWithFrame(FileBlock const &, ProcessingFrame const &)=0
void art::detail::Filter::doRespondToCloseOutputFiles ( FileBlock const &  fb)
inherited

Definition at line 65 of file Filter.cc.

66  {
67  ProcessingFrame const frame{ScheduleID{}};
69  }
TFile fb("Li6.root")
virtual void respondToCloseOutputFilesWithFrame(FileBlock const &, ProcessingFrame const &)=0
void art::detail::Filter::doRespondToOpenInputFile ( FileBlock const &  fb)
inherited

Definition at line 44 of file Filter.cc.

45  {
46  ProcessingFrame const frame{ScheduleID{}};
48  }
TFile fb("Li6.root")
virtual void respondToOpenInputFileWithFrame(FileBlock const &, ProcessingFrame const &)=0
void art::detail::Filter::doRespondToOpenOutputFiles ( FileBlock const &  fb)
inherited

Definition at line 58 of file Filter.cc.

59  {
60  ProcessingFrame const frame{ScheduleID{}};
62  }
TFile fb("Li6.root")
virtual void respondToOpenOutputFilesWithFrame(FileBlock const &, ProcessingFrame const &)=0
void art::EDFilter::endJob ( )
privatevirtual

Definition at line 99 of file EDFilter.cc.

Referenced by EDFilter(), and endJobWithFrame().

100  {}
void art::EDFilter::endJobWithFrame ( ProcessingFrame const &  )
finalprivatevirtual

Implements art::detail::Filter.

Definition at line 57 of file EDFilter.cc.

References endJob().

Referenced by EDFilter().

58  {
59  endJob();
60  }
virtual void endJob()
Definition: EDFilter.cc:99
bool art::EDFilter::endRun ( Run )
privatevirtual

Reimplemented in art::MixFilter< T, IOPolicy >.

Definition at line 125 of file EDFilter.cc.

Referenced by EDFilter(), and endRunWithFrame().

126  {
127  return true;
128  }
bool art::EDFilter::endRunWithFrame ( Run r,
ProcessingFrame const &   
)
finalprivatevirtual

Implements art::detail::Filter.

Definition at line 69 of file EDFilter.cc.

References endRun().

Referenced by EDFilter().

70  {
71  return endRun(r);
72  }
TRandom r
Definition: spectrum.C:23
virtual bool endRun(Run &)
Definition: EDFilter.cc:125
bool art::EDFilter::endSubRun ( SubRun )
privatevirtual

Reimplemented in art::MixFilter< T, IOPolicy >.

Definition at line 137 of file EDFilter.cc.

Referenced by EDFilter(), and endSubRunWithFrame().

138  {
139  return true;
140  }
bool art::EDFilter::endSubRunWithFrame ( SubRun sr,
ProcessingFrame const &   
)
finalprivatevirtual

Implements art::detail::Filter.

Definition at line 81 of file EDFilter.cc.

References endSubRun().

Referenced by EDFilter().

82  {
83  return endSubRun(sr);
84  }
virtual bool endSubRun(SubRun &)
Definition: EDFilter.cc:137
void art::Modifier::fillProductDescriptions ( )
inherited

Definition at line 10 of file Modifier.cc.

References art::ProductRegistryHelper::fillDescriptions(), and art::ModuleBase::moduleDescription().

11  {
13  }
void fillDescriptions(ModuleDescription const &md)
ModuleDescription const & moduleDescription() const
Definition: ModuleBase.cc:13
bool art::EDFilter::filterWithFrame ( Event e,
ProcessingFrame const &  frame 
)
finalprivatevirtual

Implements art::detail::Filter.

Definition at line 87 of file EDFilter.cc.

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

Referenced by EDFilter().

88  {
89  ScheduleIDSentry sentry{*this, frame.scheduleID()};
90  return filter(e);
91  }
virtual bool filter(Event &)=0
Float_t e
Definition: plot.C:35
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
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
void art::Modifier::registerProducts ( ProductDescriptions productsToRegister)
inherited

Definition at line 16 of file Modifier.cc.

References art::ModuleBase::moduleDescription(), and art::ProductRegistryHelper::registerProducts().

17  {
18  ProductRegistryHelper::registerProducts(productsToRegister,
20  }
void registerProducts(ProductDescriptions &productsToRegister, ModuleDescription const &md)
ModuleDescription const & moduleDescription() const
Definition: ModuleBase.cc:13
void art::EDFilter::respondToCloseInputFile ( FileBlock const &  )
privatevirtual

Reimplemented in art::MixFilter< T, IOPolicy >.

Definition at line 107 of file EDFilter.cc.

Referenced by EDFilter(), and respondToCloseInputFileWithFrame().

108  {}
void art::EDFilter::respondToCloseInputFileWithFrame ( FileBlock const &  fb,
ProcessingFrame const &   
)
finalprivatevirtual

Implements art::detail::Filter.

Definition at line 30 of file EDFilter.cc.

References respondToCloseInputFile().

Referenced by EDFilter().

32  {
34  }
virtual void respondToCloseInputFile(FileBlock const &)
Definition: EDFilter.cc:107
TFile fb("Li6.root")
void art::EDFilter::respondToCloseOutputFiles ( FileBlock const &  )
privatevirtual

Reimplemented in art::MixFilter< T, IOPolicy >.

Definition at line 115 of file EDFilter.cc.

Referenced by EDFilter(), and respondToCloseOutputFilesWithFrame().

116  {}
void art::EDFilter::respondToCloseOutputFilesWithFrame ( FileBlock const &  fb,
ProcessingFrame const &   
)
finalprivatevirtual

Implements art::detail::Filter.

Definition at line 44 of file EDFilter.cc.

References respondToCloseOutputFiles().

Referenced by EDFilter().

46  {
48  }
TFile fb("Li6.root")
virtual void respondToCloseOutputFiles(FileBlock const &)
Definition: EDFilter.cc:115
void art::EDFilter::respondToOpenInputFile ( FileBlock const &  )
privatevirtual

Reimplemented in art::MixFilter< T, IOPolicy >.

Definition at line 103 of file EDFilter.cc.

Referenced by EDFilter(), and respondToOpenInputFileWithFrame().

104  {}
void art::EDFilter::respondToOpenInputFileWithFrame ( FileBlock const &  fb,
ProcessingFrame const &   
)
finalprivatevirtual

Implements art::detail::Filter.

Definition at line 23 of file EDFilter.cc.

References respondToOpenInputFile().

Referenced by EDFilter().

25  {
27  }
TFile fb("Li6.root")
virtual void respondToOpenInputFile(FileBlock const &)
Definition: EDFilter.cc:103
void art::EDFilter::respondToOpenOutputFiles ( FileBlock const &  )
privatevirtual

Reimplemented in art::MixFilter< T, IOPolicy >.

Definition at line 111 of file EDFilter.cc.

Referenced by EDFilter(), and respondToOpenOutputFilesWithFrame().

112  {}
void art::EDFilter::respondToOpenOutputFilesWithFrame ( FileBlock const &  fb,
ProcessingFrame const &   
)
finalprivatevirtual

Implements art::detail::Filter.

Definition at line 37 of file EDFilter.cc.

References respondToOpenOutputFiles().

Referenced by EDFilter().

39  {
41  }
virtual void respondToOpenOutputFiles(FileBlock const &)
Definition: EDFilter.cc:111
TFile fb("Li6.root")
ScheduleID art::detail::LegacyModule::scheduleID ( ) const
noexceptinherited

Definition at line 12 of file LegacyModule.cc.

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

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

13  {
14  return scheduleID_.load();
15  }
std::atomic< ScheduleID > scheduleID_
Definition: LegacyModule.h:32
template<BranchType BT = InEvent, typename... T>
void art::detail::SharedModule::serialize ( T const &  ...)
protectedinherited
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().

84  {
85  serialize_for_resource(resources...);
86  }
void serialize_for_resource(T const &...t)
Definition: SharedModule.h:52
template<BranchType BT = InEvent, typename... T>
void art::detail::SharedModule::serializeExternal ( T const &  ...)
protectedinherited
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().

91  {
92  serialize_for_external_resource(resources...);
93  }
void serialize_for_external_resource(T const &...t)
Definition: SharedModule.h:65
SerialTaskQueueChain * art::detail::SharedModule::serialTaskQueueChain ( ) const
inherited

Definition at line 22 of file SharedModule.cc.

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

23  {
24  return chain_.get();
25  }
std::unique_ptr< hep::concurrency::SerialTaskQueueChain > chain_
Definition: SharedModule.h:78
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::EDFilter::setupQueues ( detail::SharedResources const &  resources)
finalprivatevirtual

Implements art::detail::Filter.

Definition at line 17 of file EDFilter.cc.

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

Referenced by EDFilter().

18  {
19  createQueues(resources);
20  }
void createQueues(SharedResources const &resources)
Definition: SharedModule.cc:34
std::set< std::string > const & art::detail::SharedModule::sharedResources ( ) const
inherited

Definition at line 28 of file SharedModule.cc.

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

29  {
30  return resourceNames_;
31  }
std::set< std::string > resourceNames_
Definition: SharedModule.h:76
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)

Member Data Documentation

constexpr bool art::detail::Filter::Fail {false}
staticinherited

Definition at line 29 of file Filter.h.

constexpr bool art::detail::Filter::Pass {true}
staticinherited

Definition at line 28 of file Filter.h.


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