File indexing completed on 2025-03-13 02:31:48
0001 #ifndef FWCore_Framework_one_EDAnalyzerBase_h
0002 #define FWCore_Framework_one_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/Framework/interface/SharedResourcesAcquirer.h"
0027 #include "DataFormats/Provenance/interface/ModuleDescription.h"
0028 #include "FWCore/ParameterSet/interface/ParameterSetfwd.h"
0029 #include "FWCore/Concurrency/interface/WaitingTaskHolder.h"
0030
0031
0032 namespace edm {
0033
0034 class ModuleCallingContext;
0035 class PreallocationConfiguration;
0036 class ActivityRegistry;
0037 class ThinnedAssociationsHelper;
0038 class SignallingProductRegistryFiller;
0039
0040 namespace maker {
0041 template <typename T>
0042 class ModuleHolderT;
0043 }
0044
0045 namespace one {
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
0054 typedef EDAnalyzerBase ModuleType;
0055
0056 EDAnalyzerBase();
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 bool wantsStreamRuns() const noexcept { return false; }
0071 bool wantsStreamLuminosityBlocks() const noexcept { return false; };
0072
0073 virtual SerialTaskQueue* globalRunsQueue();
0074 virtual SerialTaskQueue* globalLuminosityBlocksQueue();
0075 void callWhenNewProductsRegistered(std::function<void(ProductDescription const&)> const& func);
0076
0077 private:
0078 bool doEvent(EventTransitionInfo const&, ActivityRegistry*, ModuleCallingContext const*);
0079
0080 void preActionBeforeRunEventAsync(WaitingTaskHolder,
0081 ModuleCallingContext const&,
0082 Principal const&) const noexcept {}
0083
0084 void doPreallocate(PreallocationConfiguration const&);
0085 virtual void preallocRuns(unsigned int);
0086 virtual void preallocLumis(unsigned int);
0087 void doBeginJob();
0088 void doEndJob();
0089
0090 void doBeginProcessBlock(ProcessBlockPrincipal const&, ModuleCallingContext const*);
0091 void doAccessInputProcessBlock(ProcessBlockPrincipal const&, ModuleCallingContext const*);
0092 void doEndProcessBlock(ProcessBlockPrincipal const&, ModuleCallingContext const*);
0093 void doBeginRun(RunTransitionInfo const&, ModuleCallingContext const*);
0094 void doEndRun(RunTransitionInfo const&, ModuleCallingContext const*);
0095 void doBeginLuminosityBlock(LumiTransitionInfo const&, ModuleCallingContext const*);
0096 void doEndLuminosityBlock(LumiTransitionInfo const&, ModuleCallingContext const*);
0097
0098 void doRespondToOpenInputFile(FileBlock const&) {}
0099 void doRespondToCloseInputFile(FileBlock const&) {}
0100 void doRespondToCloseOutputFile() { clearInputProcessBlockCaches(); }
0101 void doRegisterThinnedAssociations(ProductRegistry const&, ThinnedAssociationsHelper&) {}
0102
0103 void registerProductsAndCallbacks(EDAnalyzerBase const* module, SignallingProductRegistryFiller* reg);
0104 std::string workerType() const { return "WorkerT<EDAnalyzer>"; }
0105
0106 SharedResourcesAcquirer& sharedResourcesAcquirer() { return resourcesAcquirer_; }
0107
0108 virtual void analyze(Event const&, EventSetup const&) = 0;
0109 virtual void beginJob() {}
0110 virtual void endJob() {}
0111
0112 virtual void doBeginProcessBlock_(ProcessBlock const&);
0113 virtual void doAccessInputProcessBlock_(ProcessBlock const&);
0114 virtual void doEndProcessBlock_(ProcessBlock const&);
0115 virtual void doBeginRun_(Run const& rp, EventSetup const& c);
0116 virtual void doEndRun_(Run const& rp, EventSetup const& c);
0117 virtual void doBeginLuminosityBlock_(LuminosityBlock const& lbp, EventSetup const& c);
0118 virtual void doEndLuminosityBlock_(LuminosityBlock const& lbp, EventSetup const& c);
0119
0120 virtual void clearInputProcessBlockCaches();
0121
0122 bool hasAcquire() const noexcept { return false; }
0123 bool hasAccumulator() const noexcept { return false; }
0124
0125 virtual SharedResourcesAcquirer createAcquirer();
0126
0127 void setModuleDescription(ModuleDescription const& md) { moduleDescription_ = md; }
0128 ModuleDescription moduleDescription_;
0129 std::function<void(ProductDescription const&)> callWhenNewProductsRegistered_;
0130
0131 SharedResourcesAcquirer resourcesAcquirer_;
0132 };
0133 }
0134 }
0135 #endif