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