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

#include <SharedAnalyzer.h>

Inheritance diagram for art::SharedAnalyzer:
art::detail::Analyzer art::detail::SharedModule art::Observer art::ModuleBase

Public Types

using WorkerType = WorkerT< SharedAnalyzer >
 
using ModuleType = SharedAnalyzer
 

Public Member Functions

 SharedAnalyzer (fhicl::ParameterSet const &pset)
 
template<typename Config >
 SharedAnalyzer (Table< Config > const &config)
 
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)
 
- Public Member Functions inherited from art::detail::SharedModule
 SharedModule ()
 
 SharedModule (std::string const &moduleLabel)
 
hep::concurrency::SerialTaskQueueChain * serialTaskQueueChain () const
 
std::set< std::string > const & sharedResources () const
 
void createQueues (SharedResources const &resources)
 
template<BranchType , typename... T>
void serialize (T const &...resources)
 
template<BranchType , typename... T>
void serializeExternal (T const &...resources)
 

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
 

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 ()
 
- Protected Member Functions inherited from art::detail::SharedModule
template<BranchType BT = InEvent, typename... T>
void serialize (T const &...)
 
template<BranchType BT = InEvent, typename... T>
void serializeExternal (T const &...)
 
template<BranchType BT = InEvent>
void async ()
 

Detailed Description

Definition at line 21 of file SharedAnalyzer.h.

Member Typedef Documentation

Definition at line 24 of file SharedAnalyzer.h.

Definition at line 23 of file SharedAnalyzer.h.

Constructor & Destructor Documentation

art::SharedAnalyzer::SharedAnalyzer ( fhicl::ParameterSet const &  pset)
inlineexplicit

Definition at line 26 of file SharedAnalyzer.h.

27  : detail::Analyzer{pset}
28  , detail::SharedModule{pset.get<std::string>("module_label")}
29  {}
std::string string
Definition: nybbler.cc:12
template<typename Config >
art::SharedAnalyzer::SharedAnalyzer ( Table< Config > const &  config)
inlineexplicit

Definition at line 32 of file SharedAnalyzer.h.

33  : SharedAnalyzer{config.get_PSet()}
34  {}
SharedAnalyzer(fhicl::ParameterSet const &pset)
static Config * config
Definition: config.cpp:1054

Member Function Documentation

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

Implements art::detail::Analyzer.

Definition at line 87 of file SharedAnalyzer.cc.

88  {
89  analyze(e, frame);
90  }
virtual void analyze(Event const &, ProcessingFrame const &)=0
const double e
void art::SharedAnalyzer::beginJob ( ProcessingFrame const &  )
privatevirtual

Definition at line 93 of file SharedAnalyzer.cc.

94  {}
void art::SharedAnalyzer::beginJobWithFrame ( ProcessingFrame const &  frame)
finaloverrideprivatevirtual

Implements art::detail::Analyzer.

Definition at line 49 of file SharedAnalyzer.cc.

50  {
51  beginJob(frame);
52  }
virtual void beginJob(ProcessingFrame const &)
void art::SharedAnalyzer::beginRun ( Run const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 121 of file SharedAnalyzer.cc.

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

Implements art::detail::Analyzer.

Definition at line 61 of file SharedAnalyzer.cc.

62  {
63  beginRun(r, frame);
64  }
virtual void beginRun(Run const &, ProcessingFrame const &)
void art::SharedAnalyzer::beginSubRun ( SubRun const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 129 of file SharedAnalyzer.cc.

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

Implements art::detail::Analyzer.

Definition at line 73 of file SharedAnalyzer.cc.

75  {
76  beginSubRun(sr, frame);
77  }
virtual void beginSubRun(SubRun const &, ProcessingFrame const &)
static constexpr double sr
Definition: Units.h:166
void art::SharedAnalyzer::endJob ( ProcessingFrame const &  )
privatevirtual

Definition at line 97 of file SharedAnalyzer.cc.

98  {}
void art::SharedAnalyzer::endJobWithFrame ( ProcessingFrame const &  frame)
finaloverrideprivatevirtual

Implements art::detail::Analyzer.

Definition at line 55 of file SharedAnalyzer.cc.

56  {
57  endJob(frame);
58  }
virtual void endJob(ProcessingFrame const &)
void art::SharedAnalyzer::endRun ( Run const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 125 of file SharedAnalyzer.cc.

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

Implements art::detail::Analyzer.

Definition at line 67 of file SharedAnalyzer.cc.

68  {
69  endRun(r, frame);
70  }
virtual void endRun(Run const &, ProcessingFrame const &)
void art::SharedAnalyzer::endSubRun ( SubRun const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 133 of file SharedAnalyzer.cc.

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

Implements art::detail::Analyzer.

Definition at line 80 of file SharedAnalyzer.cc.

82  {
83  endSubRun(sr, frame);
84  }
virtual void endSubRun(SubRun const &, ProcessingFrame const &)
static constexpr double sr
Definition: Units.h:166
void art::SharedAnalyzer::respondToCloseInputFile ( FileBlock const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 106 of file SharedAnalyzer.cc.

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

Implements art::detail::Analyzer.

Definition at line 26 of file SharedAnalyzer.cc.

28  {
29  respondToCloseInputFile(fb, frame);
30  }
virtual void respondToCloseInputFile(FileBlock const &, ProcessingFrame const &)
void art::SharedAnalyzer::respondToCloseOutputFiles ( FileBlock const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 116 of file SharedAnalyzer.cc.

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

Implements art::detail::Analyzer.

Definition at line 41 of file SharedAnalyzer.cc.

44  {
45  respondToCloseOutputFiles(fb, frame);
46  }
virtual void respondToCloseOutputFiles(FileBlock const &, ProcessingFrame const &)
void art::SharedAnalyzer::respondToOpenInputFile ( FileBlock const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 101 of file SharedAnalyzer.cc.

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

Implements art::detail::Analyzer.

Definition at line 19 of file SharedAnalyzer.cc.

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

Definition at line 111 of file SharedAnalyzer.cc.

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

Implements art::detail::Analyzer.

Definition at line 33 of file SharedAnalyzer.cc.

36  {
37  respondToOpenOutputFiles(fb, frame);
38  }
virtual void respondToOpenOutputFiles(FileBlock const &, ProcessingFrame const &)
void art::SharedAnalyzer::setupQueues ( detail::SharedResources const &  resources)
finaloverrideprivatevirtual

Implements art::detail::Analyzer.

Definition at line 13 of file SharedAnalyzer.cc.

14  {
15  createQueues(resources);
16  }
void createQueues(SharedResources const &resources)
Definition: SharedModule.cc:34
std::string art::SharedAnalyzer::workerType ( ) const

Definition at line 7 of file SharedAnalyzer.cc.

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

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