LArSoft  v06_85_00
Liquid Argon Software toolkit - http://larsoft.org/
art::EDFilter Class Referenceabstract

#include "EDFilter.h"

Inheritance diagram for art::EDFilter:
art::ProducerBase art::Consumer art::EngineCreator art::ProductRegistryHelper art::BlockingPrescaler art::EventIDFilter art::MixFilter< T > art::Prescaler cluster::SmallClusterFilter filt::EmptyFilter filt::FinalStateParticleFilter filt::FinalStateSelectFilter filt::LArG4ParticleFilter filter::ADCFilter filter::EventFilter filter::MuonFilter simfilter::FilterCryostatNus simfilter::FilterGenInTime simfilter::FilterNoDirtNeutrinos simfilter::FilterNoMCParticles simfilter::FilterPrimaryPDG simfilter::FilterSimPhotonTime simfilter::FilterStoppingMuon

Public Types

using ModuleType = EDFilter
 
using WorkerType = WorkerT< EDFilter >
 
template<typename UserConfig >
using Table = ProducerBase::Table< UserConfig >
 

Public Member Functions

virtual ~EDFilter ()=default
 
template<typename PROD , BranchType B = InEvent>
ProductID getProductID (std::string const &instanceName={}) const
 
bool modifiesEvent () const
 
template<typename PROD , BranchType B>
ProductID getProductID (ModuleDescription const &moduleDescription, std::string const &instanceName) const
 
template<typename T , BranchType = InEvent>
ProductToken< T > consumes (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ProductToken< T > consumes (InputTag const &it)
 
template<typename T , BranchType = InEvent>
void consumesMany ()
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > consumesView (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ViewToken< T > consumesView (InputTag const &it)
 
template<typename T , BranchType = InEvent>
ProductToken< T > mayConsume (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ProductToken< T > mayConsume (InputTag const &it)
 
template<typename T , BranchType = InEvent>
void mayConsumeMany ()
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > mayConsumeView (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ViewToken< T > mayConsumeView (InputTag const &it)
 
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)
 
seed_t get_seed_value (fhicl::ParameterSet const &pset, char const key[]="seed", seed_t const implicit_seed=-1)
 

Static Public Member Functions

static cet::exempt_ptr< Consumernon_module_context ()
 

Static Public Attributes

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

Protected Member Functions

CurrentProcessingContext const * currentContext () const
 
void validateConsumedProduct (BranchType const bt, ProductInfo const &pi)
 
void prepareForJob (fhicl::ParameterSet const &pset)
 
void showMissingConsumes () const
 

Private Types

using CPC_exempt_ptr = cet::exempt_ptr< CurrentProcessingContext const >
 

Private Member Functions

bool doEvent (EventPrincipal &ep, CPC_exempt_ptr cpc, CountingStatistics &)
 
void doBeginJob ()
 
void doEndJob ()
 
bool doBeginRun (RunPrincipal &rp, CPC_exempt_ptr cpc)
 
bool doEndRun (RunPrincipal &rp, CPC_exempt_ptr cpc)
 
bool doBeginSubRun (SubRunPrincipal &srp, CPC_exempt_ptr cpc)
 
bool doEndSubRun (SubRunPrincipal &srp, CPC_exempt_ptr cpc)
 
void doRespondToOpenInputFile (FileBlock const &fb)
 
void doRespondToCloseInputFile (FileBlock const &fb)
 
void doRespondToOpenOutputFiles (FileBlock const &fb)
 
void doRespondToCloseOutputFiles (FileBlock const &fb)
 
std::string workerType () const
 
virtual bool filter (Event &)=0
 
virtual void beginJob ()
 
virtual void endJob ()
 
virtual bool beginRun (Run &)
 
virtual bool endRun (Run &)
 
virtual bool beginSubRun (SubRun &)
 
virtual bool endSubRun (SubRun &)
 
virtual void respondToOpenInputFile (FileBlock const &)
 
virtual void respondToCloseInputFile (FileBlock const &)
 
virtual void respondToOpenOutputFiles (FileBlock const &)
 
virtual void respondToCloseOutputFiles (FileBlock const &)
 
void setModuleDescription (ModuleDescription const &md)
 

Private Attributes

ModuleDescription moduleDescription_ {}
 
CPC_exempt_ptr current_context_ {nullptr}
 
bool checkPutProducts_ {true}
 

Friends

template<typename T >
class WorkerT
 

Detailed Description

Definition at line 30 of file EDFilter.h.

Member Typedef Documentation

using art::EDFilter::CPC_exempt_ptr = cet::exempt_ptr<CurrentProcessingContext const>
private

Definition at line 54 of file EDFilter.h.

Definition at line 37 of file EDFilter.h.

template<typename UserConfig >
using art::EDFilter::Table = ProducerBase::Table<UserConfig>

Definition at line 46 of file EDFilter.h.

Definition at line 38 of file EDFilter.h.

Constructor & Destructor Documentation

virtual art::EDFilter::~EDFilter ( )
virtualdefault

Member Function Documentation

virtual bool art::EDFilter::beginRun ( Run )
inlineprivatevirtual

Reimplemented in art::MixFilter< T >, and cluster::SmallClusterFilter.

Definition at line 82 of file EDFilter.h.

Referenced by doBeginRun().

83  {
84  return true;
85  }
virtual bool art::EDFilter::beginSubRun ( SubRun )
inlineprivatevirtual

Reimplemented in art::MixFilter< T >.

Definition at line 92 of file EDFilter.h.

Referenced by doBeginSubRun().

93  {
94  return true;
95  }
template<typename T , BranchType = InEvent>
ProductToken<T> art::Consumer::consumes ( InputTag const &  )
inherited
template<typename T , art::BranchType BT>
art::ProductToken<T> art::Consumer::consumes ( InputTag const &  it)
inherited

Definition at line 147 of file Consumer.h.

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

148 {
149  if (!moduleContext_)
150  return ProductToken<T>::invalid();
151 
152  consumables_[BT].emplace_back(ConsumableType::Product,
153  TypeID{typeid(T)},
154  it.label(),
155  it.instance(),
156  it.process());
157  return ProductToken<T>{it};
158 }
static ProductToken< T > invalid()
Definition: ProductToken.h:47
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
template<typename T , art::BranchType BT>
void art::Consumer::consumesMany ( )
inherited

Definition at line 162 of file Consumer.h.

163 {
164  if (!moduleContext_)
165  return;
166 
167  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
168 }
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
template<typename Element , BranchType = InEvent>
ViewToken<Element> art::Consumer::consumesView ( InputTag const &  )
inherited
template<typename T , art::BranchType BT>
art::ViewToken<T> art::Consumer::consumesView ( InputTag const &  it)
inherited

Definition at line 172 of file Consumer.h.

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

173 {
174  if (!moduleContext_)
175  return ViewToken<T>::invalid();
176 
177  consumables_[BT].emplace_back(ConsumableType::ViewElement,
178  TypeID{typeid(T)},
179  it.label(),
180  it.instance(),
181  it.process());
182  return ViewToken<T>{it};
183 }
static ViewToken< Element > invalid()
Definition: ProductToken.h:75
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t  seed,
std::string const &  kind_of_engine_to_make 
)
inherited

Definition at line 32 of file EngineCreator.cc.

References art::EngineCreator::rng().

34 {
35  return rng()->createEngine(
36  placeholder_schedule_id(), seed, kind_of_engine_to_make);
37 }
long seed
Definition: chem4.cc:68
static art::ServiceHandle< art::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 40 of file EngineCreator.cc.

References art::EngineCreator::rng().

43 {
44  return rng()->createEngine(
45  placeholder_schedule_id(), seed, kind_of_engine_to_make, engine_label);
46 }
long seed
Definition: chem4.cc:68
static art::ServiceHandle< art::RandomNumberGenerator > & rng()
CurrentProcessingContext const * art::EDFilter::currentContext ( ) const
protected

Definition at line 120 of file EDFilter.cc.

References current_context_.

121  {
122  return current_context_.get();
123  }
CPC_exempt_ptr current_context_
Definition: EDFilter.h:125
void art::EDFilter::doBeginJob ( )
private

Definition at line 32 of file EDFilter.cc.

References beginJob(), checkPutProducts_, fhicl::ParameterSetRegistry::get(), art::detail::get_failureToPut_flag(), art::ModuleDescription::mainParameterSetID(), moduleDescription_, art::ModuleDescription::parameterSetID(), and art::Consumer::prepareForJob().

33  {
34  // 'checkPutProducts_' cannot be set during the c'tor
35  // initialization list since 'moduleDescription_' is empty there.
36  auto const& mainID = moduleDescription_.mainParameterSetID();
37  auto const& scheduler_pset =
39  "services.scheduler");
40  auto const& module_pset =
43  detail::get_failureToPut_flag(scheduler_pset, module_pset);
44  prepareForJob(scheduler_pset);
45  beginJob();
46  }
fhicl::ParameterSetID const & mainParameterSetID() const
ModuleDescription moduleDescription_
Definition: EDFilter.h:124
static collection_type const & get() noexcept
bool checkPutProducts_
Definition: EDFilter.h:126
fhicl::ParameterSetID const & parameterSetID() const
void prepareForJob(fhicl::ParameterSet const &pset)
Definition: Consumer.cc:89
virtual void beginJob()
Definition: EDFilter.h:76
bool get_failureToPut_flag(fhicl::ParameterSet const &scheduler_pset, fhicl::ParameterSet const &module_pset)
bool art::EDFilter::doBeginRun ( RunPrincipal rp,
CPC_exempt_ptr  cpc 
)
private

Definition at line 56 of file EDFilter.cc.

References beginRun(), current_context_, art::RangeSet::forRun(), art::RunPrincipal::id(), and moduleDescription_.

57  {
58  detail::CPCSentry sentry{current_context_, cpc};
59  Run r{rp, moduleDescription_, this, RangeSet::forRun(rp.id())};
60  bool const rc = beginRun(r);
61  r.commit(rp);
62  return rc;
63  }
ModuleDescription moduleDescription_
Definition: EDFilter.h:124
CPC_exempt_ptr current_context_
Definition: EDFilter.h:125
static RangeSet forRun(RunID)
Definition: RangeSet.cc:52
virtual bool beginRun(Run &)
Definition: EDFilter.h:82
bool art::EDFilter::doBeginSubRun ( SubRunPrincipal srp,
CPC_exempt_ptr  cpc 
)
private

Definition at line 76 of file EDFilter.cc.

References beginSubRun(), current_context_, art::RangeSet::forSubRun(), art::SubRunPrincipal::id(), and moduleDescription_.

77  {
78  detail::CPCSentry sentry{current_context_, cpc};
79  SubRun sr{srp, moduleDescription_, this, RangeSet::forSubRun(srp.id())};
80  bool const rc = beginSubRun(sr);
81  sr.commit(srp);
82  return rc;
83  }
ModuleDescription moduleDescription_
Definition: EDFilter.h:124
CPC_exempt_ptr current_context_
Definition: EDFilter.h:125
virtual bool beginSubRun(SubRun &)
Definition: EDFilter.h:92
static RangeSet forSubRun(SubRunID)
Definition: RangeSet.cc:58
void art::EDFilter::doEndJob ( )
private

Definition at line 49 of file EDFilter.cc.

References endJob(), and art::Consumer::showMissingConsumes().

50  {
51  endJob();
53  }
virtual void endJob()
Definition: EDFilter.h:79
void showMissingConsumes() const
Definition: Consumer.cc:125
bool art::EDFilter::doEndRun ( RunPrincipal rp,
CPC_exempt_ptr  cpc 
)
private

Definition at line 66 of file EDFilter.cc.

References current_context_, endRun(), moduleDescription_, and art::RunPrincipal::seenRanges().

67  {
68  detail::CPCSentry sentry{current_context_, cpc};
69  Run r{rp, moduleDescription_, this, rp.seenRanges()};
70  bool const rc = endRun(r);
71  r.commit(rp);
72  return rc;
73  }
ModuleDescription moduleDescription_
Definition: EDFilter.h:124
CPC_exempt_ptr current_context_
Definition: EDFilter.h:125
virtual bool endRun(Run &)
Definition: EDFilter.h:87
bool art::EDFilter::doEndSubRun ( SubRunPrincipal srp,
CPC_exempt_ptr  cpc 
)
private

Definition at line 86 of file EDFilter.cc.

References current_context_, endSubRun(), moduleDescription_, and art::SubRunPrincipal::seenRanges().

87  {
88  detail::CPCSentry sentry{current_context_, cpc};
89  SubRun sr{srp, moduleDescription_, this, srp.seenRanges()};
90  bool const rc = endSubRun(sr);
91  sr.commit(srp);
92  return rc;
93  }
ModuleDescription moduleDescription_
Definition: EDFilter.h:124
virtual bool endSubRun(SubRun &)
Definition: EDFilter.h:97
CPC_exempt_ptr current_context_
Definition: EDFilter.h:125
bool art::EDFilter::doEvent ( EventPrincipal ep,
CPC_exempt_ptr  cpc,
CountingStatistics counts 
)
private

Definition at line 18 of file EDFilter.cc.

References checkPutProducts_, current_context_, e, filter(), art::ExecutionCounts< ARGS >::increment(), moduleDescription_, and art::ExecutionCounts< ARGS >::update().

21  {
22  detail::CPCSentry sentry{current_context_, cpc};
23  Event e{ep, moduleDescription_, this};
24  counts.increment<stats::Run>();
25  bool const rc = filter(e);
26  e.commit(ep, checkPutProducts_, expectedProducts<InEvent>());
27  counts.update(rc);
28  return rc;
29  }
ModuleDescription moduleDescription_
Definition: EDFilter.h:124
virtual bool filter(Event &)=0
bool checkPutProducts_
Definition: EDFilter.h:126
CPC_exempt_ptr current_context_
Definition: EDFilter.h:125
Float_t e
Definition: plot.C:34
void art::EDFilter::doRespondToCloseInputFile ( FileBlock const &  fb)
private

Definition at line 102 of file EDFilter.cc.

References respondToCloseInputFile().

103  {
105  }
virtual void respondToCloseInputFile(FileBlock const &)
Definition: EDFilter.h:105
TFile fb("Li6.root")
void art::EDFilter::doRespondToCloseOutputFiles ( FileBlock const &  fb)
private

Definition at line 114 of file EDFilter.cc.

References respondToCloseOutputFiles().

115  {
117  }
TFile fb("Li6.root")
virtual void respondToCloseOutputFiles(FileBlock const &)
Definition: EDFilter.h:111
void art::EDFilter::doRespondToOpenInputFile ( FileBlock const &  fb)
private

Definition at line 96 of file EDFilter.cc.

References respondToOpenInputFile().

97  {
99  }
TFile fb("Li6.root")
virtual void respondToOpenInputFile(FileBlock const &)
Definition: EDFilter.h:102
void art::EDFilter::doRespondToOpenOutputFiles ( FileBlock const &  fb)
private

Definition at line 108 of file EDFilter.cc.

References respondToOpenOutputFiles().

109  {
111  }
virtual void respondToOpenOutputFiles(FileBlock const &)
Definition: EDFilter.h:108
TFile fb("Li6.root")
virtual void art::EDFilter::endJob ( )
inlineprivatevirtual

Reimplemented in filter::MuonFilter, and filter::EventFilter.

Definition at line 79 of file EDFilter.h.

Referenced by doEndJob().

80  {}
virtual bool art::EDFilter::endRun ( Run )
inlineprivatevirtual

Reimplemented in art::MixFilter< T >.

Definition at line 87 of file EDFilter.h.

Referenced by doEndRun().

88  {
89  return true;
90  }
virtual bool art::EDFilter::endSubRun ( SubRun )
inlineprivatevirtual

Reimplemented in art::MixFilter< T >.

Definition at line 97 of file EDFilter.h.

Referenced by doEndSubRun().

98  {
99  return true;
100  }
EngineCreator::seed_t EngineCreator::get_seed_value ( fhicl::ParameterSet const &  pset,
char const  key[] = "seed",
seed_t const  implicit_seed = -1 
)
inherited

Definition at line 49 of file EngineCreator.cc.

References fhicl::ParameterSet::get().

Referenced by art::MixFilter< T >::initEngine_().

52 {
53  auto const& explicit_seeds = pset.get<std::vector<int>>(key, {});
54  return explicit_seeds.empty() ? implicit_seed : explicit_seeds.front();
55 }
template<typename PROD , BranchType B>
ProductID art::EDFilter::getProductID ( std::string const &  instanceName = {}) const
inline

Definition at line 131 of file EDFilter.h.

References moduleDescription_.

132  {
133  return ProducerBase::getProductID<PROD, B>(moduleDescription_,
134  instanceName);
135  }
ModuleDescription moduleDescription_
Definition: EDFilter.h:124
template<typename PROD , BranchType B>
ProductID art::ProducerBase::getProductID ( ModuleDescription const &  moduleDescription,
std::string const &  instanceName 
) const
inherited

Definition at line 56 of file ProducerBase.h.

References B, and art::ModuleDescription::moduleLabel().

Referenced by art::ProducerBase::modifiesEvent().

58  {
59  auto const& pd =
60  get_ProductDescription<PROD>(B, md.moduleLabel(), instanceName);
61  return pd.productID();
62  }
Int_t B
Definition: plot.C:25
template<typename T , BranchType = InEvent>
ProductToken<T> art::Consumer::mayConsume ( InputTag const &  )
inherited
template<typename T , art::BranchType BT>
art::ProductToken<T> art::Consumer::mayConsume ( InputTag const &  it)
inherited

Definition at line 190 of file Consumer.h.

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

191 {
192  if (!moduleContext_)
193  return ProductToken<T>::invalid();
194 
195  consumables_[BT].emplace_back(ConsumableType::Product,
196  TypeID{typeid(T)},
197  it.label(),
198  it.instance(),
199  it.process());
200  return ProductToken<T>{it};
201 }
static ProductToken< T > invalid()
Definition: ProductToken.h:47
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
template<typename T , art::BranchType BT>
void art::Consumer::mayConsumeMany ( )
inherited

Definition at line 205 of file Consumer.h.

206 {
207  if (!moduleContext_)
208  return;
209 
210  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
211 }
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
template<typename Element , BranchType = InEvent>
ViewToken<Element> art::Consumer::mayConsumeView ( InputTag const &  )
inherited
template<typename T , art::BranchType BT>
art::ViewToken<T> art::Consumer::mayConsumeView ( InputTag const &  it)
inherited

Definition at line 215 of file Consumer.h.

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

216 {
217  if (!moduleContext_)
218  return ViewToken<T>::invalid();
219 
220  consumables_[BT].emplace_back(ConsumableType::ViewElement,
221  TypeID{typeid(T)},
222  it.label(),
223  it.instance(),
224  it.process());
225  return ViewToken<T>{it};
226 }
static ViewToken< Element > invalid()
Definition: ProductToken.h:75
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
bool art::ProducerBase::modifiesEvent ( ) const
inlineinherited

Definition at line 40 of file ProducerBase.h.

References art::ProducerBase::getProductID().

41  {
42  return true;
43  }
void art::Consumer::prepareForJob ( fhicl::ParameterSet const &  pset)
protectedinherited

Definition at line 89 of file Consumer.cc.

References fhicl::ParameterSet::get_if_present().

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

90 {
91  if (!moduleContext_)
92  return;
93 
94  pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
95  for (auto& consumablesPerBranch : consumables_) {
96  cet::sort_all(consumablesPerBranch);
97  }
98 }
bool requireConsumes_
Definition: Consumer.h:137
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
virtual void art::EDFilter::respondToCloseInputFile ( FileBlock const &  )
inlineprivatevirtual

Reimplemented in art::MixFilter< T >.

Definition at line 105 of file EDFilter.h.

Referenced by doRespondToCloseInputFile().

106  {}
virtual void art::EDFilter::respondToCloseOutputFiles ( FileBlock const &  )
inlineprivatevirtual

Reimplemented in art::MixFilter< T >.

Definition at line 111 of file EDFilter.h.

Referenced by doRespondToCloseOutputFiles().

112  {}
virtual void art::EDFilter::respondToOpenInputFile ( FileBlock const &  )
inlineprivatevirtual

Reimplemented in art::MixFilter< T >.

Definition at line 102 of file EDFilter.h.

Referenced by doRespondToOpenInputFile().

103  {}
virtual void art::EDFilter::respondToOpenOutputFiles ( FileBlock const &  )
inlineprivatevirtual

Reimplemented in art::MixFilter< T >.

Definition at line 108 of file EDFilter.h.

Referenced by doRespondToOpenOutputFiles().

109  {}
void art::EDFilter::setModuleDescription ( ModuleDescription const &  md)
inlineprivate

Definition at line 115 of file EDFilter.h.

References moduleDescription_, and art::Consumer::setModuleDescription().

116  {
117  moduleDescription_ = md;
118  // Since the module description in the Consumer base class is
119  // owned by pointer, we must give it the owned object of this
120  // class--i.e. moduleDescription_, not md.
122  }
ModuleDescription moduleDescription_
Definition: EDFilter.h:124
void setModuleDescription(ModuleDescription const &md)
Definition: Consumer.cc:83
void art::Consumer::showMissingConsumes ( ) const
protectedinherited

Definition at line 125 of file Consumer.cc.

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

126 {
127  if (!moduleContext_)
128  return;
129 
130  // If none of the branches have missing consumes statements, exit early.
131  if (std::all_of(cbegin(missingConsumes_),
132  cend(missingConsumes_),
133  [](auto const& perBranch) { return perBranch.empty(); }))
134  return;
135 
136  constexpr cet::HorizontalRule rule{60};
137  mf::LogPrint log{"MTdiagnostics"};
138  log << '\n'
139  << rule('=') << '\n'
140  << "The following consumes (or mayConsume) statements are missing from\n"
141  << module_context(moduleDescription_) << '\n'
142  << rule('-') << '\n';
143 
144  cet::for_all_with_index(
145  missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
146  for (auto const& pi : perBranch) {
147  log << " "
148  << assemble_consumes_statement(static_cast<BranchType>(i), pi)
149  << '\n';
150  }
151  });
152  log << rule('=');
153 }
cet::exempt_ptr< ModuleDescription const > moduleDescription_
Definition: Consumer.h:140
constexpr T pi()
Returns the constant pi (up to 35 decimal digits of precision)
bool moduleContext_
Definition: Consumer.h:136
ConsumableProductSets missingConsumes_
Definition: Consumer.h:139
void art::Consumer::validateConsumedProduct ( BranchType const  bt,
ProductInfo const &  pi 
)
protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

103 {
104  // Early exits if consumes tracking has been disabled or if the
105  // consumed product is an allowed consumable.
106  if (!moduleContext_)
107  return;
108 
109  if (cet::binary_search_all(consumables_[bt], pi))
110  return;
111 
112  if (requireConsumes_) {
114  "Consumer: an error occurred during validation of a "
115  "retrieved product\n\n")
116  << "The following consumes (or mayConsume) statement is missing from\n"
117  << module_context(moduleDescription_) << ":\n\n"
118  << " " << assemble_consumes_statement(bt, pi) << "\n\n";
119  }
120 
121  missingConsumes_[bt].insert(pi);
122 }
cet::exempt_ptr< ModuleDescription const > moduleDescription_
Definition: Consumer.h:140
bool requireConsumes_
Definition: Consumer.h:137
cet::coded_exception< errors::ErrorCodes, ExceptionDetail::translate > Exception
Definition: Exception.h:66
constexpr T pi()
Returns the constant pi (up to 35 decimal digits of precision)
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
ConsumableProductSets missingConsumes_
Definition: Consumer.h:139
std::string art::EDFilter::workerType ( ) const
inlineprivate

Definition at line 69 of file EDFilter.h.

References filter().

70  {
71  return "WorkerT<EDFilter>";
72  }

Friends And Related Function Documentation

template<typename T >
friend class WorkerT
friend

Definition at line 36 of file EDFilter.h.

Member Data Documentation

bool art::EDFilter::checkPutProducts_ {true}
private

Definition at line 126 of file EDFilter.h.

Referenced by doBeginJob(), and doEvent().

CPC_exempt_ptr art::EDFilter::current_context_ {nullptr}
private

Definition at line 125 of file EDFilter.h.

Referenced by currentContext(), doBeginRun(), doBeginSubRun(), doEndRun(), doEndSubRun(), and doEvent().

constexpr bool art::EDFilter::Fail {false}
static

Definition at line 33 of file EDFilter.h.

ModuleDescription art::EDFilter::moduleDescription_ {}
private
constexpr bool art::EDFilter::Pass {true}
static

Definition at line 32 of file EDFilter.h.


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