interface/global/EDFilterBase.h

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
0043   namespace maker {
0044     template <typename T>
0045     class ModuleHolderT;
0046   }
0047
0048   namespace global {
0049
0050     class EDFilterBase : public ProducerBase, public EDConsumerBase {
0051     public:
0052       template <typename T>
0053       friend class edm::maker::ModuleHolderT;
0054       template <typename T>
0055       friend class edm::WorkerT;
0056       typedef EDFilterBase ModuleType;
0057
0058       EDFilterBase();
0059       ~EDFilterBase() override;
0060
0061       static void fillDescriptions(ConfigurationDescriptions& descriptions);
0062       static void prevalidate(ConfigurationDescriptions& descriptions);
0063       static const std::string& baseType();
0064
0065       // Warning: the returned moduleDescription will be invalid during construction
0066       ModuleDescription const& moduleDescription() const { return moduleDescription_; }
0067
0068       virtual bool wantsProcessBlocks() const = 0;
0069       virtual bool wantsInputProcessBlocks() const = 0;
0070       virtual bool wantsGlobalRuns() const = 0;
0071       virtual bool wantsGlobalLuminosityBlocks() const = 0;
0072       virtual bool wantsStreamRuns() const = 0;
0073       virtual bool wantsStreamLuminosityBlocks() const = 0;
0074
0075     private:
0076       bool doEvent(EventTransitionInfo const&, ActivityRegistry*, ModuleCallingContext const*);
0077       void doAcquire(EventTransitionInfo const&,
0078                      ActivityRegistry*,
0079                      ModuleCallingContext const*,
0080                      WaitingTaskWithArenaHolder&);
0081       void doTransform(size_t iTransformIndex,
0082                        EventPrincipal const& iEvent,
0083                        ActivityRegistry*,
0084                        ModuleCallingContext const*);
0085       //For now this is a placeholder
0086       /*virtual*/ void preActionBeforeRunEventAsync(WaitingTaskHolder iTask,
0087                                                     ModuleCallingContext const& iModuleCallingContext,
0088                                                     Principal const& iPrincipal) const {}
0089
0090       void doPreallocate(PreallocationConfiguration const&);
0091       void doBeginJob();
0092       void doEndJob();
0093
0094       void doBeginStream(StreamID id);
0095       void doEndStream(StreamID id);
0096       void doStreamBeginRun(StreamID, RunTransitionInfo const&, ModuleCallingContext const*);
0097       void doStreamEndRun(StreamID, RunTransitionInfo const&, ModuleCallingContext const*);
0098       void doStreamBeginLuminosityBlock(StreamID, LumiTransitionInfo const&, ModuleCallingContext const*);
0099       void doStreamEndLuminosityBlock(StreamID, LumiTransitionInfo const&, ModuleCallingContext const*);
0100
0101       void doBeginProcessBlock(ProcessBlockPrincipal const&, ModuleCallingContext const*);
0102       void doAccessInputProcessBlock(ProcessBlockPrincipal const&, ModuleCallingContext const*);
0103       void doEndProcessBlock(ProcessBlockPrincipal const&, ModuleCallingContext const*);
0104       void doBeginRun(RunTransitionInfo const&, ModuleCallingContext const*);
0105       void doEndRun(RunTransitionInfo const&, ModuleCallingContext const*);
0106       void doBeginLuminosityBlock(LumiTransitionInfo const&, ModuleCallingContext const*);
0107       void doEndLuminosityBlock(LumiTransitionInfo const&, ModuleCallingContext const*);
0108
0109       void doRespondToOpenInputFile(FileBlock const&) {}
0110       void doRespondToCloseInputFile(FileBlock const&) {}
0111       void doRespondToCloseOutputFile() { clearInputProcessBlockCaches(); }
0112       void doRegisterThinnedAssociations(ProductRegistry const&, ThinnedAssociationsHelper&) {}
0113
0114       void registerProductsAndCallbacks(EDFilterBase* module, ProductRegistry* reg) {
0115         registerProducts(module, reg, moduleDescription_);
0116       }
0117       std::string workerType() const { return "WorkerT<EDProducer>"; }
0118
0119       virtual bool filter(StreamID, Event&, EventSetup const&) const = 0;
0120       virtual void beginJob() {}
0121       virtual void endJob() {}
0122
0123       virtual void preallocStreams(unsigned int);
0124       virtual void preallocLumis(unsigned int);
0125       virtual void preallocLumisSummary(unsigned int);
0126       virtual void preallocate(PreallocationConfiguration const&);
0127       virtual void doBeginStream_(StreamID id);
0128       virtual void doEndStream_(StreamID id);
0129       virtual void doStreamBeginRun_(StreamID id, Run const& rp, EventSetup const& c);
0130       virtual void doStreamEndRun_(StreamID id, Run const& rp, EventSetup const& c);
0131       virtual void doStreamEndRunSummary_(StreamID id, Run const& rp, EventSetup const& c);
0132       virtual void doStreamBeginLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
0133       virtual void doStreamEndLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
0134       virtual void doStreamEndLuminosityBlockSummary_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
0135
0136       virtual void doBeginProcessBlock_(ProcessBlock const&);
0137       virtual void doAccessInputProcessBlock_(ProcessBlock const&);
0138       virtual void doEndProcessBlock_(ProcessBlock const&);
0139       virtual void doBeginRun_(Run const& rp, EventSetup const& c);
0140       virtual void doBeginRunSummary_(Run const& rp, EventSetup const& c);
0141       virtual void doEndRunSummary_(Run const& rp, EventSetup const& c);
0142       virtual void doEndRun_(Run const& rp, EventSetup const& c);
0143       virtual void doBeginLuminosityBlock_(LuminosityBlock const& lbp, EventSetup const& c);
0144       virtual void doBeginLuminosityBlockSummary_(LuminosityBlock const& rp, EventSetup const& c);
0145       virtual void doEndLuminosityBlockSummary_(LuminosityBlock const& lb, EventSetup const& c);
0146       virtual void doEndLuminosityBlock_(LuminosityBlock const& lb, EventSetup const& c);
0147
0148       virtual void doBeginProcessBlockProduce_(ProcessBlock&);
0149       virtual void doEndProcessBlockProduce_(ProcessBlock&);
0150       virtual void doBeginRunProduce_(Run& rp, EventSetup const& c);
0151       virtual void doEndRunProduce_(Run& rp, EventSetup const& c);
0152       virtual void doBeginLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c);
0153       virtual void doEndLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c);
0154
0155       virtual size_t transformIndex_(edm::BranchDescription const& iBranch) const;
0156       virtual ProductResolverIndex transformPrefetch_(std::size_t iIndex) const;
0157       virtual void transform_(std::size_t iIndex, edm::EventForTransformer& iEvent) const;
0158
0159       virtual void clearInputProcessBlockCaches();
0160       virtual bool hasAcquire() const { return false; }
0161       bool hasAccumulator() const { return false; }
0162
0163       virtual void doAcquire_(StreamID, Event const&, edm::EventSetup const&, WaitingTaskWithArenaHolder&);
0164
0165       void setModuleDescription(ModuleDescription const& md) { moduleDescription_ = md; }
0166       ModuleDescription moduleDescription_;
0167       std::unique_ptr<std::vector<BranchID>[]> previousParentages_;  //Per stream in the future?
0168       std::unique_ptr<std::vector<BranchID>[]> gotBranchIDsFromAcquire_;
0169       std::unique_ptr<ParentageID[]> previousParentageIds_;
0170     };
0171   }  // namespace global
0172 }  // namespace edm
0173
0174 #endif