Back to home page

Project CMSSW displayed by LXR
 
 

    

File indexing completed on 2025-06-29 22:58:00 

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 EventForTransformer;
0041   class ServiceWeakToken;
0042   class SignallingProductRegistryFiller;
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 noexcept = 0;
0070       virtual bool wantsInputProcessBlocks() const noexcept = 0;
0071       virtual bool wantsGlobalRuns() const noexcept = 0;
0072       virtual bool wantsGlobalLuminosityBlocks() const noexcept = 0;
0073       virtual bool wantsStreamRuns() const noexcept = 0;
0074       virtual bool wantsStreamLuminosityBlocks() const noexcept = 0;
0075 
0076     private:
0077       bool doEvent(EventTransitionInfo const&, ActivityRegistry*, ModuleCallingContext const*);
0078       void doAcquire(EventTransitionInfo const&, ActivityRegistry*, ModuleCallingContext const*, WaitingTaskHolder&&);
0079       void doTransformAsync(WaitingTaskHolder iTask,
0080                             size_t iTransformIndex,
0081                             EventPrincipal const& iEvent,
0082                             ActivityRegistry*,
0083                             ModuleCallingContext,
0084                             ServiceWeakToken const&) noexcept;
0085       //For now this is a placeholder
0086       /*virtual*/ void preActionBeforeRunEventAsync(WaitingTaskHolder iTask,
0087                                                     ModuleCallingContext const& iModuleCallingContext,
0088                                                     Principal const& iPrincipal) const noexcept {}
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, SignallingProductRegistryFiller* reg) {
0115         registerProducts(module, reg, moduleDescription_);
0116       }
0117 
0118       virtual bool filter(StreamID, Event&, EventSetup const&) const = 0;
0119       virtual void beginJob() {}
0120       virtual void endJob() {}
0121 
0122       virtual void preallocStreams(unsigned int);
0123       virtual void preallocRuns(unsigned int);
0124       virtual void preallocRunsSummary(unsigned int);
0125       virtual void preallocLumis(unsigned int);
0126       virtual void preallocLumisSummary(unsigned int);
0127       virtual void preallocate(PreallocationConfiguration const&);
0128       virtual void doBeginStream_(StreamID id);
0129       virtual void doEndStream_(StreamID id);
0130       virtual void doStreamBeginRun_(StreamID id, Run const& rp, EventSetup const& c);
0131       virtual void doStreamEndRun_(StreamID id, Run const& rp, EventSetup const& c);
0132       virtual void doStreamEndRunSummary_(StreamID id, Run const& rp, EventSetup const& c);
0133       virtual void doStreamBeginLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
0134       virtual void doStreamEndLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
0135       virtual void doStreamEndLuminosityBlockSummary_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
0136 
0137       virtual void doBeginProcessBlock_(ProcessBlock const&);
0138       virtual void doAccessInputProcessBlock_(ProcessBlock const&);
0139       virtual void doEndProcessBlock_(ProcessBlock const&);
0140       virtual void doBeginRun_(Run const& rp, EventSetup const& c);
0141       virtual void doBeginRunSummary_(Run const& rp, EventSetup const& c);
0142       virtual void doEndRunSummary_(Run const& rp, EventSetup const& c);
0143       virtual void doEndRun_(Run const& rp, EventSetup const& c);
0144       virtual void doBeginLuminosityBlock_(LuminosityBlock const& lbp, EventSetup const& c);
0145       virtual void doBeginLuminosityBlockSummary_(LuminosityBlock const& rp, EventSetup const& c);
0146       virtual void doEndLuminosityBlockSummary_(LuminosityBlock const& lb, EventSetup const& c);
0147       virtual void doEndLuminosityBlock_(LuminosityBlock const& lb, EventSetup const& c);
0148 
0149       virtual void doBeginProcessBlockProduce_(ProcessBlock&);
0150       virtual void doEndProcessBlockProduce_(ProcessBlock&);
0151       virtual void doBeginRunProduce_(Run& rp, EventSetup const& c);
0152       virtual void doEndRunProduce_(Run& rp, EventSetup const& c);
0153       virtual void doBeginLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c);
0154       virtual void doEndLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c);
0155 
0156       virtual size_t transformIndex_(edm::ProductDescription const& iBranch) const noexcept;
0157       virtual ProductResolverIndex transformPrefetch_(std::size_t iIndex) const noexcept;
0158       virtual void transformAsync_(WaitingTaskHolder iTask,
0159                                    std::size_t iIndex,
0160                                    edm::EventForTransformer& iEvent,
0161                                    edm::ActivityRegistry* iAct,
0162                                    ServiceWeakToken const& iToken) const noexcept;
0163 
0164       virtual void clearInputProcessBlockCaches();
0165       virtual bool hasAcquire() const noexcept { return false; }
0166       bool hasAccumulator() const noexcept { return false; }
0167 
0168       virtual void doAcquire_(StreamID, Event const&, edm::EventSetup const&, WaitingTaskHolder&&);
0169 
0170       void setModuleDescription(ModuleDescription const& md) { moduleDescription_ = md; }
0171       ModuleDescription moduleDescription_;
0172       std::unique_ptr<std::vector<BranchID>[]> previousParentages_;  //Per stream in the future?
0173       std::unique_ptr<std::vector<BranchID>[]> gotBranchIDsFromAcquire_;
0174       std::unique_ptr<ParentageID[]> previousParentageIds_;
0175     };
0176   }  // namespace global
0177 }  // namespace edm
0178 
0179 #endif
[ Source navigation ] [ Diff markup ] [ Identifier search ] [ general search ]

This page was automatically generated by the 2.2.1 LXR engine.

The LXR team
Valid CSS 2.1! Valid HTML 4.01!