CMS 3D CMS Logo

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
ProducingModuleAdaptorBase.h
Go to the documentation of this file.
1 #ifndef FWCore_Framework_stream_ProducingModuleAdaptorBase_h
2 #define FWCore_Framework_stream_ProducingModuleAdaptorBase_h
3 // -*- C++ -*-
4 //
5 // Package: FWCore/Framework
6 // Class : ProducingModuleAdaptorBase
7 //
16 //
17 // Original Author: Chris Jones
18 // Created: Fri, 02 Aug 2013 18:09:15 GMT
19 //
20 
21 // system include files
22 #include <map>
23 #include <string>
24 #include <vector>
25 #include <unordered_map>
26 
27 // user include files
40 
41 // forward declarations
42 
43 namespace edm {
44  class Event;
45  class ModuleCallingContext;
46  class ProductResolverIndexHelper;
47  class EDConsumerBase;
48  class PreallocationConfiguration;
49  class ProductResolverIndexAndSkipBit;
50  class ProductRegistry;
51  class ThinnedAssociationsHelper;
52 
53  namespace maker {
54  template<typename T> class ModuleHolderT;
55  }
56 
57  namespace stream {
58  template<typename T>
59  class ProducingModuleAdaptorBase
60  {
61 
62  public:
63  template <typename U> friend class edm::WorkerT;
64  template <typename U> friend class edm::maker::ModuleHolderT;
65 
67  virtual ~ProducingModuleAdaptorBase();
68 
69  // ---------- const member functions ---------------------
70 
71  // ---------- static member functions --------------------
72 
73  // ---------- member functions ---------------------------
74  const ModuleDescription& moduleDescription() const { return moduleDescription_;}
75 
76  virtual bool wantsGlobalRuns() const = 0;
77  virtual bool wantsGlobalLuminosityBlocks() const = 0;
78  virtual bool hasAcquire() const = 0;
79  bool wantsStreamRuns() const {return true;}
80  bool wantsStreamLuminosityBlocks() const {return true;}
81 
82  void
84 
85  void itemsToGet(BranchType, std::vector<ProductResolverIndexAndSkipBit>&) const;
86  void itemsMayGet(BranchType, std::vector<ProductResolverIndexAndSkipBit>&) const;
87  std::vector<ProductResolverIndexAndSkipBit> const& itemsToGetFrom(BranchType) const;
88 
89  void updateLookup(BranchType iBranchType,
91  bool iPrefetchMayGet);
92 
93  void modulesWhoseProductsAreConsumed(std::vector<ModuleDescription const*>& modules,
94  ProductRegistry const& preg,
95  std::map<std::string, ModuleDescription const*> const& labelsToDesc,
96  std::string const& processName) const;
97 
98  void convertCurrentProcessAlias(std::string const& processName);
99 
100  std::vector<ConsumesInfo> consumesInfo() const;
101 
102  using ModuleToResolverIndicies = std::unordered_multimap<std::string,
103  std::tuple<edm::TypeID const*, const char*, edm::ProductResolverIndex>>;
104 
105  void resolvePutIndicies(BranchType iBranchType,
106  ModuleToResolverIndicies const& iIndicies,
107  std::string const& moduleLabel);
108 
109  std::vector<edm::ProductResolverIndex> const& indiciesForPutProducts(BranchType iBranchType) const;
110 
111  protected:
112  template<typename F> void createStreamModules(F iFunc) {
113  for(auto& m: m_streamModules) {
114  m = iFunc();
115  m->setModuleDescriptionPtr(&moduleDescription_);
116  }
117  }
118 
119  void commit(Run& iRun) {
120  iRun.commit_(m_streamModules[0]->indiciesForPutProducts(InRun));
121  }
122  void commit(LuminosityBlock& iLumi) {
123  iLumi.commit_(m_streamModules[0]->indiciesForPutProducts(InLumi));
124  }
125  template<typename I>
126  void commit(Event& iEvent, I* iID) {
127  iEvent.commit_(m_streamModules[0]->indiciesForPutProducts(InEvent), iID);
128  }
129 
131  return m_streamModules[0];
132  }
133 
135  return m_streamModules[0];
136  }
137 
138  private:
139  ProducingModuleAdaptorBase(const ProducingModuleAdaptorBase&) = delete; // stop default
140 
141  const ProducingModuleAdaptorBase& operator=(const ProducingModuleAdaptorBase&) = delete; // stop default
142 
143  void doPreallocate(PreallocationConfiguration const&);
144  virtual void setupStreamModules() = 0;
145  void doBeginJob();
146  virtual void doEndJob() = 0;
147 
148  void doBeginStream(StreamID id);
149  void doEndStream(StreamID id);
150  void doStreamBeginRun(StreamID id,
151  RunPrincipal const& ep,
152  EventSetup const& c,
153  ModuleCallingContext const*);
154  virtual void setupRun(T*, RunIndex) = 0;
155  void doStreamEndRun(StreamID id,
156  RunPrincipal const& ep,
157  EventSetup const& c,
158  ModuleCallingContext const*);
159  virtual void streamEndRunSummary(T*,edm::Run const&, edm::EventSetup const&) = 0;
160 
161  void doStreamBeginLuminosityBlock(StreamID id,
162  LuminosityBlockPrincipal const& ep,
163  EventSetup const& c,
164  ModuleCallingContext const*);
165  virtual void setupLuminosityBlock(T*, LuminosityBlockIndex) = 0;
166  void doStreamEndLuminosityBlock(StreamID id,
167  LuminosityBlockPrincipal const& ep,
168  EventSetup const& c,
169  ModuleCallingContext const*);
170  virtual void streamEndLuminosityBlockSummary(T*,edm::LuminosityBlock const&, edm::EventSetup const&) = 0;
171 
172 
173  virtual void doBeginRun(RunPrincipal const& rp, EventSetup const& c,
174  ModuleCallingContext const*)=0;
175  virtual void doEndRun(RunPrincipal const& rp, EventSetup const& c,
176  ModuleCallingContext const*)=0;
177  virtual void doBeginLuminosityBlock(LuminosityBlockPrincipal const& lbp,
178  EventSetup const& c,
179  ModuleCallingContext const*)=0;
180  virtual void doEndLuminosityBlock(LuminosityBlockPrincipal const& lbp,
181  EventSetup const& c,
182  ModuleCallingContext const*)=0;
183 
184  //For now, the following are just dummy implemenations with no ability for users to override
185  void doRespondToOpenInputFile(FileBlock const& fb);
186  void doRespondToCloseInputFile(FileBlock const& fb);
187  void doRegisterThinnedAssociations(ProductRegistry const&,
189 
190  // ---------- member data --------------------------------
192  moduleDescription_ = md;
193  }
195  protected:
196  std::vector<T*> m_streamModules;
197 
198  };
199  }
200 }
201 
202 #endif
std::unordered_multimap< std::string, std::tuple< edm::TypeID const *, const char *, edm::ProductResolverIndex >> ModuleToResolverIndicies
void registerProductsAndCallbacks(ProductRegistry *iReg) override
Definition: ModuleHolder.h:76
BranchType
Definition: BranchType.h:11
int iEvent
Definition: GenABIO.cc:230
void commit_(std::vector< edm::ProductResolverIndex > const &iShouldPut)
Definition: Run.cc:87
void setModuleDescription(ModuleDescription const &md)
void commit_(std::vector< edm::ProductResolverIndex > const &iShouldPut, ParentageID *previousParentageId=0)
Definition: Event.cc:171
const std::complex< double > I
Definition: I.h:8
const ModuleDescription & moduleDescription() const
HLT enums.
static uInt32 F(BLOWFISH_CTX *ctx, uInt32 x)
Definition: blowfish.cc:281
long double T
void commit_(std::vector< edm::ProductResolverIndex > const &iShouldPut)
Definition: Run.h:43