CMS 3D CMS Logo
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
DQMOneLumiEDAnalyzer< Args > Class Template Reference

#include <DQMOneEDAnalyzer.h>

Inheritance diagram for DQMOneLumiEDAnalyzer< Args >:
DQMOneEDAnalyzer< edm::EndLuminosityBlockProducer, edm::one::WatchLuminosityBlocks, Args... > edm::one::EDProducer< edm::EndRunProducer, edm::one::WatchRuns, edm::Accumulator, Args... > edm::one::EDProducerBase edm::ProducerBase edm::EDConsumerBase edm::ProductRegistryHelper

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
 
 EDProducer (const EDProducer &)=delete
 
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
 
const EDProducer & operator= (const EDProducer &)=delete
 
bool wantsGlobalLuminosityBlocks () const noexcept final
 
bool wantsGlobalRuns () const noexcept final
 
bool wantsInputProcessBlocks () const noexcept final
 
bool wantsProcessBlocks () const noexcept final
 
- Public Member Functions inherited from edm::one::EDProducerBase
 EDProducerBase ()
 
ModuleDescription const & moduleDescription () const
 
bool wantsStreamLuminosityBlocks () const noexcept
 
bool wantsStreamRuns () const noexcept
 
 ~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 const &)=delete
 
 EDConsumerBase (EDConsumerBase &&)=default
 
ESResolverIndex const * esGetTokenIndices (edm::Transition iTrans) const
 
std::vector< ESResolverIndex > 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::array< std::vector< ModuleDescription const *> *, NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, 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
 
void selectInputProcessBlocks (ProductRegistry const &productRegistry, ProcessBlockHelperBase const &processBlockHelperBase)
 
ProductResolverIndexAndSkipBit uncheckedIndexFrom (EDGetToken) const
 
void updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
 
void updateLookup (eventsetup::ESRecordsToProductResolverIndices 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<Transition Tr = Transition::Event>
auto produces (std::string instanceName) noexcept
 declare what type of product will make and with which optional label More...
 
template<Transition B>
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)
 
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 ()
 
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType > produces (std::string instanceName)
 
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType > produces ()
 
template<class ProductType >
BranchAliasSetterT< ProductType > produces (std::string instanceName)
 
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType > produces ()
 
template<Transition Tr = Transition::Event>
auto produces () noexcept
 
ProducesCollector producesCollector ()
 
- Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType > consumes (edm::InputTag const &tag)
 
template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B > consumes (edm::InputTag tag) noexcept
 
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 ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto esConsumes ()
 
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto esConsumes (ESInputTag const &tag)
 
template<Transition Tr = Transition::Event>
constexpr auto esConsumes ()
 
template<Transition Tr = Transition::Event>
auto esConsumes (ESInputTag tag)
 
template<Transition Tr = Transition::Event>
ESGetTokenGeneric esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
 Used with EventSetupRecord::doGet. More...
 
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)
 
void resetItemsToGetFrom (BranchType iType)
 

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
template<typename T >
using BranchAliasSetterT = ProductRegistryHelper::BranchAliasSetterT< T >
 
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.

96  {
97  // for whatever reason we need the explicit `template` keyword here.
98  lumiToken_ = this->template produces<DQMToken, edm::Transition::EndLuminosityBlock>("DQMGenerationRecoLumi");
99  }
DQMOneLumiEDAnalyzer::lumiToken_
edm::EDPutTokenT< DQMToken > lumiToken_
Definition: DQMOneEDAnalyzer.h:126

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.

107 { this->analyze(event, setup); }
singleTopDQM_cfi.setup
setup
SETUP
Definition: singleTopDQM_cfi.py:37
event
Definition: event.py:1

◆ 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.

101  {
102  edm::Service<dqm::legacy::DQMStore>()->enterLumi(
103  lumi.run(), lumi.luminosityBlock(), this->moduleDescription().id());
104  dqmBeginLuminosityBlock(lumi, setup);
105  }
DQMOneLumiEDAnalyzer::dqmBeginLuminosityBlock
virtual void dqmBeginLuminosityBlock(edm::LuminosityBlock const &, edm::EventSetup const &)
Definition: DQMOneEDAnalyzer.h:123
edm::one::EDProducerBase::moduleDescription
ModuleDescription const & moduleDescription() const
Definition: EDProducerBase.h:65
edm::ModuleDescription::id
unsigned int id() const
Definition: ModuleDescription.h:46
singleTopDQM_cfi.setup
setup
SETUP
Definition: singleTopDQM_cfi.py:37

◆ dqmBeginLuminosityBlock()

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

Reimplemented in Vx3DHLTAnalyzer, DTDCSByLumiTask, BeamSpotDipServer, and BeamSpotProblemMonitor.

Definition at line 123 of file DQMOneEDAnalyzer.h.

Referenced by DQMOneLumiEDAnalyzer<>::beginLuminosityBlock().

123 {}

◆ dqmEndLuminosityBlock()

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

Reimplemented in Vx3DHLTAnalyzer, DTDCSByLumiTask, BeamSpotDipServer, and BeamSpotProblemMonitor.

Definition at line 124 of file DQMOneEDAnalyzer.h.

Referenced by DQMOneLumiEDAnalyzer<>::endLuminosityBlockProduce().

124 {}

◆ endLuminosityBlock()

template<typename... Args>
void DQMOneLumiEDAnalyzer< Args >::endLuminosityBlock ( edm::LuminosityBlock const &  ,
edm::EventSetup const &   
)
inlinefinal

Definition at line 119 of file DQMOneEDAnalyzer.h.

119 {}

◆ endLuminosityBlockProduce()

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

Definition at line 109 of file DQMOneEDAnalyzer.h.

109  {
110  dqmEndLuminosityBlock(lumi, setup);
111  // fully qualified name required for... reasons.
112  edm::Service<dqm::legacy::DQMStore>()->leaveLumi(
113  lumi.run(), lumi.luminosityBlock(), this->moduleDescription().id());
114  lumi.emplace(lumiToken_);
115  }
DQMOneLumiEDAnalyzer::lumiToken_
edm::EDPutTokenT< DQMToken > lumiToken_
Definition: DQMOneEDAnalyzer.h:126
edm::one::EDProducerBase::moduleDescription
ModuleDescription const & moduleDescription() const
Definition: EDProducerBase.h:65
edm::ModuleDescription::id
unsigned int id() const
Definition: ModuleDescription.h:46
DQMOneLumiEDAnalyzer::dqmEndLuminosityBlock
virtual void dqmEndLuminosityBlock(edm::LuminosityBlock const &, edm::EventSetup const &)
Definition: DQMOneEDAnalyzer.h:124
singleTopDQM_cfi.setup
setup
SETUP
Definition: singleTopDQM_cfi.py:37
edm::LuminosityBlock::emplace
void emplace(EDPutTokenT< PROD > token, Args &&... args)
puts a new product
Definition: LuminosityBlock.h:245

◆ 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.

93 { 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().

Generated for CMSSW Reference Manual by doxygen 1.8.14