CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends
edm::global::EDAnalyzerBase Class Referenceabstract

#include <EDAnalyzerBase.h>

Inheritance diagram for edm::global::EDAnalyzerBase:
edm::EDConsumerBase edm::global::EDAnalyzer<> edm::global::EDAnalyzer< T > FTSLuminosityFromLumiSummary FTSLuminosityFromPileupSummaryInfo FTSLuminosityFromPixelClusters FTSLuminosityFromScalers FTSLuminosityFromVertices

Public Types

typedef EDAnalyzerBase ModuleType
 

Public Member Functions

 EDAnalyzerBase ()
 
ModuleDescription const & moduleDescription () const
 
virtual ~EDAnalyzerBase ()
 
- Public Member Functions inherited from edm::EDConsumerBase
 EDConsumerBase ()
 
ProductHolderIndexAndSkipBit indexFrom (EDGetToken, BranchType, TypeID const &) const
 
void itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
 
void itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
 
std::vector
< ProductHolderIndexAndSkipBit >
const & 
itemsToGetFromEvent () const
 
void labelsForToken (EDGetToken iToken, Labels &oLabels) const
 
bool registeredToConsume (ProductHolderIndex, bool, BranchType) const
 
bool registeredToConsumeMany (TypeID const &, BranchType) const
 
void updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)
 
virtual ~EDConsumerBase ()
 

Static Public Member Functions

static const std::string & baseType ()
 
static void fillDescriptions (ConfigurationDescriptions &descriptions)
 
static void prevalidate (ConfigurationDescriptions &descriptions)
 

Private Member Functions

virtual void analyze (StreamID, Event const &, EventSetup const &) const =0
 
virtual void beginJob ()
 
void doBeginJob ()
 
void doBeginLuminosityBlock (LuminosityBlockPrincipal &lbp, EventSetup const &c, ModuleCallingContext const *)
 
virtual void doBeginLuminosityBlock_ (LuminosityBlock const &lbp, EventSetup const &c)
 
virtual void doBeginLuminosityBlockSummary_ (LuminosityBlock const &rp, EventSetup const &c)
 
void doBeginRun (RunPrincipal &rp, EventSetup const &c, ModuleCallingContext const *)
 
virtual void doBeginRun_ (Run const &rp, EventSetup const &c)
 
virtual void doBeginRunSummary_ (Run const &rp, EventSetup const &c)
 
void doBeginStream (StreamID id)
 
virtual void doBeginStream_ (StreamID id)
 
void doEndJob ()
 
void doEndLuminosityBlock (LuminosityBlockPrincipal &lbp, EventSetup const &c, ModuleCallingContext const *)
 
virtual void doEndLuminosityBlock_ (LuminosityBlock const &lb, EventSetup const &c)
 
virtual void doEndLuminosityBlockSummary_ (LuminosityBlock const &lb, EventSetup const &c)
 
void doEndRun (RunPrincipal &rp, EventSetup const &c, ModuleCallingContext const *)
 
virtual void doEndRun_ (Run const &rp, EventSetup const &c)
 
virtual void doEndRunSummary_ (Run const &rp, EventSetup const &c)
 
void doEndStream (StreamID id)
 
virtual void doEndStream_ (StreamID id)
 
bool doEvent (EventPrincipal &ep, EventSetup const &c, ModuleCallingContext const *)
 
void doPostForkReacquireResources (unsigned int iChildIndex, unsigned int iNumberOfChildren)
 
void doPreallocate (PreallocationConfiguration const &)
 
void doPreForkReleaseResources ()
 
void doRespondToCloseInputFile (FileBlock const &fb)
 
void doRespondToOpenInputFile (FileBlock const &fb)
 
void doStreamBeginLuminosityBlock (StreamID id, LuminosityBlockPrincipal &ep, EventSetup const &c, ModuleCallingContext const *)
 
virtual void doStreamBeginLuminosityBlock_ (StreamID id, LuminosityBlock const &lbp, EventSetup const &c)
 
void doStreamBeginRun (StreamID id, RunPrincipal &ep, EventSetup const &c, ModuleCallingContext const *)
 
virtual void doStreamBeginRun_ (StreamID id, Run const &rp, EventSetup const &c)
 
void doStreamEndLuminosityBlock (StreamID id, LuminosityBlockPrincipal &ep, EventSetup const &c, ModuleCallingContext const *)
 
virtual void doStreamEndLuminosityBlock_ (StreamID id, LuminosityBlock const &lbp, EventSetup const &c)
 
virtual void doStreamEndLuminosityBlockSummary_ (StreamID id, LuminosityBlock const &lbp, EventSetup const &c)
 
void doStreamEndRun (StreamID id, RunPrincipal &ep, EventSetup const &c, ModuleCallingContext const *)
 
virtual void doStreamEndRun_ (StreamID id, Run const &rp, EventSetup const &c)
 
virtual void doStreamEndRunSummary_ (StreamID id, Run const &rp, EventSetup const &c)
 
virtual void endJob ()
 
virtual void preallocStreams (unsigned int)
 
void registerProductsAndCallbacks (EDAnalyzerBase *module, ProductRegistry *reg)
 
void setModuleDescription (ModuleDescription const &md)
 
std::string workerType () const
 

Private Attributes

std::function< void(BranchDescription
const &)> 
callWhenNewProductsRegistered_
 
ModuleDescription moduleDescription_
 

Friends

template<typename T >
class edm::maker::ModuleHolderT
 
template<typename T >
class edm::WorkerT
 

Additional Inherited Members

- Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType > consumes (edm::InputTag const &tag)
 
EDGetToken consumes (const TypeToGet &id, edm::InputTag const &tag)
 
template<BranchType B>
EDGetToken consumes (TypeToGet const &id, edm::InputTag const &tag)
 
ConsumesCollector consumesCollector ()
 Use a ConsumesCollector to gather consumes information from helper functions. More...
 
template<typename ProductType , BranchType B = InEvent>
void consumesMany ()
 
void consumesMany (const TypeToGet &id)
 
template<BranchType B>
void consumesMany (const TypeToGet &id)
 
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType > mayConsume (edm::InputTag const &tag)
 
EDGetToken mayConsume (const TypeToGet &id, edm::InputTag const &tag)
 
template<BranchType B>
EDGetToken mayConsume (const TypeToGet &id, edm::InputTag const &tag)
 

Detailed Description

Definition at line 42 of file EDAnalyzerBase.h.

Member Typedef Documentation

Definition at line 48 of file EDAnalyzerBase.h.

Constructor & Destructor Documentation

EDAnalyzerBase::EDAnalyzerBase ( )

Definition at line 45 of file EDAnalyzerBase.cc.

45  :
46  moduleDescription_() { }
ModuleDescription moduleDescription_
EDAnalyzerBase::~EDAnalyzerBase ( )
virtual

Definition at line 48 of file EDAnalyzerBase.cc.

49  {
50  }

Member Function Documentation

virtual void edm::global::EDAnalyzerBase::analyze ( StreamID  ,
Event const &  ,
EventSetup const &   
) const
privatepure virtual
const std::string & EDAnalyzerBase::baseType ( )
static

Definition at line 235 of file EDAnalyzerBase.cc.

References edm::global::kBaseType().

235  {
236  return kBaseType;
237  }
static const std::string kBaseType("EDAnalyzer")
virtual void edm::global::EDAnalyzerBase::beginJob ( void  )
inlineprivatevirtual

Definition at line 107 of file EDAnalyzerBase.h.

Referenced by doBeginJob().

107 {}
void EDAnalyzerBase::doBeginJob ( )
private

Definition at line 67 of file EDAnalyzerBase.cc.

References beginJob().

67  {
68  this->beginJob();
69  }
void EDAnalyzerBase::doBeginLuminosityBlock ( LuminosityBlockPrincipal lbp,
EventSetup const &  c,
ModuleCallingContext const *  mcc 
)
private

Definition at line 98 of file EDAnalyzerBase.cc.

References doBeginLuminosityBlock_(), doBeginLuminosityBlockSummary_(), moduleDescription_, and edm::LuminosityBlock::setConsumer().

99  {
100  LuminosityBlock lb(lbp, moduleDescription_, mcc);
101  lb.setConsumer(this);
102  LuminosityBlock const& cnstLb = lb;
103  this->doBeginLuminosityBlock_(cnstLb, c);
104  this->doBeginLuminosityBlockSummary_(cnstLb, c);
105  }
virtual void doBeginLuminosityBlockSummary_(LuminosityBlock const &rp, EventSetup const &c)
virtual void doBeginLuminosityBlock_(LuminosityBlock const &lbp, EventSetup const &c)
ModuleDescription moduleDescription_
void EDAnalyzerBase::doBeginLuminosityBlock_ ( LuminosityBlock const &  lbp,
EventSetup const &  c 
)
privatevirtual

Definition at line 204 of file EDAnalyzerBase.cc.

Referenced by doBeginLuminosityBlock().

204 {}
void EDAnalyzerBase::doBeginLuminosityBlockSummary_ ( LuminosityBlock const &  rp,
EventSetup const &  c 
)
privatevirtual

Definition at line 206 of file EDAnalyzerBase.cc.

Referenced by doBeginLuminosityBlock().

206 {}
void EDAnalyzerBase::doBeginRun ( RunPrincipal rp,
EventSetup const &  c,
ModuleCallingContext const *  mcc 
)
private

Definition at line 77 of file EDAnalyzerBase.cc.

References doBeginRun_(), doBeginRunSummary_(), moduleDescription_, alignCSCRings::r, and edm::Run::setConsumer().

78  {
79 
80  Run r(rp, moduleDescription_, mcc);
81  r.setConsumer(this);
82  Run const& cnstR = r;
83  this->doBeginRun_(cnstR, c);
84  this->doBeginRunSummary_(cnstR, c);
85  }
virtual void doBeginRunSummary_(Run const &rp, EventSetup const &c)
ModuleDescription moduleDescription_
virtual void doBeginRun_(Run const &rp, EventSetup const &c)
void EDAnalyzerBase::doBeginRun_ ( Run const &  rp,
EventSetup const &  c 
)
privatevirtual

Definition at line 199 of file EDAnalyzerBase.cc.

Referenced by doBeginRun().

199 {}
void EDAnalyzerBase::doBeginRunSummary_ ( Run const &  rp,
EventSetup const &  c 
)
privatevirtual

Definition at line 201 of file EDAnalyzerBase.cc.

Referenced by doBeginRun().

201 {}
void EDAnalyzerBase::doBeginStream ( StreamID  id)
private

Definition at line 118 of file EDAnalyzerBase.cc.

References doBeginStream_().

118  {
119  doBeginStream_(id);
120  }
virtual void doBeginStream_(StreamID id)
void EDAnalyzerBase::doBeginStream_ ( StreamID  id)
privatevirtual

Definition at line 189 of file EDAnalyzerBase.cc.

Referenced by doBeginStream().

189 {}
void EDAnalyzerBase::doEndJob ( )
private

Definition at line 72 of file EDAnalyzerBase.cc.

References endJob().

72  {
73  this->endJob();
74  }
void EDAnalyzerBase::doEndLuminosityBlock ( LuminosityBlockPrincipal lbp,
EventSetup const &  c,
ModuleCallingContext const *  mcc 
)
private

Definition at line 108 of file EDAnalyzerBase.cc.

References doEndLuminosityBlock_(), doEndLuminosityBlockSummary_(), moduleDescription_, and edm::LuminosityBlock::setConsumer().

109  {
110  LuminosityBlock lb(lbp, moduleDescription_, mcc);
111  lb.setConsumer(this);
112  LuminosityBlock const& cnstLb = lb;
113  this->doEndLuminosityBlockSummary_(cnstLb,c);
114  this->doEndLuminosityBlock_(cnstLb, c);
115  }
virtual void doEndLuminosityBlock_(LuminosityBlock const &lb, EventSetup const &c)
ModuleDescription moduleDescription_
virtual void doEndLuminosityBlockSummary_(LuminosityBlock const &lb, EventSetup const &c)
void EDAnalyzerBase::doEndLuminosityBlock_ ( LuminosityBlock const &  lb,
EventSetup const &  c 
)
privatevirtual

Definition at line 205 of file EDAnalyzerBase.cc.

Referenced by doEndLuminosityBlock().

205 {}
void EDAnalyzerBase::doEndLuminosityBlockSummary_ ( LuminosityBlock const &  lb,
EventSetup const &  c 
)
privatevirtual

Definition at line 207 of file EDAnalyzerBase.cc.

Referenced by doEndLuminosityBlock().

207 {}
void EDAnalyzerBase::doEndRun ( RunPrincipal rp,
EventSetup const &  c,
ModuleCallingContext const *  mcc 
)
private

Definition at line 88 of file EDAnalyzerBase.cc.

References doEndRun_(), doEndRunSummary_(), moduleDescription_, alignCSCRings::r, and edm::Run::setConsumer().

89  {
90  Run r(rp, moduleDescription_, mcc);
91  r.setConsumer(this);
92  Run const& cnstR = r;
93  this->doEndRunSummary_(r,c);
94  this->doEndRun_(cnstR, c);
95  }
virtual void doEndRun_(Run const &rp, EventSetup const &c)
ModuleDescription moduleDescription_
virtual void doEndRunSummary_(Run const &rp, EventSetup const &c)
void EDAnalyzerBase::doEndRun_ ( Run const &  rp,
EventSetup const &  c 
)
privatevirtual

Definition at line 200 of file EDAnalyzerBase.cc.

Referenced by doEndRun().

200 {}
void EDAnalyzerBase::doEndRunSummary_ ( Run const &  rp,
EventSetup const &  c 
)
privatevirtual

Definition at line 202 of file EDAnalyzerBase.cc.

Referenced by doEndRun().

202 {}
void EDAnalyzerBase::doEndStream ( StreamID  id)
private

Definition at line 122 of file EDAnalyzerBase.cc.

References doEndStream_().

122  {
123  doEndStream_(id);
124  }
virtual void doEndStream_(StreamID id)
void EDAnalyzerBase::doEndStream_ ( StreamID  id)
privatevirtual

Definition at line 190 of file EDAnalyzerBase.cc.

Referenced by doEndStream().

190 {}
bool EDAnalyzerBase::doEvent ( EventPrincipal ep,
EventSetup const &  c,
ModuleCallingContext const *  mcc 
)
private

Definition at line 53 of file EDAnalyzerBase.cc.

References analyze(), trackerHits::c, alignCSCRings::e, moduleDescription_, edm::Event::setConsumer(), and edm::Event::streamID().

54  {
55  Event e(ep, moduleDescription_, mcc);
56  e.setConsumer(this);
57  this->analyze(e.streamID(), e, c);
58  return true;
59  }
virtual void analyze(StreamID, Event const &, EventSetup const &) const =0
ModuleDescription moduleDescription_
void EDAnalyzerBase::doPostForkReacquireResources ( unsigned int  iChildIndex,
unsigned int  iNumberOfChildren 
)
private

Definition at line 184 of file EDAnalyzerBase.cc.

184  {
185  //postForkReacquireResources(iChildIndex, iNumberOfChildren);
186  }
void EDAnalyzerBase::doPreallocate ( PreallocationConfiguration const &  iPrealloc)
private

Definition at line 62 of file EDAnalyzerBase.cc.

References edm::PreallocationConfiguration::numberOfStreams(), and preallocStreams().

62  {
63  preallocStreams(iPrealloc.numberOfStreams());
64  }
virtual void preallocStreams(unsigned int)
void EDAnalyzerBase::doPreForkReleaseResources ( )
private

Definition at line 179 of file EDAnalyzerBase.cc.

179  {
180  //preForkReleaseResources();
181  }
void EDAnalyzerBase::doRespondToCloseInputFile ( FileBlock const &  fb)
private

Definition at line 174 of file EDAnalyzerBase.cc.

174  {
175  //respondToCloseInputFile(fb);
176  }
void EDAnalyzerBase::doRespondToOpenInputFile ( FileBlock const &  fb)
private

Definition at line 169 of file EDAnalyzerBase.cc.

169  {
170  //respondToOpenInputFile(fb);
171  }
void EDAnalyzerBase::doStreamBeginLuminosityBlock ( StreamID  id,
LuminosityBlockPrincipal ep,
EventSetup const &  c,
ModuleCallingContext const *  mcc 
)
private

Definition at line 146 of file EDAnalyzerBase.cc.

References doStreamBeginLuminosityBlock_(), moduleDescription_, and edm::LuminosityBlock::setConsumer().

149  {
150  LuminosityBlock lb(lbp, moduleDescription_, mcc);
151  lb.setConsumer(this);
152  this->doStreamBeginLuminosityBlock_(id,lb, c);
153  }
virtual void doStreamBeginLuminosityBlock_(StreamID id, LuminosityBlock const &lbp, EventSetup const &c)
ModuleDescription moduleDescription_
void EDAnalyzerBase::doStreamBeginLuminosityBlock_ ( StreamID  id,
LuminosityBlock const &  lbp,
EventSetup const &  c 
)
privatevirtual

Reimplemented in FTSLuminosityFromLumiSummary.

Definition at line 194 of file EDAnalyzerBase.cc.

Referenced by doStreamBeginLuminosityBlock().

194 {}
void EDAnalyzerBase::doStreamBeginRun ( StreamID  id,
RunPrincipal ep,
EventSetup const &  c,
ModuleCallingContext const *  mcc 
)
private

Definition at line 126 of file EDAnalyzerBase.cc.

References doStreamBeginRun_(), moduleDescription_, alignCSCRings::r, and edm::Run::setConsumer().

130  {
131  Run r(rp, moduleDescription_, mcc);
132  r.setConsumer(this);
133  this->doStreamBeginRun_(id, r, c);
134  }
virtual void doStreamBeginRun_(StreamID id, Run const &rp, EventSetup const &c)
ModuleDescription moduleDescription_
void EDAnalyzerBase::doStreamBeginRun_ ( StreamID  id,
Run const &  rp,
EventSetup const &  c 
)
privatevirtual

Definition at line 191 of file EDAnalyzerBase.cc.

Referenced by doStreamBeginRun().

191 {}
void EDAnalyzerBase::doStreamEndLuminosityBlock ( StreamID  id,
LuminosityBlockPrincipal ep,
EventSetup const &  c,
ModuleCallingContext const *  mcc 
)
private

Definition at line 156 of file EDAnalyzerBase.cc.

References doStreamEndLuminosityBlock_(), doStreamEndLuminosityBlockSummary_(), moduleDescription_, and edm::LuminosityBlock::setConsumer().

159  {
160  LuminosityBlock lb(lbp, moduleDescription_, mcc);
161  lb.setConsumer(this);
162  this->doStreamEndLuminosityBlock_(id,lb, c);
164  }
virtual void doStreamEndLuminosityBlockSummary_(StreamID id, LuminosityBlock const &lbp, EventSetup const &c)
ModuleDescription moduleDescription_
virtual void doStreamEndLuminosityBlock_(StreamID id, LuminosityBlock const &lbp, EventSetup const &c)
void EDAnalyzerBase::doStreamEndLuminosityBlock_ ( StreamID  id,
LuminosityBlock const &  lbp,
EventSetup const &  c 
)
privatevirtual

Definition at line 195 of file EDAnalyzerBase.cc.

Referenced by doStreamEndLuminosityBlock().

195 {}
void EDAnalyzerBase::doStreamEndLuminosityBlockSummary_ ( StreamID  id,
LuminosityBlock const &  lbp,
EventSetup const &  c 
)
privatevirtual

Definition at line 196 of file EDAnalyzerBase.cc.

Referenced by doStreamEndLuminosityBlock().

196 {}
void EDAnalyzerBase::doStreamEndRun ( StreamID  id,
RunPrincipal ep,
EventSetup const &  c,
ModuleCallingContext const *  mcc 
)
private

Definition at line 136 of file EDAnalyzerBase.cc.

References doStreamEndRun_(), doStreamEndRunSummary_(), moduleDescription_, alignCSCRings::r, and edm::Run::setConsumer().

139  {
140  Run r(rp, moduleDescription_, mcc);
141  r.setConsumer(this);
142  this->doStreamEndRun_(id, r, c);
143  this->doStreamEndRunSummary_(id, r, c);
144  }
virtual void doStreamEndRun_(StreamID id, Run const &rp, EventSetup const &c)
virtual void doStreamEndRunSummary_(StreamID id, Run const &rp, EventSetup const &c)
ModuleDescription moduleDescription_
void EDAnalyzerBase::doStreamEndRun_ ( StreamID  id,
Run const &  rp,
EventSetup const &  c 
)
privatevirtual

Definition at line 192 of file EDAnalyzerBase.cc.

Referenced by doStreamEndRun().

192 {}
void EDAnalyzerBase::doStreamEndRunSummary_ ( StreamID  id,
Run const &  rp,
EventSetup const &  c 
)
privatevirtual

Definition at line 193 of file EDAnalyzerBase.cc.

Referenced by doStreamEndRun().

193 {}
virtual void edm::global::EDAnalyzerBase::endJob ( void  )
inlineprivatevirtual

Definition at line 108 of file EDAnalyzerBase.h.

Referenced by doEndJob().

108 {}
void EDAnalyzerBase::fillDescriptions ( ConfigurationDescriptions descriptions)
static

Definition at line 210 of file EDAnalyzerBase.cc.

References edm::ConfigurationDescriptions::addDefault(), and edm::ParameterSetDescription::setUnknown().

210  {
212  desc.setUnknown();
213  descriptions.addDefault(desc);
214  }
ModuleDescription const& edm::global::EDAnalyzerBase::moduleDescription ( ) const
inline

Definition at line 58 of file EDAnalyzerBase.h.

References moduleDescription_.

58 { return moduleDescription_; }
ModuleDescription moduleDescription_
void EDAnalyzerBase::preallocStreams ( unsigned int  )
privatevirtual

Reimplemented in FTSLuminosityFromLumiSummary.

Definition at line 188 of file EDAnalyzerBase.cc.

Referenced by doPreallocate().

188 {}
void EDAnalyzerBase::prevalidate ( ConfigurationDescriptions descriptions)
static

Definition at line 217 of file EDAnalyzerBase.cc.

References edm::edmodule_mightGet_config().

217  {
218  edmodule_mightGet_config(iConfig);
219  }
void edmodule_mightGet_config(ConfigurationDescriptions &iDesc)
void EDAnalyzerBase::registerProductsAndCallbacks ( EDAnalyzerBase module,
ProductRegistry reg 
)
private

Definition at line 222 of file EDAnalyzerBase.cc.

References edm::ProductRegistry::callForEachBranch(), and callWhenNewProductsRegistered_.

222  {
223 
225 
226  reg->callForEachBranch(callWhenNewProductsRegistered_);
227 
229  regService->watchProductAdditions(callWhenNewProductsRegistered_);
230  }
231  }
std::function< void(BranchDescription const &)> callWhenNewProductsRegistered_
void edm::global::EDAnalyzerBase::setModuleDescription ( ModuleDescription const &  md)
inlineprivate

Definition at line 129 of file EDAnalyzerBase.h.

References moduleDescription_.

129  {
130  moduleDescription_ = md;
131  }
ModuleDescription moduleDescription_
std::string edm::global::EDAnalyzerBase::workerType ( ) const
inlineprivate

Definition at line 104 of file EDAnalyzerBase.h.

104 {return "WorkerT<EDAnalyzer>";}

Friends And Related Function Documentation

template<typename T >
friend class edm::maker::ModuleHolderT
friend

Definition at line 47 of file EDAnalyzerBase.h.

template<typename T >
friend class edm::WorkerT
friend

Definition at line 46 of file EDAnalyzerBase.h.

Member Data Documentation

std::function<void(BranchDescription const&)> edm::global::EDAnalyzerBase::callWhenNewProductsRegistered_
private

Definition at line 134 of file EDAnalyzerBase.h.

Referenced by registerProductsAndCallbacks().

ModuleDescription edm::global::EDAnalyzerBase::moduleDescription_
private