art::EDAnalyzer Class Reference

#include "EDAnalyzer.h"

Inheritance diagram for art::EDAnalyzer:

Classes
class	Table

Public Types
using	WorkerType = WorkerT< EDAnalyzer >
using	ModuleType = EDAnalyzer

Public Member Functions
template<typename Config >
	EDAnalyzer (Table< Config > const &config)
	EDAnalyzer (fhicl::ParameterSet const &pset)
virtual	~EDAnalyzer ()=default
std::string	workerType () const
bool	modifiesEvent () const
void	registerProducts (MasterProductRegistry &, ProductDescriptions &, ModuleDescription const &)
std::string const &	processName () const
bool	wantAllEvents () const
bool	wantEvent (Event const &e)
fhicl::ParameterSetID	selectorConfig () const
art::Handle< art::TriggerResults >	getTriggerResults (Event const &e) 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
detail::CachedProducts &	cachedProducts ()
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 const &ep, CPC_exempt_ptr cpc, CountingStatistics &)
void	doBeginJob ()
void	doEndJob ()
bool	doBeginRun (RunPrincipal const &rp, CPC_exempt_ptr cpc)
bool	doEndRun (RunPrincipal const &rp, CPC_exempt_ptr cpc)
bool	doBeginSubRun (SubRunPrincipal const &srp, CPC_exempt_ptr cpc)
bool	doEndSubRun (SubRunPrincipal const &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)
virtual void	analyze (Event const &)=0
virtual void	beginJob ()
virtual void	endJob ()
virtual void	beginRun (Run const &)
virtual void	endRun (Run const &)
virtual void	beginSubRun (SubRun const &)
virtual void	endSubRun (SubRun const &)
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}

Friends
template<typename T >
class	WorkerT

Detailed Description

Definition at line 31 of file EDAnalyzer.h.

Member Typedef Documentation

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

private

Definition at line 120 of file EDAnalyzer.h.

using art::EDAnalyzer::ModuleType = EDAnalyzer

Definition at line 39 of file EDAnalyzer.h.

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

Definition at line 38 of file EDAnalyzer.h.

Constructor & Destructor Documentation

template<typename Config >

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

inlineexplicit

Definition at line 100 of file EDAnalyzer.h.

References art::EDAnalyzer::Table< UserConfig, UserKeysToIgnore >::eoFragment(), art::EDAnalyzer::Table< UserConfig, UserKeysToIgnore >::get_PSet(), and ~EDAnalyzer().

      : EventObserverBase{config.eoFragment().selectEvents(), config.get_PSet()}
    {}

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

explicit

Definition at line 13 of file EDAnalyzer.cc.

    : EventObserverBase{pset}
  {}

virtual art::EDAnalyzer::~EDAnalyzer ( )

virtualdefault

Referenced by EDAnalyzer().

Member Function Documentation

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

privatepure virtual

Implemented in ClusteringValidation::ClusteringValidation, ems::MultiEMShowers, sim::DumpMCShowers, detsim::DumpRawDigits, caldata::DumpWires, sim::DumpMCTracks, sim::DumpMCParticles, opdet::SimPhotonCounter, sim::DumpGTruth, recob::DumpChargedSpacePoints, NuShowerEff, sim::DumpMCTruth, sim::DumpSimPhotonsLite, evd::Landed, lar::example::Exploder, RecoProxyUsageExample, sim::DumpOpDetBacktrackerRecords, sim::DumpSimChannels, sim::DumpSimPhotons, geo::DumpGeometry, geo::DumpChannelMap, rwgt::ReweightAna, evd::EVD, hit::HitAnaModule, ShowerQuality, cluster::ClusterPCA, larg4::ISCalculationAna, opdet::FlashHypothesisAna, cheat::RecoCheckAna, trk::TrackContainmentAnalyzer, MCBTDemo, lar_pandora::LArPandoraEventDump, calo::PrintCalorimetry, opdet::OpFlashSimpleAna, cheat::CheckBackTracking, pid::PIDAAnalyzer, and hit::MCHitAnaExample.

Referenced by doEvent().

virtual void art::EDAnalyzer::beginJob ( )

inlineprivatevirtual

Reimplemented in ClusteringValidation::ClusteringValidation, lar::example::AnalysisExample, ems::MultiEMShowers, detsim::DumpRawDigits, vertex::FeatureVertexFinderAna, opdet::SimPhotonCounter, wc::CellTree, NuShowerEff, cluster::HoughLineFinderAna, evd::Landed, hit::GausHitFinderAna, hit::HitFinderAna, cluster::DBclusterAna, pmtana::PMTAna, geo::DumpGeometry, detsim::WienerFilterAna, hit::MagDriftAna, DUNE::MuonTrackingEff, cluster::ClusterAna, pfpf::PFPAna, DUNE::NeutrinoTrackingEff, larg::LArSimChannelAna, larg4::LArG4Ana, microboone::CosmicRemovalAna, detsim::SimWireAna, opdet::FlashPurityCheckAna, opdet::LEDCalibrationAna, caldata::CalWireAna, shower::TCShowerAnalysis, opdet::OpFlashAna, shower::TCShowerElectronLikelihood, rwgt::ReweightAna, opdet::OpDigiAna, shower::TCShowerTemplateMaker, opdet::TrackTimeAssocAna, evd::EVD, opdet::FIFOHistogramAna, hit::HitAnaModule, DUNE::NeutrinoShowerEff, ShowerQuality, vertex::AggregateVertexAna, larg4::ISCalculationAna, opdet::FlashHypothesisAna, cluster::ClusterPCA, opreco::OpticalRecoAna, phot::PhotonLibraryAnalyzer, opdet::OpFlashSimpleAna, pid::PIDAAnalyzer, lar_pandora::PFParticleAnalysis, lar_pandora::PFParticleHitDumper, lar_pandora::PFParticleMonitoring, lar_pandora::PFParticleCosmicAna, opdet::OpFlashMCTruthAna, lar_pandora::PFParticleValidation, opdet::OpHitAna, and lar_pandora::PFParticleTrackAna.

Definition at line 138 of file EDAnalyzer.h.

Referenced by doBeginJob().

    {}

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

inlineprivatevirtual

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

Definition at line 144 of file EDAnalyzer.h.

Referenced by doBeginRun().

    {}

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

inlineprivatevirtual

Reimplemented in rwgt::ReweightAna.

Definition at line 150 of file EDAnalyzer.h.

Referenced by doBeginSubRun().

    {}

detail::CachedProducts& art::EventObserverBase::cachedProducts ( )

inlineprotectedinherited

Definition at line 79 of file EventObserverBase.h.

References art::EventObserverBase::selectors_.

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

  {
    return selectors_;
  }

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

protected

Definition at line 114 of file EDAnalyzer.cc.

References current_context_.

Referenced by workerType().

  {
    return current_context_.get();
  }

void art::EDAnalyzer::doBeginJob ( )

private

Definition at line 36 of file EDAnalyzer.cc.

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

  {
    auto const& mainID = moduleDescription_.mainParameterSetID();
    auto const& scheduler_pset =
      fhicl::ParameterSetRegistry::get(mainID).get<fhicl::ParameterSet>(
        "services.scheduler");
    prepareForJob(scheduler_pset);
    beginJob();
  }

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

private

Definition at line 54 of file EDAnalyzer.cc.

References beginRun(), current_context_, and moduleDescription_.

  {
    detail::CPCSentry sentry{current_context_, cpc};
    Run const r{rp, moduleDescription_, this};
    beginRun(r);
    return true;
  }

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

private

Definition at line 72 of file EDAnalyzer.cc.

References beginSubRun(), current_context_, and moduleDescription_.

  {
    detail::CPCSentry sentry{current_context_, cpc};
    SubRun const sr{srp, moduleDescription_, this};
    beginSubRun(sr);
    return true;
  }

void art::EDAnalyzer::doEndJob ( )

private

Definition at line 47 of file EDAnalyzer.cc.

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

  {
    endJob();
    showMissingConsumes();
  }

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

private

Definition at line 63 of file EDAnalyzer.cc.

References current_context_, endRun(), and moduleDescription_.

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

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

private

Definition at line 81 of file EDAnalyzer.cc.

References current_context_, endSubRun(), and moduleDescription_.

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

bool art::EDAnalyzer::doEvent ( EventPrincipal const &  ep, CPC_exempt_ptr  cpc, CountingStatistics &  counts  )

private

Definition at line 18 of file EDAnalyzer.cc.

References analyze(), art::EventObserverBase::cachedProducts(), current_context_, e, art::ExecutionCounts< ARGS >::increment(), moduleDescription_, art::EventObserverBase::wantAllEvents(), and art::EventObserverBase::wantEvent().

  {
    detail::CPCSentry sentry{current_context_, cpc};
    detail::PVSentry pvSentry{cachedProducts()};
    Event const e{ep, moduleDescription_, this};
    if (wantAllEvents() || wantEvent(e)) {
      // Run is incremented before analyze(e); to properly count
      // whenever an exception is thrown in the user's module.
      counts.increment<stats::Run>();
      analyze(e);
      counts.increment<stats::Passed>();
    }
    return true;
  }

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

private

Definition at line 96 of file EDAnalyzer.cc.

References respondToCloseInputFile().

  {
    respondToCloseInputFile(fb);
  }

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

private

Definition at line 108 of file EDAnalyzer.cc.

References respondToCloseOutputFiles().

  {
    respondToCloseOutputFiles(fb);
  }

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

private

Definition at line 90 of file EDAnalyzer.cc.

References respondToOpenInputFile().

  {
    respondToOpenInputFile(fb);
  }

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

private

Definition at line 102 of file EDAnalyzer.cc.

References respondToOpenOutputFiles().

  {
    respondToOpenOutputFiles(fb);
  }

virtual void art::EDAnalyzer::endJob ( )

inlineprivatevirtual

Reimplemented in ClusteringValidation::ClusteringValidation, trkf::TrackAna, trkf::SeedAna, ems::MultiEMShowers, sim::DumpMCParticles, opdet::SimPhotonCounter, wc::CellTree, NuShowerEff, evd::Landed, detsim::WienerFilterAna, hit::MagDriftAna, DUNE::MuonTrackingEff, cluster::ClusterAna, DUNE::NeutrinoTrackingEff, larg::LArSimChannelAna, opdet::LEDCalibrationAna, caldata::CalWireAna, rwgt::ReweightAna, DUNE::NeutrinoShowerEff, phot::PhotonLibraryAnalyzer, lar_pandora::PFParticleAnalysis, lar_pandora::PFParticleHitDumper, lar_pandora::PFParticleMonitoring, lar_pandora::PFParticleCosmicAna, lar_pandora::PFParticleValidation, and lar_pandora::PFParticleTrackAna.

Definition at line 141 of file EDAnalyzer.h.

Referenced by doEndJob().

    {}

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

inlineprivatevirtual

Definition at line 147 of file EDAnalyzer.h.

Referenced by doEndRun().

    {}

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

inlineprivatevirtual

Reimplemented in rwgt::ReweightAna.

Definition at line 153 of file EDAnalyzer.h.

Referenced by doEndSubRun().

    {}

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

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

inlineinherited

Definition at line 61 of file EventObserverBase.h.

References art::detail::CachedProducts::getOneTriggerResults(), and art::EventObserverBase::selectors_.

Referenced by art::OutputModule::doWriteEvent().

  {
    return selectors_.getOneTriggerResults(e);
  }

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::EventObserverBase::modifiesEvent ( ) const

inlineinherited

Definition at line 25 of file EventObserverBase.h.

  {
    return false;
  }

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

staticinherited

Definition at line 76 of file Consumer.cc.

Referenced by art::RootOutput::beginSubRun(), art::OutputModule::doBeginRun(), art::OutputModule::doBeginSubRun(), art::OutputModule::doEndRun(), art::OutputModule::doEndSubRun(), art::ProducingService::doPostReadEvent(), art::ProducingService::doPostReadRun(), art::ProducingService::doPostReadSubRun(), art::OutputModule::doWriteEvent(), art::ProcessPackage< L >::postScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::Run >::End::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::End::postScheduleSignal(), art::ProcessPackage< L >::preScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::preScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::preScheduleSignal(), art::EventProcessor::readEvent(), art::EventProcessor::readRun(), art::EmptyEvent::readRun_(), art::EventProcessor::readSubRun(), and art::EmptyEvent::readSubRun_().

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

{
  if (!moduleContext_)
    return;

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

std::string const& art::EventObserverBase::processName ( ) const

inlineinherited

Definition at line 41 of file EventObserverBase.h.

References art::EventObserverBase::process_name_.

Referenced by art::FileDumperOutput::printPrincipal(), and art::RootOutput::RootOutput().

  {
    return process_name_;
  }

void art::EventObserverBase::registerProducts ( MasterProductRegistry &  , ProductDescriptions &  , ModuleDescription const &    )

inlineinherited

Definition at line 33 of file EventObserverBase.h.

  {}

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

inlineprivatevirtual

Definition at line 159 of file EDAnalyzer.h.

Referenced by doRespondToCloseInputFile().

    {}

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

inlineprivatevirtual

Definition at line 165 of file EDAnalyzer.h.

Referenced by doRespondToCloseOutputFiles().

    {}

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

inlineprivatevirtual

Definition at line 156 of file EDAnalyzer.h.

Referenced by doRespondToOpenInputFile().

    {}

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

inlineprivatevirtual

Definition at line 162 of file EDAnalyzer.h.

Referenced by doRespondToOpenOutputFiles().

    {}

fhicl::ParameterSetID art::EventObserverBase::selectorConfig ( ) const

inlineinherited

Definition at line 56 of file EventObserverBase.h.

References art::EventObserverBase::selector_config_id_.

Referenced by art::RootOutputFile::writeOne().

  {
    return selector_config_id_;
  }

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

inlineprivate

Definition at line 169 of file EDAnalyzer.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 art::EDProducer::doEndJob(), art::EDFilter::doEndJob(), 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);
}

bool art::EventObserverBase::wantAllEvents ( ) const

inlineinherited

Definition at line 46 of file EventObserverBase.h.

References art::EventObserverBase::wantAllEvents_.

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

  {
    return wantAllEvents_;
  }

bool art::EventObserverBase::wantEvent ( Event const &  e )

inlineinherited

Definition at line 51 of file EventObserverBase.h.

References art::EventObserverBase::selectors_, and art::detail::CachedProducts::wantEvent().

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

  {
    return selectors_.wantEvent(e);
  }

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

inline

Definition at line 109 of file EDAnalyzer.h.

References currentContext().

    {
      return "WorkerT<EDAnalyzer>";
    }

Friends And Related Function Documentation

template<typename T >

friend class WorkerT

friend

Definition at line 36 of file EDAnalyzer.h.

Member Data Documentation

CPC_exempt_ptr art::EDAnalyzer::current_context_ {nullptr}

private

Definition at line 179 of file EDAnalyzer.h.

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

ModuleDescription art::EDAnalyzer::moduleDescription_ {}

private

Definition at line 178 of file EDAnalyzer.h.

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

---

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

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