#include "EDProducer.h"

Inheritance diagram for art::EDProducer:

Public Types
using	ModuleType = EDProducer

using	WorkerType = WorkerT< EDProducer >

template<typename UserConfig , typename KeysToIgnore = void>
using	Table = ProducerBase::Table< UserConfig, KeysToIgnore >

Public Member Functions
virtual	~EDProducer ()=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_t &	createEngine (seed_t seed)

base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make)

base_engine_t &	createEngine (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< Consumer >	non_module_context ()

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 cpcp, 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 void	produce (Event &)=0

virtual void	beginJob ()

virtual void	endJob ()

virtual void	beginRun (Run &)

virtual void	beginSubRun (SubRun &)

virtual void	endRun (Run &)

virtual void	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}

std::set< TypeLabel >	missingConsumes_ {}

Friends
template<typename T >
class	WorkerT

Detailed Description

Definition at line 28 of file EDProducer.h.

Member Typedef Documentation

using art::EDProducer::CPC_exempt_ptr = cet::exempt_ptr<CurrentProcessingContext const>

private

Definition at line 51 of file EDProducer.h.

using art::EDProducer::ModuleType = EDProducer

Definition at line 34 of file EDProducer.h.

template<typename UserConfig , typename KeysToIgnore = void>

using art::EDProducer::Table = ProducerBase::Table<UserConfig, KeysToIgnore>

Definition at line 43 of file EDProducer.h.

using art::EDProducer::WorkerType = WorkerT<EDProducer>

Definition at line 35 of file EDProducer.h.

Constructor & Destructor Documentation

virtual art::EDProducer::~EDProducer ( )

virtualdefault

Member Function Documentation

virtual void art::EDProducer::beginJob ( )

inlineprivatevirtual

Reimplemented in ems::MergeEMShower3D, larg4::LArG4, evgen::MUSUN, trkf::CosmicTracker, lar_cluster3d::Cluster3D, vertex::FeatureVertexFinder, t0::MCTruthT0Matching, trkf::Track3DKalmanSPS, detsim::SimDriftElectrons, lbne::PhotonCounterT0Matching, evgen::GENIEGen, trkf::Track3DKalman, evgen::NeutronOsc, detsim::SimWireT962, hit::DPRawHitFinder, shwf::ShowerReco, detsim::SimWire, evgen::TextFileGen, calo::Calorimetry, vertex::VertexFinder2D, evgen::GaisserParam, CRHitRemovalByPCA, trkf::Track3DKalmanHit, trkf::TrackStitcher, hit::GausHitFinder, ems::EMShower3D, trkf::CCTrackMaker, t0::MCParticleShowerMatching, t0::MCParticleTrackMatching, vertex::HarrisVertexFinder, evgen::NDKGen, cosmic::CosmicClusterTagger, cluster::SmallClusterFinder, hit::RawHitFinder, cosmic::CosmicPCAxisTagger, reco3d::SpacePointSolver, evgen::NucleonDecay, cosmic::CosmicTrackTagger, vertex::PrimaryVertexFinder, trkf::Track3Dreco, trkf::TrackKalmanCheater, cosmic::CosmicPFParticleTagger, event::AggregateEvent, evgen::NUANCEGen, phot::PhotonLibraryPropagation, trkf::SpacePts, cluster::ClusterCrawler, cluster::fuzzyCluster, evgen::FileMuons, opdet::TrackTimeAssoc, cluster::LineMerger, opdet::OpHitFinder, t0::MCParticleHitMatching, cosmic::TrackPFParticleMatch, caldata::CalWireT962, cluster::DBcluster, wc::MergeWireCell, CRHitRemoval, caldata::CalWire, vertex::AggregateVertex, evgen::CORSIKAGen, opdet::BeamFlashCompatabilityCheck, opdet::OptDetDigitizer, hit::FFTHitFinder, cluster::TrajCluster, trkf::FeatureTracker, evgen::CosmicsGen, noisefilteralg::WireCellNoiseFilter, hit::HitCheater, spacecharge::ShiftEdepSCE, opdet::OpFlashFinder, sppt::TTSpacePointFinder, apa::APAHitFinder, hit::RFFHitFinder, trkf::BezierTrackerModule, trkf::SpacePointCheater, trkf::SpacePointFinder, opdet::OpMCDigi, opdet::OpticalRawDigitReformatter, hit::TTHitFinder, trkf::SeedFinderModule, opdet::FlashClusterMatch, hit::DisambigCheater, mvapid::MVAPID, lar_pandora::LArPandora, and opdet::BoDataFrameInput.

Definition at line 73 of file EDProducer.h.

Referenced by doBeginJob().

74 {}

virtual void art::EDProducer::beginRun ( Run & )

inlineprivatevirtual

Reimplemented in larg4::LArG4, evgen::SingleGen, evgen::MarleyTimeGen, evgen::MUSUN, evgen::LightSource, evgen::RadioGen, evgen::GENIEGen, detsim::SimWireT962, evgen::NeutronOsc, shwf::ShowerReco, evgen::TextFileGen, evgen::GaisserParam, evgen::MarleyGen, evgen::NDKGen, cluster::SmallClusterFinder, evgen::NucleonDecay, evgen::NUANCEGen, evgen::FileMuons, evgen::CORSIKAGen, evgen::CosmicsGen, sppt::TTSpacePointFinder, evgen::SNNueAr40CCGen, ToyOneShowerGen, and mvapid::MVAPID.

Definition at line 80 of file EDProducer.h.

Referenced by doBeginRun().

81 {}

virtual void art::EDProducer::beginSubRun ( SubRun & )

inlineprivatevirtual

Definition at line 83 of file EDProducer.h.

Referenced by doBeginSubRun().

84 {}

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

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::consumesMany ( )

inherited

Definition at line 162 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

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

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t seed )

inherited

Definition at line 26 of file EngineCreator.cc.

References art::EngineCreator::rng().

Referenced by evgen::CosmicsGen::CosmicsGen(), rndm::NuRandomService::createEngine(), cluster::fuzzyCluster::fuzzyCluster(), cluster::HoughLineFinder::HoughLineFinder(), art::MixFilter< T >::initEngine_(), larg4::LArG4::LArG4(), evgen::LightSource::LightSource(), evgen::NeutronOsc::NeutronOsc(), evgen::NucleonDecay::NucleonDecay(), opdet::OpMCDigi::OpMCDigi(), opdet::OptDetDigitizer::OptDetDigitizer(), phot::PhotonLibraryPropagation::PhotonLibraryPropagation(), detsim::SimDriftElectrons::SimDriftElectrons(), evgen::SingleGen::SingleGen(), evgen::SNNueAr40CCGen::SNNueAr40CCGen(), ToyOneShowerGen::ToyOneShowerGen(), and trkf::Track3DKalman::Track3DKalman().

 {
   return rng()->createEngine(placeholder_schedule_id(), seed);
 }

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

 {
   return rng()->createEngine(
     placeholder_schedule_id(), seed, kind_of_engine_to_make);
 }

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

 {
   return rng()->createEngine(
     placeholder_schedule_id(), seed, kind_of_engine_to_make, engine_label);
 }

CurrentProcessingContext const * art::EDProducer::currentContext ( ) const

protected

Definition at line 120 of file EDProducer.cc.

References current_context_.

   {
     return current_context_.get();
   }

void art::EDProducer::doBeginJob ( )

private

Definition at line 32 of file EDProducer.cc.

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

   {
     // 'checkPutProducts_' cannot be set during the c'tor
     // initialization list since 'moduleDescription_' is empty there.
     auto const& mainID = moduleDescription_.mainParameterSetID();
     auto const& scheduler_pset =
       fhicl::ParameterSetRegistry::get(mainID).get<fhicl::ParameterSet>(
         "services.scheduler");
     auto const& module_pset =
       fhicl::ParameterSetRegistry::get(moduleDescription_.parameterSetID());
     checkPutProducts_ =
       detail::get_failureToPut_flag(scheduler_pset, module_pset);
     prepareForJob(scheduler_pset);
     beginJob();
   }

bool art::EDProducer::doBeginRun	(	RunPrincipal &	rp,
		CPC_exempt_ptr	cpc
	)

private

Definition at line 56 of file EDProducer.cc.

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

   {
     detail::CPCSentry sentry{current_context_, cpc};
     Run r{rp, moduleDescription_, this, RangeSet::forRun(rp.id())};
     beginRun(r);
     r.commit(rp);
     return true;
   }

bool art::EDProducer::doBeginSubRun	(	SubRunPrincipal &	srp,
		CPC_exempt_ptr	cpc
	)

private

Definition at line 76 of file EDProducer.cc.

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

   {
     detail::CPCSentry sentry{current_context_, cpc};
     SubRun sr{srp, moduleDescription_, this, RangeSet::forSubRun(srp.id())};
     beginSubRun(sr);
     sr.commit(srp);
     return true;
   }

void art::EDProducer::doEndJob ( )

private

Definition at line 49 of file EDProducer.cc.

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

   {
     endJob();
     showMissingConsumes();
   }

bool art::EDProducer::doEndRun	(	RunPrincipal &	rp,
		CPC_exempt_ptr	cpc
	)

private

Definition at line 66 of file EDProducer.cc.

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

   {
     detail::CPCSentry sentry{current_context_, cpc};
     Run r{rp, moduleDescription_, this, rp.seenRanges()};
     endRun(r);
     r.commit(rp);
     return true;
   }

bool art::EDProducer::doEndSubRun	(	SubRunPrincipal &	srp,
		CPC_exempt_ptr	cpc
	)

private

Definition at line 86 of file EDProducer.cc.

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

   {
     detail::CPCSentry sentry{current_context_, cpc};
     SubRun sr{srp, moduleDescription_, this, srp.seenRanges()};
     endSubRun(sr);
     sr.commit(srp);
     return true;
   }

bool art::EDProducer::doEvent	(	EventPrincipal &	ep,
		CPC_exempt_ptr	cpcp,
		CountingStatistics &	counts
	)

private

Definition at line 18 of file EDProducer.cc.

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

   {
     detail::CPCSentry sentry{current_context_, cpc};
     Event e{ep, moduleDescription_, this};
     counts.increment<stats::Run>();
     produce(e);
     e.commit(ep, checkPutProducts_, expectedProducts<InEvent>());
     counts.increment<stats::Passed>();
     return true;
   }

void art::EDProducer::doRespondToCloseInputFile ( FileBlock const & fb )

private

Definition at line 102 of file EDProducer.cc.

References respondToCloseInputFile().

   {
     respondToCloseInputFile(fb);
   }

void art::EDProducer::doRespondToCloseOutputFiles ( FileBlock const & fb )

private

Definition at line 114 of file EDProducer.cc.

References respondToCloseOutputFiles().

   {
     respondToCloseOutputFiles(fb);
   }

void art::EDProducer::doRespondToOpenInputFile ( FileBlock const & fb )

private

Definition at line 96 of file EDProducer.cc.

References respondToOpenInputFile().

   {
     respondToOpenInputFile(fb);
   }

void art::EDProducer::doRespondToOpenOutputFiles ( FileBlock const & fb )

private

Definition at line 108 of file EDProducer.cc.

References respondToOpenOutputFiles().

   {
     respondToOpenOutputFiles(fb);
   }

virtual void art::EDProducer::endJob ( )

inlineprivatevirtual

Reimplemented in trkf::CosmicTracker, lar_cluster3d::Cluster3D, trkf::Track3DKalmanSPS, detsim::SimDriftElectrons, trkf::Track3DKalman, detsim::SimWireT962, hit::DPRawHitFinder, detsim::SimWire, CRHitRemovalByPCA, trkf::Track3DKalmanHit, trkf::TrackStitcher, hit::GausHitFinder, evgen::NDKGen, cosmic::CosmicClusterTagger, cosmic::CosmicPCAxisTagger, hit::RawHitFinder, cosmic::CosmicTrackTagger, reco3d::SpacePointSolver, cosmic::CosmicPFParticleTagger, trkf::Track3Dreco, trkf::TrackKalmanCheater, evgen::NUANCEGen, trkf::SpacePts, evgen::FileMuons, cosmic::TrackPFParticleMatch, opdet::OpHitFinder, caldata::CalWireT962, CRHitRemoval, caldata::CalWire, evwgh::EventWeight, hit::FFTHitFinder, trkf::FeatureTracker, cluster::TrajCluster, noisefilteralg::WireCellNoiseFilter, sppt::TTSpacePointFinder, opdet::OpFlashFinder, trkf::BezierTrackerModule, apa::APAHitFinder, trkf::SpacePointCheater, trkf::SpacePointFinder, opdet::OpticalRawDigitReformatter, trkf::TCTrack, hit::TTHitFinder, trkf::SeedFinderModule, hit::DisambigCheater, and hit::HitFinder.

Definition at line 76 of file EDProducer.h.

Referenced by doEndJob().

77 {}

virtual void art::EDProducer::endRun ( Run & )

inlineprivatevirtual

Reimplemented in evgen::MUSUN.

Definition at line 86 of file EDProducer.h.

Referenced by doEndRun().

87 {}

virtual void art::EDProducer::endSubRun ( SubRun & )

inlineprivatevirtual

Reimplemented in evgen::GENIEGen.

Definition at line 89 of file EDProducer.h.

Referenced by doEndSubRun().

90 {}

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

 {
   auto const& explicit_seeds = pset.get<std::vector<int>>(key, {});
   return explicit_seeds.empty() ? implicit_seed : explicit_seeds.front();
 }

template<typename PROD , BranchType B>

ProductID art::EDProducer::getProductID ( std::string const & instanceName = {} ) const

inline

Definition at line 123 of file EDProducer.h.

References moduleDescription_.

   {
     return ProducerBase::getProductID<PROD, B>(moduleDescription_,
                                                instanceName);
   }

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

   {
     auto const& pd =
       get_ProductDescription<PROD>(B, md.moduleLabel(), instanceName);
     return pd.productID();
   }

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

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::mayConsumeMany ( )

inherited

Definition at line 205 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

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

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

bool art::ProducerBase::modifiesEvent ( ) const

inlineinherited

Definition at line 40 of file ProducerBase.h.

References art::ProducerBase::getProductID().

     {
       return true;
     }

cet::exempt_ptr< art::Consumer > art::Consumer::non_module_context ( )

staticinherited

Definition at line 76 of file Consumer.cc.

 {
   static Consumer invalid{InvalidTag{}};
   return &invalid;
 }

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 doBeginJob(), art::EDFilter::doBeginJob(), and art::EDAnalyzer::doBeginJob().

 {
   if (!moduleContext_)
     return;
 
   pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
   for (auto& consumablesPerBranch : consumables_) {
     cet::sort_all(consumablesPerBranch);
   }
 }

virtual void art::EDProducer::produce ( Event & )

privatepure virtual

Implemented in ems::MergeEMShower3D, larg4::LArG4, evgen::SingleGen, evgen::MarleyTimeGen, evgen::MUSUN, trkf::CosmicTracker, trkf::KalmanFilterFinalTrackFitter, trkf::PMAlgTrackMaker, trkf::KalmanFilterTrajectoryFitter, lar_cluster3d::Cluster3D, evd::GraphCluster, lar::example::TotallyCheatTracker, vertex::FeatureVertexFinder, evgen::LightSource, raw::RecompressRawDigits, t0::MCTruthT0Matching, trkf::Track3DKalmanSPS, detsim::SimDriftElectrons, evgen::RadioGen, trkf::PMAlgTrajFitter, lar::example::RemoveIsolatedSpacePoints, lbne::PhotonCounterT0Matching, evgen::GENIEGen, trkf::Track3DKalman, shwf::ShowerReco, vertex::VertexFinder2D, detsim::SimWireT962, evgen::NeutronOsc, calo::Calorimetry, hit::DPRawHitFinder, detsim::SimWire, trkf::VertexFitter, evgen::TextFileGen, cluster::HoughLineFinder, evgen::MarleyGen, evgen::GaisserParam, CRHitRemovalByPCA, ems::EMShower3D, trkf::Track3DKalmanHit, trkf::TrackStitcher, hit::GausHitFinder, cluster::EndPointModule, cluster::SmallClusterFinder, vertex::HarrisVertexFinder, trkf::MCSFitProducer, vertex::PrimaryVertexFinder, trkf::CCTrackMaker, evgen::NDKGen, hit::RawHitFinder, cosmic::CosmicClusterTagger, t0::MCParticleShowerMatching, t0::MCParticleTrackMatching, reco3d::SpacePointSolver, cosmic::CosmicPCAxisTagger, shwf::ShowerFinder, cosmic::CosmicTrackTagger, trkf::Track3Dreco, trkf::TrackKalmanCheater, vertex::VertexMatch, evgen::NucleonDecay, opdet::OpHitFinder, event::AggregateEvent, shower::EMShower, cosmic::CosmicPFParticleTagger, evgen::NUANCEGen, trkf::SpacePts, TrackProducerFromPFParticle, cluster::BlurredClustering, cluster::ClusterCrawler, cluster::fuzzyCluster, evgen::FileMuons, phot::PhotonLibraryPropagation, cluster::LineMerger, butcher::EventButcher, cosmic::TrackPFParticleMatch, t0::MCParticleHitMatching, caldata::CalWireT962, cluster::DBcluster, cluster::FuzzyClusterMerger, ShowerReco3D, CRHitRemoval, opdet::OpFlashFinder, caldata::CalWire, calo::GeneralCalorimetry, trkf::FeatureTracker, TrackProducerFromTrackTrajectory, vertex::AggregateVertex, wc::MergeWireCell, evgen::CORSIKAGen, cosmic::BeamFlashTrackMatchTagger, calo::TrackCalorimetry, hit::FFTHitFinder, TrackProducerFromTrack, evwgh::EventWeight, opdet::OptDetDigitizer, pid::Chi2ParticleID, lar::example::Disturbance, calo::BezierCalorimetry, cluster::ClusterCheater, cluster::TrajCluster, evgen::CosmicsGen, opdet::OpticalRawDigitReformatter, trkf::TrackCheater, evgen::SNNueAr40CCGen, hit::HitCheater, noisefilteralg::WireCellNoiseFilter, trkf::BezierTrackerModule, spacecharge::ShiftEdepSCE, opdet::BeamFlashCompatabilityCheck, cluster::LineCluster, tss::TrackShowerHits, sppt::TTSpacePointFinder, trkf::SpacePointCheater, trkf::SpacePointFinder, sim::MergeSimSources, opdet::TrackTimeAssoc, apa::APAHitFinder, event::EventCheater, shwf::ShowerCheater, hit::RFFHitFinder, vertex::CornerFinder, opdet::OpMCDigi, cluster::SimpleClusterMerger, trkf::TCTrack, ToyOneShowerGen, art::RandomNumberSaver, trk::TrackContainmentTagger, vertex::VertexCheater, hit::TTHitFinder, trkf::SeedFinderModule, mvapid::MVAPID, lar_pandora::LArPandoraShowerCreation, hit::DisambigCheater, hit::HitFinder, hit::MCHitFinder, lar_pandora::LArPandora, art::TriggerResultInserter, opdet::FlashClusterMatch, lar_pandora::LArPandoraTrackCreation, MCReco, opdet::BoDataFrameInput, lar_pandora::CollectionSplitting, lar_pandora::CollectionMerging, cheat::BackTrackerLoader, cheat::PhotonBackTrackerLoader, event::EventMaker, wcls::WireCellToolkit, and bogoblip::BlipMaker.

Referenced by doEvent(), and workerType().

virtual void art::EDProducer::respondToCloseInputFile ( FileBlock const & )

inlineprivatevirtual

Definition at line 96 of file EDProducer.h.

Referenced by doRespondToCloseInputFile().

97 {}

virtual void art::EDProducer::respondToCloseOutputFiles ( FileBlock const & )

inlineprivatevirtual

Definition at line 102 of file EDProducer.h.

Referenced by doRespondToCloseOutputFiles().

103 {}

virtual void art::EDProducer::respondToOpenInputFile ( FileBlock const & )

inlineprivatevirtual

Definition at line 93 of file EDProducer.h.

Referenced by doRespondToOpenInputFile().

94 {}

virtual void art::EDProducer::respondToOpenOutputFiles ( FileBlock const & )

inlineprivatevirtual

Definition at line 99 of file EDProducer.h.

Referenced by doRespondToOpenOutputFiles().

100 {}

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

inlineprivate

Definition at line 106 of file EDProducer.h.

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

     {
       moduleDescription_ = md;
       // Since the module description in the Consumer base class is
       // owned by pointer, we must give it the owned object of this
       // class--i.e. moduleDescription_, not md.
       Consumer::setModuleDescription(moduleDescription_);
     }

void art::Consumer::showMissingConsumes ( ) const

protectedinherited

Definition at line 125 of file Consumer.cc.

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

 {
   if (!moduleContext_)
     return;
 
   // If none of the branches have missing consumes statements, exit early.
   if (std::all_of(cbegin(missingConsumes_),
                   cend(missingConsumes_),
                   [](auto const& perBranch) { return perBranch.empty(); }))
     return;
 
   constexpr cet::HorizontalRule rule{60};
   mf::LogPrint log{"MTdiagnostics"};
   log << '\n'
       << rule('=') << '\n'
       << "The following consumes (or mayConsume) statements are missing from\n"
       << module_context(moduleDescription_) << '\n'
       << rule('-') << '\n';
 
   cet::for_all_with_index(
     missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
       for (auto const& pi : perBranch) {
         log << "  "
             << assemble_consumes_statement(static_cast<BranchType>(i), pi)
             << '\n';
       }
     });
   log << rule('=');
 }

void art::Consumer::validateConsumedProduct	(	BranchType const	bt,
		ProductInfo const &	pi
	)

protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

 {
   // Early exits if consumes tracking has been disabled or if the
   // consumed product is an allowed consumable.
   if (!moduleContext_)
     return;
 
   if (cet::binary_search_all(consumables_[bt], pi))
     return;
 
   if (requireConsumes_) {
     throw Exception(errors::ProductRegistrationFailure,
                     "Consumer: an error occurred during validation of a "
                     "retrieved product\n\n")
       << "The following consumes (or mayConsume) statement is missing from\n"
       << module_context(moduleDescription_) << ":\n\n"
       << "  " << assemble_consumes_statement(bt, pi) << "\n\n";
   }
 
   missingConsumes_[bt].insert(pi);
 }

std::string art::EDProducer::workerType ( ) const

inlineprivate

Definition at line 66 of file EDProducer.h.

References produce().

     {
       return "WorkerT<EDProducer>";
     }

Friends And Related Function Documentation

template<typename T >

friend class WorkerT

friend

Definition at line 33 of file EDProducer.h.

Member Data Documentation

bool art::EDProducer::checkPutProducts_ {true}

private

Definition at line 117 of file EDProducer.h.

Referenced by doBeginJob(), and doEvent().

CPC_exempt_ptr art::EDProducer::current_context_ {nullptr}

private

Definition at line 116 of file EDProducer.h.

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

std::set<TypeLabel> art::EDProducer::missingConsumes_ {}

private

Definition at line 118 of file EDProducer.h.

ModuleDescription art::EDProducer::moduleDescription_ {}

private

Definition at line 115 of file EDProducer.h.

Referenced by doBeginJob(), doBeginRun(), doBeginSubRun(), doEndRun(), doEndSubRun(), doEvent(), getProductID(), and setModuleDescription().

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

art/Framework/Core/EDProducer.h
art/Framework/Core/EDProducer.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation