edm::stream::EDAnalyzerBase Class Reference

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

Inheritance diagram for edm::stream::EDAnalyzerBase:

Public Types
typedef EDAnalyzerAdaptorBase	ModuleType
Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Public Member Functions
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
	EDAnalyzerBase ()
ModuleDescription const &	moduleDescription () const
virtual	~EDAnalyzerBase ()
Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const
	EDConsumerBase ()
	EDConsumerBase (EDConsumerBase const &)=delete
	EDConsumerBase (EDConsumerBase &&)=default
ProductResolverIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
std::vector< ProductResolverIndexAndSkipBit > const &	itemsToGetFromEvent () const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
EDConsumerBase const &	operator= (EDConsumerBase const &)=delete
EDConsumerBase &	operator= (EDConsumerBase &&)=default
bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
virtual	~EDConsumerBase () noexcept(false)

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 (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 EDAnalyzerBase &	operator= (const EDAnalyzerBase &)=delete
virtual void	postForkReacquireResources (unsigned int, unsigned int)
virtual void	preForkReleaseResources ()
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

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

Description: [one line class summary]

Usage: <usage>

Definition at line 35 of file EDAnalyzerBase.h.

Member Typedef Documentation

typedef EDAnalyzerAdaptorBase edm::stream::EDAnalyzerBase::ModuleType

Definition at line 41 of file EDAnalyzerBase.h.

Constructor & Destructor Documentation

EDAnalyzerBase::EDAnalyzerBase

(

)

Definition at line 37 of file EDAnalyzerBase.cc.

Referenced by moduleDescription().

                              : moduleDescriptionPtr_(nullptr)
{
}

EDAnalyzerBase::~EDAnalyzerBase ( )

virtual

Definition at line 46 of file EDAnalyzerBase.cc.

{
}

edm::stream::EDAnalyzerBase::EDAnalyzerBase ( const EDAnalyzerBase &  )

privatedelete

Member Function Documentation

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

privatepure virtual

Implemented in ExoticaDQM, TriggerJSONMonitoring, EcalMixingModuleValidation, B2GDQM, L1TriggerJSONMonitoring, METMonitor, HLTriggerJSONMonitoring, TriggerRatesMonitor, TriggerBxVsOrbitMonitor, TriggerBxMonitor, L1TStage2CaloLayer2Offline, EcalDigisValidation, HcalRecHitsAnalyzer, TauValidation, HcalRecHitsValidation, DQMExample_Step1, PSMonitor, HiggsDQM, EcalBarrelDigisValidation, EcalEndcapDigisValidation, LumiMonitor, EcalSelectiveReadoutValidation, V0Monitor, HcalSimHitsValidation, HotlineDQM, SUSY_HLT_Razor, TotemRPDQMSource, SUSY_HLT_DiJet_MET, SUSY_HLT_ElecFakes, SUSY_HLT_MuEle_Hadronic, SUSY_HLT_Muon_Hadronic, SUSY_HLT_MuonFakes, SUSY_HLT_VBF_Mu, edm::EventSetupRecordDataGetter, SUSY_HLT_alphaT, SUSY_HLT_DoubleEle_Hadronic, SUSY_HLT_Electron_BJet, BPhysicsSpectrum, BPhysicsValidation, HiggsValidation, BasicHepMCValidation, SUSY_HLT_DoubleMuon_Hadronic, SUSY_HLT_Muon_BJet, DrellYanValidation, BasicHepMCHeavyIonValidation, SUSY_HLT_PhotonHT, SUSY_HLT_PhotonMET, dqm::RamdiskMonitor, TotemDAQTriggerDQMSource, CaloTowersAnalyzer, SUSY_HLT_InclusiveHT, CaloTowersValidation, hcaldqm::DQTask, EcalFEDMonitorTemp< SUBDET >, EcalDQMonitorTask, StandaloneTrackMonitor, HeavyIonUCCDQM, ZDCTask, TrackTypeMonitor, EventShapeDQM, CentralityDQM, CentralitypADQM, PFCandidateDQMAnalyzer, PFJetDQMAnalyzer, PFMETDQMAnalyzer, and PFMuonDQMAnalyzer.

Referenced by beginLuminosityBlock().

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

static

Definition at line 104 of file EDAnalyzerBase.cc.

References edm::kBaseType().

                         {
  return kBaseType;
}

virtual void edm::stream::EDAnalyzerBase::beginLuminosityBlock ( edm::LuminosityBlock const &  , edm::EventSetup const &    )

inlineprivatevirtual

Reimplemented in L1TBPTX, TriggerJSONMonitoring, L1TEfficiencyMuons_Offline, L1TSync_Offline, L1TriggerJSONMonitoring, L1TSync, HLTriggerJSONMonitoring, DTDigiTask, L1TRPCTPG, LogMessageMonitor, L1TStage2CaloLayer2Offline, L1TRate_Offline, L1TRate, PixelLumiDQM, DTSegmentAnalysisTask, GeneralHLTOffline, DQMExample_Step1, SiPixelDigiSource, L1TDTTPG, DTChamberEfficiencyTask, DTDCSByLumiTask, HiggsDQM, SUSY_HLT_Razor, TotemRPDQMSource, DTResolutionAnalysisTask, dEdxAnalyzer, edm::EventSetupRecordDataGetter, SUSY_HLT_DiJet_MET, SUSY_HLT_ElecFakes, SUSY_HLT_MuEle_Hadronic, SUSY_HLT_Muon_Hadronic, SUSY_HLT_MuonFakes, SUSY_HLT_VBF_Mu, SUSY_HLT_alphaT, DTEfficiencyTask, L1TDTTF, SUSY_HLT_DoubleEle_Hadronic, SUSY_HLT_Electron_BJet, SUSY_HLT_DoubleMuon_Hadronic, SUSY_HLT_Muon_BJet, SUSY_HLT_PhotonHT, SUSY_HLT_PhotonMET, hcaldqm::DQTask, TotemDAQTriggerDQMSource, SUSY_HLT_InclusiveHT, DigiPhase1Task, DigiTask, dqm::RamdiskMonitor, RecHitTask, RawTask, TPTask, EcalDQMonitorTask, PedestalTask, and NoCQTask.

Definition at line 67 of file EDAnalyzerBase.h.

References analyze().

{}

virtual void edm::stream::EDAnalyzerBase::beginRun ( edm::Run const &  , edm::EventSetup const &    )

inlineprivatevirtual

Reimplemented in TriggerJSONMonitoring, L1TriggerJSONMonitoring, HLTriggerJSONMonitoring, edm::EventSetupRecordDataGetter, HLTEventAnalyzerAOD, HLTEventAnalyzerRAW, and DQMEDAnalyzer.

Definition at line 66 of file EDAnalyzerBase.h.

{}

virtual void edm::stream::EDAnalyzerBase::beginStream ( StreamID  )

inlineprivatevirtual

Reimplemented in DQMEDAnalyzer.

Definition at line 65 of file EDAnalyzerBase.h.

{}

void EDAnalyzerBase::callWhenNewProductsRegistered

(

std::function< void(BranchDescription const &)> const &

func

)

Definition at line 66 of file EDAnalyzerBase.cc.

References callWhenNewProductsRegistered_, and RecoEcal_EventContent_cff::func.

Referenced by moduleDescription().

                                                                                                     {
  callWhenNewProductsRegistered_ = func;
}

virtual void edm::stream::EDAnalyzerBase::endLuminosityBlock ( edm::LuminosityBlock const &  , edm::EventSetup const &    )

inlineprivatevirtual

Reimplemented in L1TBPTX, L1TSync, LogMessageMonitor, L1TStage2CaloLayer2Offline, L1TRate_Offline, L1TRate, PixelLumiDQM, GeneralHLTOffline, DTSegmentAnalysisTask, DQMExample_Step1, SiPixelDigiSource, HiggsDQM, SUSY_HLT_Razor, TotemRPDQMSource, dEdxAnalyzer, SUSY_HLT_DiJet_MET, SUSY_HLT_ElecFakes, SUSY_HLT_MuEle_Hadronic, SUSY_HLT_Muon_Hadronic, SUSY_HLT_MuonFakes, SUSY_HLT_VBF_Mu, SUSY_HLT_alphaT, SUSY_HLT_DoubleEle_Hadronic, SUSY_HLT_Electron_BJet, SUSY_HLT_DoubleMuon_Hadronic, SUSY_HLT_Muon_BJet, hcaldqm::DQTask, SUSY_HLT_PhotonHT, SUSY_HLT_PhotonMET, LaserTask, TotemDAQTriggerDQMSource, DigiPhase1Task, DigiTask, UMNioTask, SUSY_HLT_InclusiveHT, RecHitTask, RawTask, StandaloneTrackMonitor, TrackTypeMonitor, EcalDQMonitorTask, PedestalTask, QIE10Task, QIE11Task, TPTask, TPComparisonTask, ElectronDqmAnalyzerBase, DigiComparisonTask, ScoutingAnalyzerBase, NoCQTask, TestTask, and evf::ExceptionGenerator.

Definition at line 69 of file EDAnalyzerBase.h.

{}

virtual void edm::stream::EDAnalyzerBase::endRun ( edm::Run const &  , edm::EventSetup const &    )

inlineprivatevirtual

Reimplemented in MuonTrackValidator, HLTObjectMonitor, HLTObjectMonitorProtonLead, EmDQM, PhotonValidator, L1TStage2CaloLayer2Offline, LogMessageMonitor, MuonTrackResidualAnalyzer, TkConvValidator, SiStripFEDCheckPlugin, SiStripMonitorPedestals, DQMExample_Step1, PhotonValidatorMiniAOD, PixelLumiDQM, HiggsDQM, SiStripMonitorQuality, SiStripMonitorRawData, SUSY_HLT_Razor, TotemRPDQMSource, SUSY_HLT_DiJet_MET, SUSY_HLT_ElecFakes, SUSY_HLT_MuEle_Hadronic, SUSY_HLT_Muon_Hadronic, SUSY_HLT_MuonFakes, SUSY_HLT_VBF_Mu, SUSY_HLT_alphaT, SUSY_HLT_DoubleEle_Hadronic, SUSY_HLT_Electron_BJet, SUSY_HLT_DoubleMuon_Hadronic, SUSY_HLT_Muon_BJet, SUSY_HLT_PhotonHT, SUSY_HLT_PhotonMET, RecoMuonValidator, TotemDAQTriggerDQMSource, SUSY_HLT_InclusiveHT, PedestalTask, HLTEventAnalyzerAOD, HLTEventAnalyzerRAW, UMNioTask, EcalDQMonitorTask, LaserTask, LEDTask, ElectronDqmAnalyzerBase, and ScoutingTestAnalyzer.

Definition at line 70 of file EDAnalyzerBase.h.

{}

virtual void edm::stream::EDAnalyzerBase::endStream ( )

inlineprivatevirtual

Definition at line 71 of file EDAnalyzerBase.h.

{}

void EDAnalyzerBase::fillDescriptions ( ConfigurationDescriptions &  descriptions )

static

Definition at line 90 of file EDAnalyzerBase.cc.

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

                                                                        {
  ParameterSetDescription desc;
  desc.setUnknown();
  descriptions.addDefault(desc);
}

ModuleDescription const& edm::stream::EDAnalyzerBase::moduleDescription ( ) const

inline

Definition at line 52 of file EDAnalyzerBase.h.

References callWhenNewProductsRegistered(), EDAnalyzerBase(), RecoEcal_EventContent_cff::func, RecoTauPiZeroBuilderPlugins_cfi::function, moduleDescriptionPtr_, operator=(), and registerProductsAndCallbacks().

Referenced by DQMDcsInfo::bookHistograms(), and DQMEventInfo::bookHistograms().

                                                         {
        return *moduleDescriptionPtr_;
      }

const EDAnalyzerBase& edm::stream::EDAnalyzerBase::operator= ( const EDAnalyzerBase &  )

privatedelete

Referenced by moduleDescription().

virtual void edm::stream::EDAnalyzerBase::postForkReacquireResources ( unsigned  int, unsigned  int  )

inlineprivatevirtual

Definition at line 74 of file EDAnalyzerBase.h.

{}

virtual void edm::stream::EDAnalyzerBase::preForkReleaseResources ( )

inlineprivatevirtual

Definition at line 73 of file EDAnalyzerBase.h.

{}

void EDAnalyzerBase::prevalidate ( ConfigurationDescriptions &  descriptions )

static

Definition at line 97 of file EDAnalyzerBase.cc.

References edm::edmodule_mightGet_config(), edm::kBaseType(), and AlCaHLTBitMon_QueryRunRegistry::string.

                                                              {
  edmodule_mightGet_config(iConfig);
}

void EDAnalyzerBase::registerProductsAndCallbacks ( EDAnalyzerBase const *  , ProductRegistry *  reg  )

private

Definition at line 71 of file EDAnalyzerBase.cc.

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

Referenced by moduleDescription().

                                                                                        {
  
  if (callWhenNewProductsRegistered_) {
    
    reg->callForEachBranch(callWhenNewProductsRegistered_);
    
    Service<ConstProductRegistry> regService;
    regService->watchProductAdditions(callWhenNewProductsRegistered_);
  }
}

void edm::stream::EDAnalyzerBase::setModuleDescriptionPtr ( ModuleDescription const *  iDesc )

inlineprivate

Definition at line 77 of file EDAnalyzerBase.h.

References moduleDescriptionPtr_.

Referenced by edm::stream::EDAnalyzerAdaptorBase::setModuleDescriptionPtr().

                                                                   {
        moduleDescriptionPtr_ = iDesc;
      }

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 81 of file EDAnalyzerBase.h.

Referenced by callWhenNewProductsRegistered(), and registerProductsAndCallbacks().

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

private

Definition at line 82 of file EDAnalyzerBase.h.

Referenced by moduleDescription(), and setModuleDescriptionPtr().