File indexing completed on 2025-03-13 02:31:47
0001 #ifndef FWCore_Framework_global_EDAnalyzerBase_h
0002 #define FWCore_Framework_global_EDAnalyzerBase_h
0003
0004
0005
0006
0007
0008
0009
0010
0011
0012
0013
0014
0015
0016
0017
0018
0019
0020
0021
0022
0023
0024 #include "FWCore/Framework/interface/EDConsumerBase.h"
0025 #include "FWCore/Framework/interface/Frameworkfwd.h"
0026 #include "FWCore/Concurrency/interface/WaitingTaskHolder.h"
0027 #include "DataFormats/Provenance/interface/ModuleDescription.h"
0028 #include "FWCore/ParameterSet/interface/ParameterSetfwd.h"
0029
0030
0031
0032 namespace edm {
0033 class ModuleCallingContext;
0034 class PreallocationConfiguration;
0035 class StreamID;
0036 class ActivityRegistry;
0037 class ThinnedAssociationsHelper;
0038 class SignallingProductRegistryFiller;
0039
0040 namespace maker {
0041 template <typename T>
0042 class ModuleHolderT;
0043 }
0044
0045 namespace global {
0046
0047 class EDAnalyzerBase : public EDConsumerBase {
0048 public:
0049 template <typename T>
0050 friend class edm::WorkerT;
0051 template <typename T>
0052 friend class edm::maker::ModuleHolderT;
0053 typedef EDAnalyzerBase ModuleType;
0054
0055 EDAnalyzerBase();
0056 ~EDAnalyzerBase() override;
0057
0058 static void fillDescriptions(ConfigurationDescriptions& descriptions);
0059 static void prevalidate(ConfigurationDescriptions& descriptions);
0060 static const std::string& baseType();
0061
0062
0063 ModuleDescription const& moduleDescription() const { return moduleDescription_; }
0064
0065 virtual bool wantsProcessBlocks() const noexcept = 0;
0066 virtual bool wantsInputProcessBlocks() const noexcept = 0;
0067 virtual bool wantsGlobalRuns() const noexcept = 0;
0068 virtual bool wantsGlobalLuminosityBlocks() const noexcept = 0;
0069 virtual bool wantsStreamRuns() const noexcept = 0;
0070 virtual bool wantsStreamLuminosityBlocks() const noexcept = 0;
0071
0072 void callWhenNewProductsRegistered(std::function<void(ProductDescription const&)> const& func) {
0073 callWhenNewProductsRegistered_ = func;
0074 }
0075
0076 private:
0077 bool doEvent(EventTransitionInfo const&, ActivityRegistry*, ModuleCallingContext const*);
0078
0079 void preActionBeforeRunEventAsync(WaitingTaskHolder,
0080 ModuleCallingContext const&,
0081 Principal const&) const noexcept {}
0082
0083 void doPreallocate(PreallocationConfiguration const&);
0084 void doBeginJob();
0085 void doEndJob();
0086
0087 void doBeginStream(StreamID id);
0088 void doEndStream(StreamID id);
0089 void doStreamBeginRun(StreamID, RunTransitionInfo const&, ModuleCallingContext const*);
0090 void doStreamEndRun(StreamID, RunTransitionInfo const&, ModuleCallingContext const*);
0091 void doStreamBeginLuminosityBlock(StreamID, LumiTransitionInfo const&, ModuleCallingContext const*);
0092 void doStreamEndLuminosityBlock(StreamID, LumiTransitionInfo const&, ModuleCallingContext const*);
0093
0094 void doBeginProcessBlock(ProcessBlockPrincipal const&, ModuleCallingContext const*);
0095 void doAccessInputProcessBlock(ProcessBlockPrincipal const&, ModuleCallingContext const*);
0096 void doEndProcessBlock(ProcessBlockPrincipal const&, ModuleCallingContext const*);
0097 void doBeginRun(RunTransitionInfo const&, ModuleCallingContext const*);
0098 void doEndRun(RunTransitionInfo const&, ModuleCallingContext const*);
0099 void doBeginLuminosityBlock(LumiTransitionInfo const&, ModuleCallingContext const*);
0100 void doEndLuminosityBlock(LumiTransitionInfo const&, ModuleCallingContext const*);
0101
0102 void doRespondToOpenInputFile(FileBlock const&) {}
0103 void doRespondToCloseInputFile(FileBlock const&) {}
0104 void doRespondToCloseOutputFile() { clearInputProcessBlockCaches(); }
0105 void doRegisterThinnedAssociations(ProductRegistry const&, ThinnedAssociationsHelper&) {}
0106
0107 void registerProductsAndCallbacks(EDAnalyzerBase* module, SignallingProductRegistryFiller* reg);
0108 std::string workerType() const { return "WorkerT<EDAnalyzer>"; }
0109
0110 virtual void analyze(StreamID, Event const&, EventSetup const&) const = 0;
0111 virtual void beginJob() {}
0112 virtual void endJob() {}
0113
0114 virtual void preallocStreams(unsigned int);
0115 virtual void preallocRuns(unsigned int);
0116 virtual void preallocRunsSummary(unsigned int);
0117 virtual void preallocLumis(unsigned int);
0118 virtual void preallocLumisSummary(unsigned int);
0119 virtual void preallocate(PreallocationConfiguration const&);
0120 virtual void doBeginStream_(StreamID id);
0121 virtual void doEndStream_(StreamID id);
0122 virtual void doStreamBeginRun_(StreamID id, Run const& rp, EventSetup const& c);
0123 virtual void doStreamEndRun_(StreamID id, Run const& rp, EventSetup const& c);
0124 virtual void doStreamEndRunSummary_(StreamID id, Run const& rp, EventSetup const& c);
0125 virtual void doStreamBeginLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
0126 virtual void doStreamEndLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
0127 virtual void doStreamEndLuminosityBlockSummary_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
0128
0129 virtual void doBeginProcessBlock_(ProcessBlock const&);
0130 virtual void doAccessInputProcessBlock_(ProcessBlock const&);
0131 virtual void doEndProcessBlock_(ProcessBlock const&);
0132 virtual void doBeginRun_(Run const& rp, EventSetup const& c);
0133 virtual void doBeginRunSummary_(Run const& rp, EventSetup const& c);
0134 virtual void doEndRunSummary_(Run const& rp, EventSetup const& c);
0135 virtual void doEndRun_(Run const& rp, EventSetup const& c);
0136 virtual void doBeginLuminosityBlock_(LuminosityBlock const& lbp, EventSetup const& c);
0137 virtual void doBeginLuminosityBlockSummary_(LuminosityBlock const& rp, EventSetup const& c);
0138 virtual void doEndLuminosityBlockSummary_(LuminosityBlock const& lb, EventSetup const& c);
0139 virtual void doEndLuminosityBlock_(LuminosityBlock const& lb, EventSetup const& c);
0140
0141 virtual void clearInputProcessBlockCaches();
0142
0143 bool hasAcquire() const noexcept { return false; }
0144 bool hasAccumulator() const noexcept { return false; }
0145
0146 void setModuleDescription(ModuleDescription const& md) { moduleDescription_ = md; }
0147 ModuleDescription moduleDescription_;
0148
0149 std::function<void(ProductDescription const&)> callWhenNewProductsRegistered_;
0150 };
0151
0152 }
0153 }
0154
0155 #endif