DQMOneLumiEDAnalyzer< Args > Class Template Reference

#include <DQMOneEDAnalyzer.h>

Inheritance diagram for DQMOneLumiEDAnalyzer< Args >:

Public Member Functions
void	accumulate (edm::Event const &event, edm::EventSetup const &setup) override
void	beginLuminosityBlock (edm::LuminosityBlock const &lumi, edm::EventSetup const &setup) final
	DQMOneLumiEDAnalyzer ()
void	endLuminosityBlock (edm::LuminosityBlock const &, edm::EventSetup const &) final
void	endLuminosityBlockProduce (edm::LuminosityBlock &lumi, edm::EventSetup const &setup) final
bool	getCanSaveByLumi () override
Public Member Functions inherited from DQMOneEDAnalyzer< edm::EndLuminosityBlockProducer, edm::one::WatchLuminosityBlocks, Args... >
void	accumulate (edm::Event const &event, edm::EventSetup const &setup) override
void	beginRun (edm::Run const &run, edm::EventSetup const &setup) final
	DQMOneEDAnalyzer ()
void	endRun (edm::Run const &, edm::EventSetup const &) final
void	endRunProduce (edm::Run &run, edm::EventSetup const &setup) final
Public Member Functions inherited from edm::one::EDProducer< edm::EndRunProducer, edm::one::WatchRuns, edm::Accumulator, Args... >
	EDProducer ()=default
SerialTaskQueue *	globalLuminosityBlocksQueue () final
SerialTaskQueue *	globalRunsQueue () final
bool	hasAbilityToProduceInBeginLumis () const final
bool	hasAbilityToProduceInBeginProcessBlocks () const final
bool	hasAbilityToProduceInBeginRuns () const final
bool	hasAbilityToProduceInEndLumis () const final
bool	hasAbilityToProduceInEndProcessBlocks () const final
bool	hasAbilityToProduceInEndRuns () const final
bool	wantsGlobalLuminosityBlocks () const final
bool	wantsGlobalRuns () const final
bool	wantsInputProcessBlocks () const final
bool	wantsProcessBlocks () const final
Public Member Functions inherited from edm::one::EDProducerBase
	EDProducerBase ()
ModuleDescription const &	moduleDescription () const
bool	wantsStreamLuminosityBlocks () const
bool	wantsStreamRuns () const
	~EDProducerBase () override
Public Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
std::vector< edm::ProductResolverIndex > const &	indiciesForPutProducts (BranchType iBranchType) const
	ProducerBase ()
std::vector< edm::ProductResolverIndex > const &	putTokenIndexToProductResolverIndex () const
std::vector< bool > const &	recordProvenanceList () const
void	registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...
void	resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)
TypeLabelList const &	typeLabelList () const
	used by the fwk to register the list of products of this module More...
	~ProducerBase () noexcept(false) override
Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const
void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...
	EDConsumerBase ()
	EDConsumerBase (EDConsumerBase &&)=default
	EDConsumerBase (EDConsumerBase const &)=delete
ESProxyIndex const *	esGetTokenIndices (edm::Transition iTrans) const
std::vector< ESProxyIndex > const &	esGetTokenIndicesVector (edm::Transition iTrans) const
std::vector< ESRecordIndex > const &	esGetTokenRecordIndicesVector (edm::Transition iTrans) const
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 &	itemsToGetFrom (BranchType iType) 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 &	operator= (EDConsumerBase &&)=default
EDConsumerBase const &	operator= (EDConsumerBase const &)=delete
bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const
void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)
virtual	~EDConsumerBase () noexcept(false)

Protected Member Functions
virtual void	dqmBeginLuminosityBlock (edm::LuminosityBlock const &, edm::EventSetup const &)
virtual void	dqmEndLuminosityBlock (edm::LuminosityBlock const &, edm::EventSetup const &)
Protected Member Functions inherited from DQMOneEDAnalyzer< edm::EndLuminosityBlockProducer, edm::one::WatchLuminosityBlocks, Args... >
virtual void	analyze (edm::Event const &, edm::EventSetup const &)
virtual void	bookHistograms (DQMStore::IBooker &, edm::Run const &, edm::EventSetup const &)=0
virtual void	dqmBeginRun (edm::Run const &, edm::EventSetup const &)
virtual void	dqmEndRun (edm::Run const &, edm::EventSetup const &)
Protected Member Functions inherited from edm::ProducerBase
template<class ProductType >
BranchAliasSetterT< ProductType >	produces ()
	declare what type of product will make and with which optional label More...
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces ()
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces ()
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
template<BranchType B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
template<Transition B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)
template<class ProductType >
BranchAliasSetterT< ProductType >	produces (std::string instanceName)
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)
ProducesCollector	producesCollector ()
Protected Member Functions inherited from edm::EDConsumerBase
EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)
template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept
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 ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()
template<Transition Tr = Transition::Event>
constexpr auto	esConsumes () noexcept
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)
template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag) noexcept
template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

Protected Attributes
edm::EDPutTokenT< DQMToken >	lumiToken_
Protected Attributes inherited from DQMOneEDAnalyzer< edm::EndLuminosityBlockProducer, edm::one::WatchLuminosityBlocks, Args... >
edm::EDPutTokenT< DQMToken >	runToken_

Additional Inherited Members
Public Types inherited from DQMOneEDAnalyzer< edm::EndLuminosityBlockProducer, edm::one::WatchLuminosityBlocks, Args... >
typedef dqm::reco::DQMStore	DQMStore
typedef dqm::reco::MonitorElement	MonitorElement
Public Types inherited from edm::one::EDProducerBase
typedef EDProducerBase	ModuleType
Public Types inherited from edm::ProducerBase
using	ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const *, const char *, edm::ProductResolverIndex > >
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList
Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels
Static Public Member Functions inherited from edm::one::EDProducerBase
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &descriptions)

Detailed Description

template<typename... Args>
class DQMOneLumiEDAnalyzer< Args >

A "one" module base class that can also watch lumi transitions and produce per-lumi MEs. This should be used carefully, since it will block concurrent lumisections in the entire job! Combining with edm::LuminosityBlockCache is pointless and will not work properly, due to the ordering of global/produce transitions.

Definition at line 90 of file DQMOneEDAnalyzer.h.

Constructor & Destructor Documentation

DQMOneLumiEDAnalyzer()

template<typename... Args>

DQMOneLumiEDAnalyzer< Args >::DQMOneLumiEDAnalyzer ( )

inline

Definition at line 96 of file DQMOneEDAnalyzer.h.

                         {
    // for whatever reason we need the explicit `template` keyword here.
    lumiToken_ = this->template produces<DQMToken, edm::Transition::EndLuminosityBlock>("DQMGenerationRecoLumi");
  }

Member Function Documentation

accumulate()

template<typename... Args>

void DQMOneLumiEDAnalyzer< Args >::accumulate ( edm::Event const &  event, edm::EventSetup const &  setup  )

inlineoverride

Definition at line 107 of file DQMOneEDAnalyzer.h.

{ this->analyze(event, setup); }

beginLuminosityBlock()

template<typename... Args>

void DQMOneLumiEDAnalyzer< Args >::beginLuminosityBlock ( edm::LuminosityBlock const &  lumi, edm::EventSetup const &  setup  )

inlinefinal

Definition at line 101 of file DQMOneEDAnalyzer.h.

                                                                                              {
    edm::Service<dqm::legacy::DQMStore>()->enterLumi(
        lumi.run(), lumi.luminosityBlock(), this->moduleDescription().id());
    dqmBeginLuminosityBlock(lumi, setup);
  }

dqmBeginLuminosityBlock()

template<typename... Args>

virtual void DQMOneLumiEDAnalyzer< Args >::dqmBeginLuminosityBlock ( edm::LuminosityBlock const &  , edm::EventSetup const &    )

inlineprotectedvirtual

Reimplemented in DTDCSByLumiTask, SiPixelDigiSource, BeamSpotProblemMonitor, and Vx3DHLTAnalyzer.

Definition at line 123 of file DQMOneEDAnalyzer.h.

{}

Referenced by DQMOneLumiEDAnalyzer<>::beginLuminosityBlock().

dqmEndLuminosityBlock()

template<typename... Args>

virtual void DQMOneLumiEDAnalyzer< Args >::dqmEndLuminosityBlock ( edm::LuminosityBlock const &  , edm::EventSetup const &    )

inlineprotectedvirtual

Reimplemented in SiPixelDigiSource, BeamSpotProblemMonitor, DTDCSByLumiTask, and Vx3DHLTAnalyzer.

Definition at line 124 of file DQMOneEDAnalyzer.h.

{}

Referenced by DQMOneLumiEDAnalyzer<>::endLuminosityBlockProduce().

endLuminosityBlock()

template<typename... Args>

void DQMOneLumiEDAnalyzer< Args >::endLuminosityBlock ( edm::LuminosityBlock const &  , edm::EventSetup const &    )

inlinefinal

Definition at line 119 of file DQMOneEDAnalyzer.h.

{};

endLuminosityBlockProduce()

template<typename... Args>

void DQMOneLumiEDAnalyzer< Args >::endLuminosityBlockProduce ( edm::LuminosityBlock &  lumi, edm::EventSetup const &  setup  )

inlinefinal

Definition at line 109 of file DQMOneEDAnalyzer.h.

                                                                                             {
    dqmEndLuminosityBlock(lumi, setup);
    // fully qualified name required for... reasons.
    edm::Service<dqm::legacy::DQMStore>()->leaveLumi(
        lumi.run(), lumi.luminosityBlock(), this->moduleDescription().id());
    lumi.emplace(lumiToken_);
  }

getCanSaveByLumi()

template<typename... Args>

bool DQMOneLumiEDAnalyzer< Args >::getCanSaveByLumi ( )

inlineoverridevirtual

Reimplemented from DQMOneEDAnalyzer< edm::EndLuminosityBlockProducer, edm::one::WatchLuminosityBlocks, Args... >.

Definition at line 93 of file DQMOneEDAnalyzer.h.

{ return true; }

Member Data Documentation

lumiToken_

template<typename... Args>

edm::EDPutTokenT<DQMToken> DQMOneLumiEDAnalyzer< Args >::lumiToken_

protected

Definition at line 126 of file DQMOneEDAnalyzer.h.

Referenced by DQMOneLumiEDAnalyzer<>::DQMOneLumiEDAnalyzer(), and DQMOneLumiEDAnalyzer<>::endLuminosityBlockProduce().