#include "Analyzer.h"

Inheritance diagram for art::detail::Analyzer:

Classes
class	Table

Public Member Functions
virtual	~Analyzer () noexcept

	Analyzer (fhicl::ParameterSet const &pset)

template<typename Config >
	Analyzer (Table< Config > const &config)

void	doBeginJob (SharedResources const &resources)

void	doEndJob ()

void	doRespondToOpenInputFile (FileBlock const &fb)

void	doRespondToCloseInputFile (FileBlock const &fb)

void	doRespondToOpenOutputFiles (FileBlock const &fb)

void	doRespondToCloseOutputFiles (FileBlock const &fb)

bool	doBeginRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)

ModuleDescription const &	moduleDescription () const

void	setModuleDescription (ModuleDescription const &)

std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const

void	sortConsumables (std::string const &current_process_name)

std::unique_ptr< Worker >	makeWorker (WorkerParams const &wp)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Protected Member Functions
std::string const &	processName () const

bool	wantAllEvents () const noexcept

bool	wantEvent (ScheduleID id, Event const &e) const

Handle< TriggerResults >	getTriggerResults (Event const &e) const

ConsumesCollector &	consumesCollector ()

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 Member Functions
virtual void	setupQueues (SharedResources const &)=0

virtual void	analyzeWithFrame (Event const &, ProcessingFrame const &)=0

virtual void	beginJobWithFrame (ProcessingFrame const &)=0

virtual void	endJobWithFrame (ProcessingFrame const &)=0

virtual void	respondToOpenInputFileWithFrame (FileBlock const &, ProcessingFrame const &)=0

virtual void	respondToCloseInputFileWithFrame (FileBlock const &, ProcessingFrame const &)=0

virtual void	respondToOpenOutputFilesWithFrame (FileBlock const &, ProcessingFrame const &)=0

virtual void	respondToCloseOutputFilesWithFrame (FileBlock const &, ProcessingFrame const &)=0

virtual void	beginRunWithFrame (Run const &, ProcessingFrame const &)=0

virtual void	endRunWithFrame (Run const &, ProcessingFrame const &)=0

virtual void	beginSubRunWithFrame (SubRun const &, ProcessingFrame const &)=0

virtual void	endSubRunWithFrame (SubRun const &, ProcessingFrame const &)=0

Detailed Description

Definition at line 34 of file Analyzer.h.

Constructor & Destructor Documentation

art::detail::Analyzer::~Analyzer ( )

virtualdefaultnoexcept

art::detail::Analyzer::Analyzer ( fhicl::ParameterSet const & pset )

explicit

Definition at line 22 of file Analyzer.cc.

22 : Observer{pset} {}

art::Observer::Observer

Observer(Observer const &)=delete

template<typename Config >

art::detail::Analyzer::Analyzer ( Table< Config > const & config )

inlineexplicit

Definition at line 93 of file Analyzer.h.

References analyzeWithFrame(), beginJobWithFrame(), beginRunWithFrame(), beginSubRunWithFrame(), doBeginJob(), doBeginRun(), doBeginSubRun(), doEndJob(), doEndRun(), doEndSubRun(), doEvent(), doRespondToCloseInputFile(), doRespondToCloseOutputFiles(), doRespondToOpenInputFile(), doRespondToOpenOutputFiles(), endJobWithFrame(), endRunWithFrame(), endSubRunWithFrame(), fb(), respondToCloseInputFileWithFrame(), respondToCloseOutputFilesWithFrame(), respondToOpenInputFileWithFrame(), respondToOpenOutputFilesWithFrame(), and setupQueues().

94 : Observer{config.eoFragment().selectEvents(), config.get_PSet()}

95 {}

art::Observer::Observer

Observer(Observer const &)=delete

Member Function Documentation

virtual void art::detail::Analyzer::analyzeWithFrame	(	Event const &	,
		ProcessingFrame const &
	)

privatepure virtual

Implemented in art::ReplicatedAnalyzer, art::EDAnalyzer, and art::SharedAnalyzer.

Referenced by Analyzer().

virtual void art::detail::Analyzer::beginJobWithFrame ( ProcessingFrame const & )

privatepure virtual

Implemented in art::ReplicatedAnalyzer, art::EDAnalyzer, and art::SharedAnalyzer.

Referenced by Analyzer().

virtual void art::detail::Analyzer::beginRunWithFrame	(	Run const &	,
		ProcessingFrame const &
	)

privatepure virtual

Implemented in art::ReplicatedAnalyzer, art::EDAnalyzer, and art::SharedAnalyzer.

Referenced by Analyzer().

virtual void art::detail::Analyzer::beginSubRunWithFrame	(	SubRun const &	,
		ProcessingFrame const &
	)

privatepure virtual

Implemented in art::ReplicatedAnalyzer, art::EDAnalyzer, and art::SharedAnalyzer.

Referenced by Analyzer().

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

   {
     return collector_.consumes<T, BT>(tag);
   }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

   {
     return collector_;
   }

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

   {
     collector_.consumesMany<T, BT>();
   }

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

   {
     return collector_.consumesView<T, BT>(tag);
   }

void art::detail::Analyzer::doBeginJob ( SharedResources const & resources )

Definition at line 25 of file Analyzer.cc.

Referenced by Analyzer().

   {
     setupQueues(resources);
     ProcessingFrame const frame{ScheduleID{}};
     beginJobWithFrame(frame);
   }

bool art::detail::Analyzer::doBeginRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

Definition at line 68 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     beginRunWithFrame(std::as_const(rp).makeRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doBeginSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

Definition at line 84 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     beginSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
     return true;
   }

void art::detail::Analyzer::doEndJob ( )

Definition at line 33 of file Analyzer.cc.

Referenced by Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     endJobWithFrame(frame);
   }

bool art::detail::Analyzer::doEndRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

Definition at line 76 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     endRunWithFrame(std::as_const(rp).makeRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doEndSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

Definition at line 92 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     endSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doEvent	(	EventPrincipal &	ep,
		ModuleContext const &	mc,
		std::atomic< std::size_t > &	counts_run,
		std::atomic< std::size_t > &	counts_passed,
		std::atomic< std::size_t > &	counts_failed
	)

Definition at line 100 of file Analyzer.cc.

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

Referenced by Analyzer().

   {
     auto const e = std::as_const(ep).makeEvent(mc);
     if (wantEvent(mc.scheduleID(), e)) {
       ++counts_run;
       ProcessingFrame const frame{mc.scheduleID()};
       analyzeWithFrame(e, frame);
       ++counts_passed;
     }
     return true;
   }

void art::detail::Analyzer::doRespondToCloseInputFile ( FileBlock const & fb )

Definition at line 47 of file Analyzer.cc.

Referenced by Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseInputFileWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToCloseOutputFiles ( FileBlock const & fb )

Definition at line 61 of file Analyzer.cc.

Referenced by Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseOutputFilesWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToOpenInputFile ( FileBlock const & fb )

Definition at line 40 of file Analyzer.cc.

Referenced by Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenInputFileWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToOpenOutputFiles ( FileBlock const & fb )

Definition at line 54 of file Analyzer.cc.

Referenced by Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenOutputFilesWithFrame(fb, frame);
   }

virtual void art::detail::Analyzer::endJobWithFrame ( ProcessingFrame const & )

privatepure virtual

Implemented in art::ReplicatedAnalyzer, art::EDAnalyzer, and art::SharedAnalyzer.

Referenced by Analyzer().

virtual void art::detail::Analyzer::endRunWithFrame	(	Run const &	,
		ProcessingFrame const &
	)

privatepure virtual

Implemented in art::ReplicatedAnalyzer, art::EDAnalyzer, and art::SharedAnalyzer.

Referenced by Analyzer().

virtual void art::detail::Analyzer::endSubRunWithFrame	(	SubRun const &	,
		ProcessingFrame const &
	)

privatepure virtual

Implemented in art::ReplicatedAnalyzer, art::EDAnalyzer, and art::SharedAnalyzer.

Referenced by Analyzer().

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

   {
     return collector_.getConsumables();
   }

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

protectedinherited

Definition at line 75 of file Observer.cc.

References art::ProductRetriever::get(), and art::Observer::selectors_.

Referenced by art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (selectors_) {
       return selectors_->getOneTriggerResults(e);
     }
 
     // The following applies for cases where no SelectEvents entries
     // exist.
     Handle<TriggerResults> h;
     if (e.get(empty_process_name, h)) {
       return h;
     }
     return Handle<TriggerResults>{};
   }

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.

   {
     return doMakeWorker(wp);
   }

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

   {
     return collector_.mayConsume<T, BT>(tag);
   }

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

   {
     collector_.mayConsumeMany<T, BT>();
   }

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

   {
     return collector_.mayConsumeView<T, BT>(tag);
   }

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

   {
     if (md_.has_value()) {
       return *md_;
     }
 
     throw Exception{errors::LogicError,
                     "There was an error while calling moduleDescription().\n"}
       << "The moduleDescription() base-class member function cannot be called\n"
          "during module construction.  To determine which module is "
          "responsible\n"
          "for calling it, find the '<module type>:<module "
          "label>@Construction'\n"
          "tag in the message prefix above.  Please contact artists@fnal.gov\n"
          "for guidance.\n";
   }

string const & art::Observer::processName ( ) const

protectedinherited

Definition at line 57 of file Observer.cc.

References art::Observer::process_name_.

Referenced by art::FileDumperOutput::printPrincipal().

   {
     return process_name_;
   }

virtual void art::detail::Analyzer::respondToCloseInputFileWithFrame	(	FileBlock const &	,
		ProcessingFrame const &
	)

privatepure virtual

Implemented in art::ReplicatedAnalyzer, art::EDAnalyzer, and art::SharedAnalyzer.

Referenced by Analyzer().

virtual void art::detail::Analyzer::respondToCloseOutputFilesWithFrame	(	FileBlock const &	,
		ProcessingFrame const &
	)

privatepure virtual

Implemented in art::ReplicatedAnalyzer, art::EDAnalyzer, and art::SharedAnalyzer.

Referenced by Analyzer().

virtual void art::detail::Analyzer::respondToOpenInputFileWithFrame	(	FileBlock const &	,
		ProcessingFrame const &
	)

privatepure virtual

Implemented in art::ReplicatedAnalyzer, art::EDAnalyzer, and art::SharedAnalyzer.

Referenced by Analyzer().

virtual void art::detail::Analyzer::respondToOpenOutputFilesWithFrame	(	FileBlock const &	,
		ProcessingFrame const &
	)

privatepure virtual

Implemented in art::ReplicatedAnalyzer, art::EDAnalyzer, and art::SharedAnalyzer.

Referenced by Analyzer().

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

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

virtual void art::detail::Analyzer::setupQueues ( SharedResources const & )

privatepure virtual

Implemented in art::ReplicatedAnalyzer, art::EDAnalyzer, and art::SharedAnalyzer.

Referenced by Analyzer().

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

   {
     // Now that we know we have seen all the consumes declarations,
     // sort the results for fast lookup later.
     collector_.sortConsumables(current_process_name);
   }

bool art::Observer::wantAllEvents ( ) const

inlineprotectednoexceptinherited

Definition at line 31 of file Observer.h.

References e, art::Observer::getTriggerResults(), art::Observer::wantAllEvents_, and art::Observer::wantEvent().

     {
       return wantAllEvents_;
     }

bool art::Observer::wantEvent	(	ScheduleID	id,
		Event const &	e
	)		const

protectedinherited

Definition at line 63 of file Observer.cc.

References art::Observer::rejectors_, art::Observer::selectors_, and art::Observer::wantAllEvents_.

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

   {
     if (wantAllEvents_) {
       return true;
     }
     bool const select_event = selectors_ ? selectors_->matchEvent(id, e) : true;
     bool const reject_event =
       rejectors_ ? rejectors_->matchEvent(id, e) : false;
     return select_event and not reject_event;
   }

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

art/Framework/Core/detail/Analyzer.h
art/Framework/Core/detail/Analyzer.cc

Classes

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation