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
0040   namespace maker {
0041     template <typename T>
0042     class ModuleHolderT;
0043   }
0044
0045   namespace stream {
0046     class EDFilterBase;
0047     class EDFilterAdaptorBase : public ProducingModuleAdaptorBase<EDFilterBase> {
0048     public:
0049       template <typename T>
0050       friend class edm::maker::ModuleHolderT;
0051       template <typename T>
0052       friend class edm::WorkerT;
0053
0054       EDFilterAdaptorBase();
0055       EDFilterAdaptorBase(const EDFilterAdaptorBase&) = delete;                   // stop default
0056       const EDFilterAdaptorBase& operator=(const EDFilterAdaptorBase&) = delete;  // stop default
0057
0058       // ---------- const member functions ---------------------
0059
0060       // ---------- static member functions --------------------
0061
0062       // ---------- member functions ---------------------------
0063
0064     protected:
0065       using ProducingModuleAdaptorBase<EDFilterBase>::commit;
0066
0067     private:
0068       bool doEvent(EventTransitionInfo const&, ActivityRegistry*, ModuleCallingContext const*);
0069
0070       void doAcquire(EventTransitionInfo const&, ActivityRegistry*, ModuleCallingContext const*, WaitingTaskHolder&&);
0071
0072       //For now this is a placeholder
0073       /*virtual*/ void preActionBeforeRunEventAsync(WaitingTaskHolder,
0074                                                     ModuleCallingContext const&,
0075                                                     Principal const&) const noexcept {}
0076     };
0077   }  // namespace stream
0078 }  // namespace edm
0079
0080 #endif