CMS 3D CMS Logo

EDFilterBase.h
Go to the documentation of this file.
1 #ifndef FWCore_Framework_limited_EDFilterBase_h
2 #define FWCore_Framework_limited_EDFilterBase_h
3 // -*- C++ -*-
4 //
5 // Package: FWCore/Framework
6 // Class : EDFilterBase
7 //
16 //
17 // Original Author: Chris Jones
18 // Created: Thu, 18 Jul 2013 11:51:14 GMT
19 //
20 
21 // system include files
22 #include <memory>
23 
24 // user include files
31 
32 // forward declarations
33 
34 namespace edm {
35  class ModuleCallingContext;
36  class PreallocationConfiguration;
37  class StreamID;
38  class ActivityRegistry;
39  class ProductRegistry;
40  class ThinnedAssociationsHelper;
41  class WaitingTask;
42 
43  namespace maker {
44  template <typename T>
45  class ModuleHolderT;
46  }
47 
48  namespace limited {
49 
50  class EDFilterBase : public ProducerBase, public EDConsumerBase {
51  public:
52  template <typename T>
54  template <typename T>
55  friend class edm::WorkerT;
57 
59  ~EDFilterBase() override;
60 
61  static void fillDescriptions(ConfigurationDescriptions& descriptions);
62  static void prevalidate(ConfigurationDescriptions& descriptions);
63  static const std::string& baseType();
64 
65  // Warning: the returned moduleDescription will be invalid during construction
66  ModuleDescription const& moduleDescription() const { return moduleDescription_; }
67 
68  virtual bool wantsGlobalRuns() const = 0;
69  virtual bool wantsGlobalLuminosityBlocks() const = 0;
70  virtual bool wantsStreamRuns() const = 0;
71  virtual bool wantsStreamLuminosityBlocks() const = 0;
72 
73  unsigned int concurrencyLimit() const { return queue_.concurrencyLimit(); }
74 
75  LimitedTaskQueue& queue() { return queue_; }
76 
77  private:
78  bool doEvent(EventPrincipal const& ep, EventSetupImpl const& c, ActivityRegistry*, ModuleCallingContext const*);
79  //For now this is a placeholder
80  /*virtual*/ void preActionBeforeRunEventAsync(WaitingTask* iTask,
81  ModuleCallingContext const& iModuleCallingContext,
82  Principal const& iPrincipal) const {}
83 
84  void doPreallocate(PreallocationConfiguration const&);
85  void doBeginJob();
86  void doEndJob();
87 
88  void doBeginStream(StreamID id);
89  void doEndStream(StreamID id);
90  void doStreamBeginRun(StreamID id, RunPrincipal const& ep, EventSetupImpl const& c, ModuleCallingContext const*);
91  void doStreamEndRun(StreamID id, RunPrincipal const& ep, EventSetupImpl const& c, ModuleCallingContext const*);
92  void doStreamBeginLuminosityBlock(StreamID id,
93  LuminosityBlockPrincipal const& ep,
94  EventSetupImpl const& c,
95  ModuleCallingContext const*);
96  void doStreamEndLuminosityBlock(StreamID id,
97  LuminosityBlockPrincipal const& ep,
98  EventSetupImpl const& c,
99  ModuleCallingContext const*);
100 
101  void doBeginRun(RunPrincipal const& rp, EventSetupImpl const& c, ModuleCallingContext const*);
102  void doEndRun(RunPrincipal const& rp, EventSetupImpl const& c, ModuleCallingContext const*);
103  void doBeginLuminosityBlock(LuminosityBlockPrincipal const& lbp,
104  EventSetupImpl const& c,
105  ModuleCallingContext const*);
106  void doEndLuminosityBlock(LuminosityBlockPrincipal const& lbp,
107  EventSetupImpl const& c,
108  ModuleCallingContext const*);
109 
110  //For now, the following are just dummy implemenations with no ability for users to override
111  void doRespondToOpenInputFile(FileBlock const& fb);
112  void doRespondToCloseInputFile(FileBlock const& fb);
114 
116  registerProducts(module, reg, moduleDescription_);
117  }
118  std::string workerType() const { return "WorkerT<EDProducer>"; }
119 
120  virtual bool filter(StreamID, Event&, EventSetup const&) const = 0;
121  virtual void beginJob() {}
122  virtual void endJob() {}
123 
124  virtual void preallocStreams(unsigned int);
125  virtual void preallocLumis(unsigned int);
126  virtual void preallocate(PreallocationConfiguration const&);
127  virtual void doBeginStream_(StreamID id);
128  virtual void doEndStream_(StreamID id);
129  virtual void doStreamBeginRun_(StreamID id, Run const& rp, EventSetup const& c);
130  virtual void doStreamEndRun_(StreamID id, Run const& rp, EventSetup const& c);
131  virtual void doStreamEndRunSummary_(StreamID id, Run const& rp, EventSetup const& c);
132  virtual void doStreamBeginLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
133  virtual void doStreamEndLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
134  virtual void doStreamEndLuminosityBlockSummary_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
135 
136  virtual void doBeginRun_(Run const& rp, EventSetup const& c);
137  virtual void doBeginRunSummary_(Run const& rp, EventSetup const& c);
138  virtual void doEndRunSummary_(Run const& rp, EventSetup const& c);
139  virtual void doEndRun_(Run const& rp, EventSetup const& c);
140  virtual void doBeginLuminosityBlock_(LuminosityBlock const& lbp, EventSetup const& c);
141  virtual void doBeginLuminosityBlockSummary_(LuminosityBlock const& rp, EventSetup const& c);
142  virtual void doEndLuminosityBlockSummary_(LuminosityBlock const& lb, EventSetup const& c);
143  virtual void doEndLuminosityBlock_(LuminosityBlock const& lb, EventSetup const& c);
144 
145  virtual void doBeginRunProduce_(Run& rp, EventSetup const& c);
146  virtual void doEndRunProduce_(Run& rp, EventSetup const& c);
147  virtual void doBeginLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c);
148  virtual void doEndLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c);
149 
150  bool hasAcquire() const { return false; }
151  bool hasAccumulator() const { return false; }
152 
153  void setModuleDescription(ModuleDescription const& md) { moduleDescription_ = md; }
155  std::unique_ptr<std::vector<BranchID>[]> previousParentages_; //Per stream in the future?
156  std::unique_ptr<ParentageID[]> previousParentageIds_;
157 
159  };
160 
161  } // namespace limited
162 } // namespace edm
163 
164 #endif
void setModuleDescription(ModuleDescription const &md)
Definition: EDFilterBase.h:153
bool wantsStreamLuminosityBlocks() const final
Definition: WorkerT.cc:137
std::string workerType() const
Definition: EDFilterBase.h:118
bool wantsGlobalRuns() const final
Definition: WorkerT.cc:122
unsigned int concurrencyLimit() const
Definition: EDFilterBase.h:73
std::unique_ptr< ParentageID[]> previousParentageIds_
Definition: EDFilterBase.h:156
void doRegisterThinnedAssociations(ProductRegistry const &, ThinnedAssociationsHelper &)
Definition: EDFilterBase.h:113
bool wantsGlobalLuminosityBlocks() const final
Definition: WorkerT.cc:127
std::unique_ptr< std::vector< BranchID >[]> previousParentages_
Definition: EDFilterBase.h:155
static void fillDescriptions(edm::ConfigurationDescriptions &descriptions)
LimitedTaskQueue queue_
Definition: EDFilterBase.h:158
LimitedTaskQueue & queue()
Definition: EDFilterBase.h:75
ModuleDescription moduleDescription_
Definition: EDFilterBase.h:154
HLT enums.
ModuleDescription const & moduleDescription() const
Definition: EDFilterBase.h:66
void registerProductsAndCallbacks(EDFilterBase *module, ProductRegistry *reg)
Definition: EDFilterBase.h:115
bool wantsStreamRuns() const final
Definition: WorkerT.cc:132
bool hasAccumulator() const
Definition: EDFilterBase.h:151
Definition: vlib.h:208
void preActionBeforeRunEventAsync(WaitingTask *iTask, ModuleCallingContext const &iModuleCallingContext, Principal const &iPrincipal) const
Definition: EDFilterBase.h:80
Definition: Run.h:45