Back to home page

Project CMSSW displayed by LXR

 
 

    


File indexing completed on 2022-10-18 04:13:14

0001 #ifndef FWCore_Framework_global_EDFilterBase_h
0002 #define FWCore_Framework_global_EDFilterBase_h
0003 // -*- C++ -*-
0004 //
0005 // Package:     FWCore/Framework
0006 // Class  :     EDFilterBase
0007 //
0008 /**\class EDFilterBase EDFilterBase.h "EDFilterBase.h"
0009 
0010  Description: [one line class summary]
0011 
0012  Usage:
0013     <usage>
0014 
0015 */
0016 //
0017 // Original Author:  Chris Jones
0018 //         Created:  Thu, 18 Jul 2013 11:51:14 GMT
0019 //
0020 
0021 // system include files
0022 #include <memory>
0023 
0024 // user include files
0025 #include "FWCore/Framework/interface/ProducerBase.h"
0026 #include "FWCore/Framework/interface/EDConsumerBase.h"
0027 #include "FWCore/Framework/interface/Frameworkfwd.h"
0028 #include "DataFormats/Provenance/interface/ModuleDescription.h"
0029 #include "FWCore/ParameterSet/interface/ParameterSetfwd.h"
0030 #include "FWCore/Concurrency/interface/WaitingTaskHolder.h"
0031 
0032 // forward declarations
0033 
0034 namespace edm {
0035   class ModuleCallingContext;
0036   class PreallocationConfiguration;
0037   class StreamID;
0038   class ActivityRegistry;
0039   class ThinnedAssociationsHelper;
0040   class WaitingTaskWithArenaHolder;
0041   class EventForTransformer;
0042   class ServiceWeakToken;
0043 
0044   namespace maker {
0045     template <typename T>
0046     class ModuleHolderT;
0047   }
0048 
0049   namespace global {
0050 
0051     class EDFilterBase : public ProducerBase, public EDConsumerBase {
0052     public:
0053       template <typename T>
0054       friend class edm::maker::ModuleHolderT;
0055       template <typename T>
0056       friend class edm::WorkerT;
0057       typedef EDFilterBase ModuleType;
0058 
0059       EDFilterBase();
0060       ~EDFilterBase() override;
0061 
0062       static void fillDescriptions(ConfigurationDescriptions& descriptions);
0063       static void prevalidate(ConfigurationDescriptions& descriptions);
0064       static const std::string& baseType();
0065 
0066       // Warning: the returned moduleDescription will be invalid during construction
0067       ModuleDescription const& moduleDescription() const { return moduleDescription_; }
0068 
0069       virtual bool wantsProcessBlocks() const = 0;
0070       virtual bool wantsInputProcessBlocks() const = 0;
0071       virtual bool wantsGlobalRuns() const = 0;
0072       virtual bool wantsGlobalLuminosityBlocks() const = 0;
0073       virtual bool wantsStreamRuns() const = 0;
0074       virtual bool wantsStreamLuminosityBlocks() const = 0;
0075 
0076     private:
0077       bool doEvent(EventTransitionInfo const&, ActivityRegistry*, ModuleCallingContext const*);
0078       void doAcquire(EventTransitionInfo const&,
0079                      ActivityRegistry*,
0080                      ModuleCallingContext const*,
0081                      WaitingTaskWithArenaHolder&);
0082       void doTransformAsync(WaitingTaskHolder iTask,
0083                             size_t iTransformIndex,
0084                             EventPrincipal const& iEvent,
0085                             ActivityRegistry*,
0086                             ModuleCallingContext const*,
0087                             ServiceWeakToken const&);
0088       //For now this is a placeholder
0089       /*virtual*/ void preActionBeforeRunEventAsync(WaitingTaskHolder iTask,
0090                                                     ModuleCallingContext const& iModuleCallingContext,
0091                                                     Principal const& iPrincipal) const {}
0092 
0093       void doPreallocate(PreallocationConfiguration const&);
0094       void doBeginJob();
0095       void doEndJob();
0096 
0097       void doBeginStream(StreamID id);
0098       void doEndStream(StreamID id);
0099       void doStreamBeginRun(StreamID, RunTransitionInfo const&, ModuleCallingContext const*);
0100       void doStreamEndRun(StreamID, RunTransitionInfo const&, ModuleCallingContext const*);
0101       void doStreamBeginLuminosityBlock(StreamID, LumiTransitionInfo const&, ModuleCallingContext const*);
0102       void doStreamEndLuminosityBlock(StreamID, LumiTransitionInfo const&, ModuleCallingContext const*);
0103 
0104       void doBeginProcessBlock(ProcessBlockPrincipal const&, ModuleCallingContext const*);
0105       void doAccessInputProcessBlock(ProcessBlockPrincipal const&, ModuleCallingContext const*);
0106       void doEndProcessBlock(ProcessBlockPrincipal const&, ModuleCallingContext const*);
0107       void doBeginRun(RunTransitionInfo const&, ModuleCallingContext const*);
0108       void doEndRun(RunTransitionInfo const&, ModuleCallingContext const*);
0109       void doBeginLuminosityBlock(LumiTransitionInfo const&, ModuleCallingContext const*);
0110       void doEndLuminosityBlock(LumiTransitionInfo const&, ModuleCallingContext const*);
0111 
0112       void doRespondToOpenInputFile(FileBlock const&) {}
0113       void doRespondToCloseInputFile(FileBlock const&) {}
0114       void doRespondToCloseOutputFile() { clearInputProcessBlockCaches(); }
0115       void doRegisterThinnedAssociations(ProductRegistry const&, ThinnedAssociationsHelper&) {}
0116 
0117       void registerProductsAndCallbacks(EDFilterBase* module, ProductRegistry* reg) {
0118         registerProducts(module, reg, moduleDescription_);
0119       }
0120       std::string workerType() const { return "WorkerT<EDProducer>"; }
0121 
0122       virtual bool filter(StreamID, Event&, EventSetup const&) const = 0;
0123       virtual void beginJob() {}
0124       virtual void endJob() {}
0125 
0126       virtual void preallocStreams(unsigned int);
0127       virtual void preallocRuns(unsigned int);
0128       virtual void preallocRunsSummary(unsigned int);
0129       virtual void preallocLumis(unsigned int);
0130       virtual void preallocLumisSummary(unsigned int);
0131       virtual void preallocate(PreallocationConfiguration const&);
0132       virtual void doBeginStream_(StreamID id);
0133       virtual void doEndStream_(StreamID id);
0134       virtual void doStreamBeginRun_(StreamID id, Run const& rp, EventSetup const& c);
0135       virtual void doStreamEndRun_(StreamID id, Run const& rp, EventSetup const& c);
0136       virtual void doStreamEndRunSummary_(StreamID id, Run const& rp, EventSetup const& c);
0137       virtual void doStreamBeginLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
0138       virtual void doStreamEndLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
0139       virtual void doStreamEndLuminosityBlockSummary_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
0140 
0141       virtual void doBeginProcessBlock_(ProcessBlock const&);
0142       virtual void doAccessInputProcessBlock_(ProcessBlock const&);
0143       virtual void doEndProcessBlock_(ProcessBlock const&);
0144       virtual void doBeginRun_(Run const& rp, EventSetup const& c);
0145       virtual void doBeginRunSummary_(Run const& rp, EventSetup const& c);
0146       virtual void doEndRunSummary_(Run const& rp, EventSetup const& c);
0147       virtual void doEndRun_(Run const& rp, EventSetup const& c);
0148       virtual void doBeginLuminosityBlock_(LuminosityBlock const& lbp, EventSetup const& c);
0149       virtual void doBeginLuminosityBlockSummary_(LuminosityBlock const& rp, EventSetup const& c);
0150       virtual void doEndLuminosityBlockSummary_(LuminosityBlock const& lb, EventSetup const& c);
0151       virtual void doEndLuminosityBlock_(LuminosityBlock const& lb, EventSetup const& c);
0152 
0153       virtual void doBeginProcessBlockProduce_(ProcessBlock&);
0154       virtual void doEndProcessBlockProduce_(ProcessBlock&);
0155       virtual void doBeginRunProduce_(Run& rp, EventSetup const& c);
0156       virtual void doEndRunProduce_(Run& rp, EventSetup const& c);
0157       virtual void doBeginLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c);
0158       virtual void doEndLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c);
0159 
0160       virtual size_t transformIndex_(edm::BranchDescription const& iBranch) const;
0161       virtual ProductResolverIndex transformPrefetch_(std::size_t iIndex) const;
0162       virtual void transformAsync_(WaitingTaskHolder iTask,
0163                                    std::size_t iIndex,
0164                                    edm::EventForTransformer& iEvent,
0165                                    ServiceWeakToken const& iToken) const;
0166 
0167       virtual void clearInputProcessBlockCaches();
0168       virtual bool hasAcquire() const { return false; }
0169       bool hasAccumulator() const { return false; }
0170 
0171       virtual void doAcquire_(StreamID, Event const&, edm::EventSetup const&, WaitingTaskWithArenaHolder&);
0172 
0173       void setModuleDescription(ModuleDescription const& md) { moduleDescription_ = md; }
0174       ModuleDescription moduleDescription_;
0175       std::unique_ptr<std::vector<BranchID>[]> previousParentages_;  //Per stream in the future?
0176       std::unique_ptr<std::vector<BranchID>[]> gotBranchIDsFromAcquire_;
0177       std::unique_ptr<ParentageID[]> previousParentageIds_;
0178     };
0179   }  // namespace global
0180 }  // namespace edm
0181 
0182 #endif