CMS 3D CMS Logo

EDFilterBase.h
Go to the documentation of this file.
1 #ifndef FWCore_Framework_global_EDFilterBase_h
2 #define FWCore_Framework_global_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
30 
31 // forward declarations
32 
33 namespace edm {
34  class ModuleCallingContext;
35  class PreallocationConfiguration;
36  class StreamID;
37  class ActivityRegistry;
38  class ProductRegistry;
39  class ThinnedAssociationsHelper;
40  class WaitingTask;
41  class WaitingTaskWithArenaHolder;
42 
43  namespace maker {
44  template <typename T>
45  class ModuleHolderT;
46  }
47 
48  namespace global {
49 
50  class EDFilterBase : public ProducerBase, public EDConsumerBase {
51  public:
52  template <typename T>
54  template <typename T>
55  friend class edm::WorkerT;
57 
58  EDFilterBase();
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  private:
74  bool doEvent(EventPrincipal const&, EventSetupImpl const&, ActivityRegistry*, ModuleCallingContext const*);
75  void doAcquire(EventPrincipal const&,
76  EventSetupImpl const&,
78  ModuleCallingContext const*,
80  //For now this is a placeholder
81  /*virtual*/ void preActionBeforeRunEventAsync(WaitingTask* iTask,
82  ModuleCallingContext const& iModuleCallingContext,
83  Principal const& iPrincipal) const {}
84 
85  void doPreallocate(PreallocationConfiguration const&);
86  void doBeginJob();
87  void doEndJob();
88 
89  void doBeginStream(StreamID id);
90  void doEndStream(StreamID id);
91  void doStreamBeginRun(StreamID id, RunPrincipal const& ep, EventSetupImpl const& c, ModuleCallingContext const*);
92  void doStreamEndRun(StreamID id, RunPrincipal const& ep, EventSetupImpl const& c, ModuleCallingContext const*);
93  void doStreamBeginLuminosityBlock(StreamID id,
94  LuminosityBlockPrincipal const& ep,
95  EventSetupImpl const& c,
96  ModuleCallingContext const*);
97  void doStreamEndLuminosityBlock(StreamID id,
98  LuminosityBlockPrincipal const& ep,
99  EventSetupImpl const& c,
100  ModuleCallingContext const*);
101 
102  void doBeginRun(RunPrincipal const& rp, EventSetupImpl const& c, ModuleCallingContext const*);
103  void doEndRun(RunPrincipal const& rp, EventSetupImpl const& c, ModuleCallingContext const*);
104  void doBeginLuminosityBlock(LuminosityBlockPrincipal const& lbp,
105  EventSetupImpl const& c,
106  ModuleCallingContext const*);
107  void doEndLuminosityBlock(LuminosityBlockPrincipal const& lbp,
108  EventSetupImpl const& c,
109  ModuleCallingContext const*);
110 
111  //For now, the following are just dummy implemenations with no ability for users to override
112  void doRespondToOpenInputFile(FileBlock const& fb);
113  void doRespondToCloseInputFile(FileBlock const& fb);
115 
117  registerProducts(module, reg, moduleDescription_);
118  }
119  std::string workerType() const { return "WorkerT<EDProducer>"; }
120 
121  virtual bool filter(StreamID, Event&, EventSetup const&) const = 0;
122  virtual void beginJob() {}
123  virtual void endJob() {}
124 
125  virtual void preallocStreams(unsigned int);
126  virtual void preallocLumis(unsigned int);
127  virtual void preallocate(PreallocationConfiguration const&);
128  virtual void doBeginStream_(StreamID id);
129  virtual void doEndStream_(StreamID id);
130  virtual void doStreamBeginRun_(StreamID id, Run const& rp, EventSetup const& c);
131  virtual void doStreamEndRun_(StreamID id, Run const& rp, EventSetup const& c);
132  virtual void doStreamEndRunSummary_(StreamID id, Run const& rp, EventSetup const& c);
133  virtual void doStreamBeginLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
134  virtual void doStreamEndLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
135  virtual void doStreamEndLuminosityBlockSummary_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
136 
137  virtual void doBeginRun_(Run const& rp, EventSetup const& c);
138  virtual void doBeginRunSummary_(Run const& rp, EventSetup const& c);
139  virtual void doEndRunSummary_(Run const& rp, EventSetup const& c);
140  virtual void doEndRun_(Run const& rp, EventSetup const& c);
141  virtual void doBeginLuminosityBlock_(LuminosityBlock const& lbp, EventSetup const& c);
142  virtual void doBeginLuminosityBlockSummary_(LuminosityBlock const& rp, EventSetup const& c);
143  virtual void doEndLuminosityBlockSummary_(LuminosityBlock const& lb, EventSetup const& c);
144  virtual void doEndLuminosityBlock_(LuminosityBlock const& lb, EventSetup const& c);
145 
146  virtual void doBeginRunProduce_(Run& rp, EventSetup const& c);
147  virtual void doEndRunProduce_(Run& rp, EventSetup const& c);
148  virtual void doBeginLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c);
149  virtual void doEndLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c);
150 
151  virtual bool hasAcquire() const { return false; }
152  bool hasAccumulator() const { return false; }
153 
154  virtual void doAcquire_(StreamID, Event const&, edm::EventSetup const&, WaitingTaskWithArenaHolder&);
155 
156  void setModuleDescription(ModuleDescription const& md) { moduleDescription_ = md; }
158  std::unique_ptr<std::vector<BranchID>[]> previousParentages_; //Per stream in the future?
159  std::unique_ptr<std::vector<BranchID>[]> gotBranchIDsFromAcquire_;
160  std::unique_ptr<ParentageID[]> previousParentageIds_;
161  };
162  } // namespace global
163 } // namespace edm
164 
165 #endif
bool wantsStreamLuminosityBlocks() const final
Definition: WorkerT.cc:137
void registerProductsAndCallbacks(EDFilterBase *module, ProductRegistry *reg)
Definition: EDFilterBase.h:116
void doRegisterThinnedAssociations(ProductRegistry const &, ThinnedAssociationsHelper &)
Definition: EDFilterBase.h:114
bool wantsGlobalRuns() const final
Definition: WorkerT.cc:122
bool hasAccumulator() const
Definition: EDFilterBase.h:152
bool wantsGlobalLuminosityBlocks() const final
Definition: WorkerT.cc:127
void preActionBeforeRunEventAsync(WaitingTask *iTask, ModuleCallingContext const &iModuleCallingContext, Principal const &iPrincipal) const
Definition: EDFilterBase.h:81
ModuleDescription moduleDescription_
Definition: EDFilterBase.h:157
void setModuleDescription(ModuleDescription const &md)
Definition: EDFilterBase.h:156
virtual bool hasAcquire() const
Definition: EDFilterBase.h:151
ModuleDescription const & moduleDescription() const
Definition: EDFilterBase.h:66
std::unique_ptr< std::vector< BranchID >[]> previousParentages_
Definition: EDFilterBase.h:158
std::unique_ptr< ParentageID[]> previousParentageIds_
Definition: EDFilterBase.h:160
std::unique_ptr< std::vector< BranchID >[]> gotBranchIDsFromAcquire_
Definition: EDFilterBase.h:159
static void fillDescriptions(edm::ConfigurationDescriptions &descriptions)
std::string workerType() const
Definition: EDFilterBase.h:119
HLT enums.
bool wantsStreamRuns() const final
Definition: WorkerT.cc:132
Definition: vlib.h:208
Definition: Run.h:45