interface/stream/EDFilterAdaptorBase.h

0001 #ifndef FWCore_Framework_stream_EDFilterAdaptorBase_h
0002 #define FWCore_Framework_stream_EDFilterAdaptorBase_h
0003 // -*- C++ -*-
0004 //
0005 // Package:     FWCore/Framework
0006 // Class  :     EDFilterAdaptorBase
0007 //
0008 /**\class edm::stream::EDFilterAdaptorBase EDFilterAdaptorBase.h "FWCore/Framework/interface/stream/EDFilterAdaptorBase.h"
0009
0010  Description: [one line class summary]
0011
0012  Usage:
0013     <usage>
0014
0015 */
0016 //
0017 // Original Author:  Chris Jones
0018 //         Created:  Fri, 02 Aug 2013 18:09:15 GMT
0019 //
0020
0021 // system include files
0022
0023 // user include files
0024 #include "FWCore/Framework/interface/stream/ProducingModuleAdaptorBase.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/WaitingTaskHolder.h"
0029 #include "FWCore/Utilities/interface/StreamID.h"
0030 #include "FWCore/Utilities/interface/RunIndex.h"
0031 #include "FWCore/Utilities/interface/LuminosityBlockIndex.h"
0032
0033 // forward declarations
0034
0035 namespace edm {
0036
0037   class ModuleCallingContext;
0038   class ActivityRegistry;
0039   class WaitingTaskWithArenaHolder;
0040
0041   namespace maker {
0042     template <typename T>
0043     class ModuleHolderT;
0044   }
0045
0046   namespace stream {
0047     class EDFilterBase;
0048     class EDFilterAdaptorBase : public ProducingModuleAdaptorBase<EDFilterBase> {
0049     public:
0050       template <typename T>
0051       friend class edm::maker::ModuleHolderT;
0052       template <typename T>
0053       friend class edm::WorkerT;
0054
0055       EDFilterAdaptorBase();
0056       EDFilterAdaptorBase(const EDFilterAdaptorBase&) = delete;                   // stop default
0057       const EDFilterAdaptorBase& operator=(const EDFilterAdaptorBase&) = delete;  // stop default
0058
0059       // ---------- const member functions ---------------------
0060
0061       // ---------- static member functions --------------------
0062
0063       // ---------- member functions ---------------------------
0064
0065       std::string workerType() const { return "WorkerT<EDFilterAdaptorBase>"; }
0066
0067     protected:
0068       using ProducingModuleAdaptorBase<EDFilterBase>::commit;
0069
0070     private:
0071       bool doEvent(EventTransitionInfo const&, ActivityRegistry*, ModuleCallingContext const*);
0072
0073       void doAcquire(EventTransitionInfo const&,
0074                      ActivityRegistry*,
0075                      ModuleCallingContext const*,
0076                      WaitingTaskWithArenaHolder&);
0077
0078       //For now this is a placeholder
0079       /*virtual*/ void preActionBeforeRunEventAsync(WaitingTaskHolder,
0080                                                     ModuleCallingContext const&,
0081                                                     Principal const&) const noexcept {}
0082     };
0083   }  // namespace stream
0084 }  // namespace edm
0085
0086 #endif