Public Types | Public Member Functions | Private Member Functions | List of all members
art::ReplicatedAnalyzer Class Referenceabstract

#include <ReplicatedAnalyzer.h>

Inheritance diagram for art::ReplicatedAnalyzer:
art::detail::Analyzer art::detail::EngineCreator art::Observer art::ModuleBase

Public Types

using WorkerType = WorkerT< ReplicatedAnalyzer >
 
using ModuleType = ReplicatedAnalyzer
 

Public Member Functions

 ReplicatedAnalyzer (fhicl::ParameterSet const &pset, ProcessingFrame const &frame)
 
template<typename Config >
 ReplicatedAnalyzer (Table< Config > const &config, ProcessingFrame const &frame)
 
std::string workerType () const
 
- Public Member Functions inherited from art::detail::Analyzer
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)
 
- Public Member Functions inherited from art::Observer
 ~Observer () noexcept
 
 Observer (Observer const &)=delete
 
 Observer (Observer &&)=delete
 
Observeroperator= (Observer const &)=delete
 
Observeroperator= (Observer &&)=delete
 
void registerProducts (ProductDescriptions &, ModuleDescription const &)
 
void fillDescriptions (ModuleDescription const &)
 
fhicl::ParameterSetID selectorConfig () const
 
- Public Member Functions inherited from art::ModuleBase
virtual ~ModuleBase () noexcept
 
 ModuleBase ()
 
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)
 
template<typename T , BranchType BT>
ViewToken< T > consumesView (InputTag const &tag)
 
template<typename T , BranchType BT>
ViewToken< T > mayConsumeView (InputTag const &tag)
 

Private Member Functions

void setupQueues (detail::SharedResources const &resources) override final
 
void beginJobWithFrame (ProcessingFrame const &) override final
 
void endJobWithFrame (ProcessingFrame const &) override final
 
void respondToOpenInputFileWithFrame (FileBlock const &, ProcessingFrame const &) override final
 
void respondToCloseInputFileWithFrame (FileBlock const &, ProcessingFrame const &) override final
 
void respondToOpenOutputFilesWithFrame (FileBlock const &, ProcessingFrame const &) override final
 
void respondToCloseOutputFilesWithFrame (FileBlock const &, ProcessingFrame const &) override final
 
void beginRunWithFrame (Run const &, ProcessingFrame const &) override final
 
void endRunWithFrame (Run const &, ProcessingFrame const &) override final
 
void beginSubRunWithFrame (SubRun const &, ProcessingFrame const &) override final
 
void endSubRunWithFrame (SubRun const &, ProcessingFrame const &) override final
 
void analyzeWithFrame (Event const &, ProcessingFrame const &) override final
 
virtual void beginJob (ProcessingFrame const &)
 
virtual void endJob (ProcessingFrame const &)
 
virtual void respondToOpenInputFile (FileBlock const &, ProcessingFrame const &)
 
virtual void respondToCloseInputFile (FileBlock const &, ProcessingFrame const &)
 
virtual void respondToOpenOutputFiles (FileBlock const &, ProcessingFrame const &)
 
virtual void respondToCloseOutputFiles (FileBlock const &, ProcessingFrame const &)
 
virtual void beginRun (Run const &, ProcessingFrame const &)
 
virtual void endRun (Run const &, ProcessingFrame const &)
 
virtual void beginSubRun (SubRun const &, ProcessingFrame const &)
 
virtual void endSubRun (SubRun const &, ProcessingFrame const &)
 
virtual void analyze (Event const &, ProcessingFrame const &)=0
 
- Private Member Functions inherited from art::detail::EngineCreator
 EngineCreator (std::string const &label, ScheduleID sid)
 
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)
 

Additional Inherited Members

- Protected Member Functions inherited from art::Observer
std::string const & processName () const
 
bool wantAllEvents () const noexcept
 
bool wantEvent (ScheduleID id, Event const &e) const
 
Handle< TriggerResultsgetTriggerResults (Event const &e) const
 
 Observer (fhicl::ParameterSet const &config)
 
 Observer (std::vector< std::string > const &select_paths, std::vector< std::string > const &reject_paths, fhicl::ParameterSet const &config)
 
- Protected Member Functions inherited from art::ModuleBase
ConsumesCollectorconsumesCollector ()
 
template<typename T , BranchType = InEvent>
ProductToken< T > consumes (InputTag const &)
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > consumesView (InputTag const &)
 
template<typename T , BranchType = InEvent>
void consumesMany ()
 
template<typename T , BranchType = InEvent>
ProductToken< T > mayConsume (InputTag const &)
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > mayConsumeView (InputTag const &)
 
template<typename T , BranchType = InEvent>
void mayConsumeMany ()
 
- Private Types inherited from art::detail::EngineCreator
using base_engine_t = CLHEP::HepRandomEngine
 
using label_t = RNGsnapshot::label_t
 
using seed_t = long
 
using engine_state_t = RNGsnapshot::engine_state_t
 

Detailed Description

Definition at line 22 of file ReplicatedAnalyzer.h.

Member Typedef Documentation

Definition at line 26 of file ReplicatedAnalyzer.h.

Definition at line 25 of file ReplicatedAnalyzer.h.

Constructor & Destructor Documentation

art::ReplicatedAnalyzer::ReplicatedAnalyzer ( fhicl::ParameterSet const &  pset,
ProcessingFrame const &  frame 
)
inlineexplicit

Definition at line 28 of file ReplicatedAnalyzer.h.

30  : detail::Analyzer{pset}
31  , detail::EngineCreator{pset.get<std::string>("module_label"),
32  frame.scheduleID()}
33  {}
std::string string
Definition: nybbler.cc:12
template<typename Config >
art::ReplicatedAnalyzer::ReplicatedAnalyzer ( Table< Config > const &  config,
ProcessingFrame const &  frame 
)
inlineexplicit

Definition at line 36 of file ReplicatedAnalyzer.h.

38  : ReplicatedAnalyzer{config.get_PSet(), frame}
39  {}
ReplicatedAnalyzer(fhicl::ParameterSet const &pset, ProcessingFrame const &frame)
static Config * config
Definition: config.cpp:1054

Member Function Documentation

virtual void art::ReplicatedAnalyzer::analyze ( Event const &  ,
ProcessingFrame const &   
)
privatepure virtual
void art::ReplicatedAnalyzer::analyzeWithFrame ( Event const &  e,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Analyzer.

Definition at line 91 of file ReplicatedAnalyzer.cc.

93  {
94  analyze(e, frame);
95  }
virtual void analyze(Event const &, ProcessingFrame const &)=0
const double e
void art::ReplicatedAnalyzer::beginJob ( ProcessingFrame const &  )
privatevirtual

Definition at line 98 of file ReplicatedAnalyzer.cc.

99  {}
void art::ReplicatedAnalyzer::beginJobWithFrame ( ProcessingFrame const &  frame)
finaloverrideprivatevirtual

Implements art::detail::Analyzer.

Definition at line 51 of file ReplicatedAnalyzer.cc.

52  {
53  beginJob(frame);
54  }
virtual void beginJob(ProcessingFrame const &)
void art::ReplicatedAnalyzer::beginRun ( Run const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 126 of file ReplicatedAnalyzer.cc.

127  {}
void art::ReplicatedAnalyzer::beginRunWithFrame ( Run const &  r,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Analyzer.

Definition at line 63 of file ReplicatedAnalyzer.cc.

65  {
66  beginRun(r, frame);
67  }
virtual void beginRun(Run const &, ProcessingFrame const &)
void art::ReplicatedAnalyzer::beginSubRun ( SubRun const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 134 of file ReplicatedAnalyzer.cc.

135  {}
void art::ReplicatedAnalyzer::beginSubRunWithFrame ( SubRun const &  sr,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Analyzer.

Definition at line 77 of file ReplicatedAnalyzer.cc.

79  {
80  beginSubRun(sr, frame);
81  }
virtual void beginSubRun(SubRun const &, ProcessingFrame const &)
static constexpr double sr
Definition: Units.h:166
void art::ReplicatedAnalyzer::endJob ( ProcessingFrame const &  )
privatevirtual

Definition at line 102 of file ReplicatedAnalyzer.cc.

103  {}
void art::ReplicatedAnalyzer::endJobWithFrame ( ProcessingFrame const &  frame)
finaloverrideprivatevirtual

Implements art::detail::Analyzer.

Definition at line 57 of file ReplicatedAnalyzer.cc.

58  {
59  endJob(frame);
60  }
virtual void endJob(ProcessingFrame const &)
void art::ReplicatedAnalyzer::endRun ( Run const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 130 of file ReplicatedAnalyzer.cc.

131  {}
void art::ReplicatedAnalyzer::endRunWithFrame ( Run const &  r,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Analyzer.

Definition at line 70 of file ReplicatedAnalyzer.cc.

72  {
73  endRun(r, frame);
74  }
virtual void endRun(Run const &, ProcessingFrame const &)
void art::ReplicatedAnalyzer::endSubRun ( SubRun const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 138 of file ReplicatedAnalyzer.cc.

139  {}
void art::ReplicatedAnalyzer::endSubRunWithFrame ( SubRun const &  sr,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Analyzer.

Definition at line 84 of file ReplicatedAnalyzer.cc.

86  {
87  endSubRun(sr, frame);
88  }
virtual void endSubRun(SubRun const &, ProcessingFrame const &)
static constexpr double sr
Definition: Units.h:166
void art::ReplicatedAnalyzer::respondToCloseInputFile ( FileBlock const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 111 of file ReplicatedAnalyzer.cc.

113  {}
void art::ReplicatedAnalyzer::respondToCloseInputFileWithFrame ( FileBlock const &  fb,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Analyzer.

Definition at line 27 of file ReplicatedAnalyzer.cc.

30  {
31  respondToCloseInputFile(fb, frame);
32  }
virtual void respondToCloseInputFile(FileBlock const &, ProcessingFrame const &)
void art::ReplicatedAnalyzer::respondToCloseOutputFiles ( FileBlock const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 121 of file ReplicatedAnalyzer.cc.

123  {}
void art::ReplicatedAnalyzer::respondToCloseOutputFilesWithFrame ( FileBlock const &  fb,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Analyzer.

Definition at line 43 of file ReplicatedAnalyzer.cc.

46  {
47  respondToCloseOutputFiles(fb, frame);
48  }
virtual void respondToCloseOutputFiles(FileBlock const &, ProcessingFrame const &)
void art::ReplicatedAnalyzer::respondToOpenInputFile ( FileBlock const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 106 of file ReplicatedAnalyzer.cc.

108  {}
void art::ReplicatedAnalyzer::respondToOpenInputFileWithFrame ( FileBlock const &  fb,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Analyzer.

Definition at line 19 of file ReplicatedAnalyzer.cc.

22  {
23  respondToOpenInputFile(fb, frame);
24  }
virtual void respondToOpenInputFile(FileBlock const &, ProcessingFrame const &)
void art::ReplicatedAnalyzer::respondToOpenOutputFiles ( FileBlock const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 116 of file ReplicatedAnalyzer.cc.

118  {}
void art::ReplicatedAnalyzer::respondToOpenOutputFilesWithFrame ( FileBlock const &  fb,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Analyzer.

Definition at line 35 of file ReplicatedAnalyzer.cc.

38  {
39  respondToOpenOutputFiles(fb, frame);
40  }
virtual void respondToOpenOutputFiles(FileBlock const &, ProcessingFrame const &)
void art::ReplicatedAnalyzer::setupQueues ( detail::SharedResources const &  resources)
finaloverrideprivatevirtual

Implements art::detail::Analyzer.

Definition at line 13 of file ReplicatedAnalyzer.cc.

14  {
15  // For art 3.0, replicated modules will not have queues.
16  }
std::string art::ReplicatedAnalyzer::workerType ( ) const

Definition at line 7 of file ReplicatedAnalyzer.cc.

8  {
9  return "WorkerT<ReplicatedAnalyzer>";
10  }

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