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 | Protected Member Functions | Private Member Functions | Private Attributes | Friends
edm::stream::EDAnalyzerBase Class Referenceabstract

#include "FWCore/Framework/interface/stream/EDAnalyzerBase.h"

Inheritance diagram for edm::stream::EDAnalyzerBase:
edm::EDConsumerBase edm::stream::EDAnalyzer< edm::RunSummaryCache< dqmDetails::NoCache >, edm::LuminosityBlockSummaryCache< dqmDetails::NoCache > > edm::stream::EDAnalyzer< T > DQMEDAnalyzer DQMDcsInfo DQMEventInfo

Public Types

typedef EDAnalyzerAdaptorBase 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)
 

Protected Member Functions

void callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
 
- 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)
 

Private Member Functions

virtual void analyze (Event const &, EventSetup const &)=0
 
virtual void beginLuminosityBlock (edm::LuminosityBlock const &, edm::EventSetup const &)
 
virtual void beginRun (edm::Run const &, edm::EventSetup const &)
 
virtual void beginStream (StreamID)
 
 EDAnalyzerBase (const EDAnalyzerBase &)=delete
 
virtual void endLuminosityBlock (edm::LuminosityBlock const &, edm::EventSetup const &)
 
virtual void endRun (edm::Run const &, edm::EventSetup const &)
 
virtual void endStream ()
 
const EDAnalyzerBaseoperator= (const EDAnalyzerBase &)=delete
 
void registerProductsAndCallbacks (EDAnalyzerBase const *, ProductRegistry *reg)
 
void setModuleDescriptionPtr (ModuleDescription const *iDesc)
 

Private Attributes

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

Friends

class EDAnalyzerAdaptorBase
 

Detailed Description

Description: [one line class summary]

Usage: <usage>

Definition at line 35 of file EDAnalyzerBase.h.

Member Typedef Documentation

Definition at line 41 of file EDAnalyzerBase.h.

Constructor & Destructor Documentation

EDAnalyzerBase::EDAnalyzerBase ( )

Definition at line 37 of file EDAnalyzerBase.cc.

37  : moduleDescriptionPtr_(nullptr)
38 {
39 }
ModuleDescription const * moduleDescriptionPtr_
EDAnalyzerBase::~EDAnalyzerBase ( )
virtual

Definition at line 46 of file EDAnalyzerBase.cc.

47 {
48 }
edm::stream::EDAnalyzerBase::EDAnalyzerBase ( const EDAnalyzerBase )
privatedelete

Member Function Documentation

virtual void edm::stream::EDAnalyzerBase::analyze ( Event const &  ,
EventSetup const &   
)
privatepure virtual

Implemented in DQMEventInfo, and DQMDcsInfo.

const std::string & EDAnalyzerBase::baseType ( )
static

Definition at line 104 of file EDAnalyzerBase.cc.

References edm::kBaseType().

104  {
105  return kBaseType;
106 }
static const std::string kBaseType("EDAnalyzer")
virtual void edm::stream::EDAnalyzerBase::beginLuminosityBlock ( edm::LuminosityBlock const &  ,
edm::EventSetup const &   
)
inlineprivatevirtual

Reimplemented in DQMEventInfo.

Definition at line 68 of file EDAnalyzerBase.h.

68 {}
virtual void edm::stream::EDAnalyzerBase::beginRun ( edm::Run const &  ,
edm::EventSetup const &   
)
inlineprivatevirtual

Reimplemented in DQMEDAnalyzer.

Definition at line 67 of file EDAnalyzerBase.h.

67 {}
virtual void edm::stream::EDAnalyzerBase::beginStream ( StreamID  )
inlineprivatevirtual

Reimplemented in DQMEDAnalyzer.

Definition at line 66 of file EDAnalyzerBase.h.

66 {}
void EDAnalyzerBase::callWhenNewProductsRegistered ( std::function< void(BranchDescription const &)> const &  func)
protected

Definition at line 66 of file EDAnalyzerBase.cc.

References callWhenNewProductsRegistered_, and statics::func.

66  {
68 }
std::function< void(BranchDescription const &)> callWhenNewProductsRegistered_
string func
Definition: statics.py:48
virtual void edm::stream::EDAnalyzerBase::endLuminosityBlock ( edm::LuminosityBlock const &  ,
edm::EventSetup const &   
)
inlineprivatevirtual

Reimplemented in DQMDcsInfo.

Definition at line 70 of file EDAnalyzerBase.h.

70 {}
virtual void edm::stream::EDAnalyzerBase::endRun ( edm::Run const &  ,
edm::EventSetup const &   
)
inlineprivatevirtual

Definition at line 71 of file EDAnalyzerBase.h.

71 {}
virtual void edm::stream::EDAnalyzerBase::endStream ( )
inlineprivatevirtual

Definition at line 72 of file EDAnalyzerBase.h.

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

Definition at line 90 of file EDAnalyzerBase.cc.

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

90  {
92  desc.setUnknown();
93  descriptions.addDefault(desc);
94 }
ModuleDescription const& edm::stream::EDAnalyzerBase::moduleDescription ( ) const
inline

Definition at line 52 of file EDAnalyzerBase.h.

References moduleDescriptionPtr_.

52  {
53  return *moduleDescriptionPtr_;
54  }
ModuleDescription const * moduleDescriptionPtr_
const EDAnalyzerBase& edm::stream::EDAnalyzerBase::operator= ( const EDAnalyzerBase )
privatedelete
void EDAnalyzerBase::prevalidate ( ConfigurationDescriptions descriptions)
static

Definition at line 97 of file EDAnalyzerBase.cc.

References edm::edmodule_mightGet_config().

97  {
98  edmodule_mightGet_config(iConfig);
99 }
void edmodule_mightGet_config(ConfigurationDescriptions &iDesc)
void EDAnalyzerBase::registerProductsAndCallbacks ( EDAnalyzerBase const *  ,
ProductRegistry reg 
)
private

Definition at line 71 of file EDAnalyzerBase.cc.

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

71  {
72 
74 
75  reg->callForEachBranch(callWhenNewProductsRegistered_);
76 
77  Service<ConstProductRegistry> regService;
78  regService->watchProductAdditions(callWhenNewProductsRegistered_);
79  }
80 }
std::function< void(BranchDescription const &)> callWhenNewProductsRegistered_
void edm::stream::EDAnalyzerBase::setModuleDescriptionPtr ( ModuleDescription const *  iDesc)
inlineprivate

Definition at line 74 of file EDAnalyzerBase.h.

References moduleDescriptionPtr_.

74  {
75  moduleDescriptionPtr_ = iDesc;
76  }
ModuleDescription const * moduleDescriptionPtr_

Friends And Related Function Documentation

friend class EDAnalyzerAdaptorBase
friend

Definition at line 38 of file EDAnalyzerBase.h.

Member Data Documentation

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

Definition at line 78 of file EDAnalyzerBase.h.

Referenced by callWhenNewProductsRegistered(), and registerProductsAndCallbacks().

ModuleDescription const* edm::stream::EDAnalyzerBase::moduleDescriptionPtr_
private

Definition at line 79 of file EDAnalyzerBase.h.

Referenced by moduleDescription(), and setModuleDescriptionPtr().