#include <EDAnalyzerBase.h>

Inheritance diagram for edm::one::EDAnalyzerBase:

Public Types
typedef EDAnalyzerBase	ModuleType

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Public Member Functions
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

	EDAnalyzerBase ()

virtual SerialTaskQueue *	globalLuminosityBlocksQueue ()

virtual SerialTaskQueue *	globalRunsQueue ()

ModuleDescription const &	moduleDescription () const

virtual bool	wantsGlobalLuminosityBlocks () const =0

virtual bool	wantsGlobalRuns () const =0

virtual bool	wantsInputProcessBlocks () const =0

virtual bool	wantsProcessBlocks () const =0

bool	wantsStreamLuminosityBlocks () const

bool	wantsStreamRuns () const

	~EDAnalyzerBase () 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

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::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

bool	registeredToConsumeMany (TypeID const &, 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::ESRecordsToProxyIndices const &)

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	beginJob ()

virtual void	clearInputProcessBlockCaches ()

virtual SharedResourcesAcquirer	createAcquirer ()

void	doAccessInputProcessBlock (ProcessBlockPrincipal const &, ModuleCallingContext const *)

virtual void	doAccessInputProcessBlock_ (ProcessBlock const &)

void	doBeginJob ()

void	doBeginLuminosityBlock (LumiTransitionInfo const &, ModuleCallingContext const *)

virtual void	doBeginLuminosityBlock_ (LuminosityBlock const &lbp, EventSetup const &c)

void	doBeginProcessBlock (ProcessBlockPrincipal const &, ModuleCallingContext const *)

virtual void	doBeginProcessBlock_ (ProcessBlock const &)

void	doBeginRun (RunTransitionInfo const &, ModuleCallingContext const *)

virtual void	doBeginRun_ (Run const &rp, EventSetup const &c)

void	doEndJob ()

void	doEndLuminosityBlock (LumiTransitionInfo const &, ModuleCallingContext const *)

virtual void	doEndLuminosityBlock_ (LuminosityBlock const &lbp, EventSetup const &c)

void	doEndProcessBlock (ProcessBlockPrincipal const &, ModuleCallingContext const *)

virtual void	doEndProcessBlock_ (ProcessBlock const &)

void	doEndRun (RunTransitionInfo const &, ModuleCallingContext const *)

virtual void	doEndRun_ (Run const &rp, EventSetup const &c)

bool	doEvent (EventTransitionInfo const &, ActivityRegistry , ModuleCallingContext const )

void	doPreallocate (PreallocationConfiguration const &)

void	doRegisterThinnedAssociations (ProductRegistry const &, ThinnedAssociationsHelper &)

void	doRespondToCloseInputFile (FileBlock const &)

void	doRespondToCloseOutputFile ()

void	doRespondToOpenInputFile (FileBlock const &)

virtual void	endJob ()

bool	hasAccumulator () const

bool	hasAcquire () const

void	preActionBeforeRunEventAsync (WaitingTaskHolder, ModuleCallingContext const &, Principal const &) const

virtual void	preallocLumis (unsigned int)

void	registerProductsAndCallbacks (EDAnalyzerBase const module, ProductRegistry reg)

void	setModuleDescription (ModuleDescription const &md)

SharedResourcesAcquirer &	sharedResourcesAcquirer ()

std::string	workerType () const

Private Attributes
std::function< void(BranchDescription const &)>	callWhenNewProductsRegistered_

ModuleDescription	moduleDescription_

SharedResourcesAcquirer	resourcesAcquirer_

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)

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

Detailed Description

Definition at line 46 of file EDAnalyzerBase.h.

Member Typedef Documentation

typedef EDAnalyzerBase edm::one::EDAnalyzerBase::ModuleType

Definition at line 53 of file EDAnalyzerBase.h.

Constructor & Destructor Documentation

EDAnalyzerBase::EDAnalyzerBase ( )

Definition at line 46 of file EDAnalyzerBase.cc.

46 : moduleDescription_() {}

edm::one::EDAnalyzerBase::moduleDescription_

ModuleDescription moduleDescription_

Definition: EDAnalyzerBase.h:126

EDAnalyzerBase::~EDAnalyzerBase ( )

override

Definition at line 48 of file EDAnalyzerBase.cc.

48 {}

Member Function Documentation

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

privatepure virtual

Referenced by doEvent().

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

static

Definition at line 175 of file EDAnalyzerBase.cc.

References edm::one::kBaseType().

175 { return kBaseType; }

edm::one::kBaseType

static const std::string kBaseType("EDAnalyzer")

virtual void edm::one::EDAnalyzerBase::beginJob ( void )

inlineprivatevirtual

Definition at line 107 of file EDAnalyzerBase.h.

Referenced by doBeginJob().

107 {}

void EDAnalyzerBase::callWhenNewProductsRegistered ( std::function< void(BranchDescription const &)> const & func )

Definition at line 50 of file EDAnalyzerBase.cc.

References callWhenNewProductsRegistered_, and cms::cuda::func.

Referenced by DQMFileSaver::DQMFileSaver(), and edm::EventContentAnalyzer::EventContentAnalyzer().

                                                                                                               {
       callWhenNewProductsRegistered_ = func;
     }

void EDAnalyzerBase::clearInputProcessBlockCaches ( )

privatevirtual

Definition at line 163 of file EDAnalyzerBase.cc.

Referenced by doRespondToCloseOutputFile().

163 {}

SharedResourcesAcquirer EDAnalyzerBase::createAcquirer ( )

privatevirtual

Definition at line 68 of file EDAnalyzerBase.cc.

Referenced by doBeginJob().

                                                            {
       return SharedResourcesAcquirer{
           std::vector<std::shared_ptr<SerialTaskQueue>>(1, std::make_shared<SerialTaskQueue>())};
     }

void EDAnalyzerBase::doAccessInputProcessBlock	(	ProcessBlockPrincipal const &	pbp,
		ModuleCallingContext const *	mcc
	)

private

Definition at line 96 of file EDAnalyzerBase.cc.

References doAccessInputProcessBlock_(), moduleDescription_, and edm::ProcessBlock::setConsumer().

                                                                                                                     {
       ProcessBlock processBlock(pbp, moduleDescription_, mcc, false);
       processBlock.setConsumer(this);
       ProcessBlock const& constProcessBlock = processBlock;
       this->doAccessInputProcessBlock_(constProcessBlock);
     }

void EDAnalyzerBase::doAccessInputProcessBlock_ ( ProcessBlock const & )

privatevirtual

Definition at line 155 of file EDAnalyzerBase.cc.

Referenced by doAccessInputProcessBlock().

155 {}

void EDAnalyzerBase::doBeginJob ( )

private

Definition at line 76 of file EDAnalyzerBase.cc.

References beginJob(), createAcquirer(), and resourcesAcquirer_.

                                     {
       resourcesAcquirer_ = createAcquirer();
 
       this->beginJob();
     }

void EDAnalyzerBase::doBeginLuminosityBlock	(	LumiTransitionInfo const &	info,
		ModuleCallingContext const *	mcc
	)

private

Definition at line 130 of file EDAnalyzerBase.cc.

References edm::BeginLuminosityBlock, c, doBeginLuminosityBlock_(), edm::EDConsumerBase::esGetTokenIndices(), info(), moduleDescription_, and edm::LuminosityBlock::setConsumer().

                                                                                                                {
       LuminosityBlock lb(info, moduleDescription_, mcc, false);
       lb.setConsumer(this);
       LuminosityBlock const& cnstLb = lb;
       ESParentContext parentC(mcc);
       const EventSetup c{info,
                          static_cast<unsigned int>(Transition::BeginLuminosityBlock),
                          esGetTokenIndices(Transition::BeginLuminosityBlock),
                          parentC};
       this->doBeginLuminosityBlock_(cnstLb, c);
     }

void EDAnalyzerBase::doBeginLuminosityBlock_	(	LuminosityBlock const &	lbp,
		EventSetup const &	c
	)

privatevirtual

Definition at line 160 of file EDAnalyzerBase.cc.

Referenced by doBeginLuminosityBlock().

160 {}

void EDAnalyzerBase::doBeginProcessBlock	(	ProcessBlockPrincipal const &	pbp,
		ModuleCallingContext const *	mcc
	)

private

Definition at line 89 of file EDAnalyzerBase.cc.

References doBeginProcessBlock_(), moduleDescription_, and edm::ProcessBlock::setConsumer().

                                                                                                               {
       ProcessBlock processBlock(pbp, moduleDescription_, mcc, false);
       processBlock.setConsumer(this);
       ProcessBlock const& constProcessBlock = processBlock;
       this->doBeginProcessBlock_(constProcessBlock);
     }

void EDAnalyzerBase::doBeginProcessBlock_ ( ProcessBlock const & )

privatevirtual

Definition at line 154 of file EDAnalyzerBase.cc.

Referenced by doBeginProcessBlock().

154 {}

void EDAnalyzerBase::doBeginRun	(	RunTransitionInfo const &	info,
		ModuleCallingContext const *	mcc
	)

private

Definition at line 110 of file EDAnalyzerBase.cc.

References edm::BeginRun, c, doBeginRun_(), edm::EDConsumerBase::esGetTokenIndices(), info(), moduleDescription_, alignCSCRings::r, and edm::Run::setConsumer().

                                                                                                   {
       Run r(info, moduleDescription_, mcc, false);
       r.setConsumer(this);
       Run const& cnstR = r;
       ESParentContext parentC(mcc);
       const EventSetup c{
           info, static_cast<unsigned int>(Transition::BeginRun), esGetTokenIndices(Transition::BeginRun), parentC};
       this->doBeginRun_(cnstR, c);
     }

void EDAnalyzerBase::doBeginRun_	(	Run const &	rp,
		EventSetup const &	c
	)

privatevirtual

Definition at line 158 of file EDAnalyzerBase.cc.

Referenced by doBeginRun().

158 {}

void EDAnalyzerBase::doEndJob ( )

private

Definition at line 82 of file EDAnalyzerBase.cc.

References endJob().

82 { this->endJob(); }

edm::one::EDAnalyzerBase::endJob

virtual void endJob()

Definition: EDAnalyzerBase.h:108

void EDAnalyzerBase::doEndLuminosityBlock	(	LumiTransitionInfo const &	info,
		ModuleCallingContext const *	mcc
	)

private

Definition at line 142 of file EDAnalyzerBase.cc.

References c, doEndLuminosityBlock_(), edm::EndLuminosityBlock, edm::EDConsumerBase::esGetTokenIndices(), info(), moduleDescription_, and edm::LuminosityBlock::setConsumer().

                                                                                                              {
       LuminosityBlock lb(info, moduleDescription_, mcc, true);
       lb.setConsumer(this);
       LuminosityBlock const& cnstLb = lb;
       ESParentContext parentC(mcc);
       const EventSetup c{info,
                          static_cast<unsigned int>(Transition::EndLuminosityBlock),
                          esGetTokenIndices(Transition::EndLuminosityBlock),
                          parentC};
       this->doEndLuminosityBlock_(cnstLb, c);
     }

void EDAnalyzerBase::doEndLuminosityBlock_	(	LuminosityBlock const &	lbp,
		EventSetup const &	c
	)

privatevirtual

Definition at line 161 of file EDAnalyzerBase.cc.

Referenced by doEndLuminosityBlock().

161 {}

void EDAnalyzerBase::doEndProcessBlock	(	ProcessBlockPrincipal const &	pbp,
		ModuleCallingContext const *	mcc
	)

private

Definition at line 103 of file EDAnalyzerBase.cc.

References doEndProcessBlock_(), moduleDescription_, and edm::ProcessBlock::setConsumer().

                                                                                                             {
       ProcessBlock processBlock(pbp, moduleDescription_, mcc, true);
       processBlock.setConsumer(this);
       ProcessBlock const& constProcessBlock = processBlock;
       this->doEndProcessBlock_(constProcessBlock);
     }

void EDAnalyzerBase::doEndProcessBlock_ ( ProcessBlock const & )

privatevirtual

Definition at line 156 of file EDAnalyzerBase.cc.

Referenced by doEndProcessBlock().

156 {}

void EDAnalyzerBase::doEndRun	(	RunTransitionInfo const &	info,
		ModuleCallingContext const *	mcc
	)

private

Definition at line 120 of file EDAnalyzerBase.cc.

References c, doEndRun_(), edm::EndRun, edm::EDConsumerBase::esGetTokenIndices(), info(), moduleDescription_, alignCSCRings::r, and edm::Run::setConsumer().

                                                                                                 {
       Run r(info, moduleDescription_, mcc, true);
       r.setConsumer(this);
       Run const& cnstR = r;
       ESParentContext parentC(mcc);
       const EventSetup c{
           info, static_cast<unsigned int>(Transition::EndRun), esGetTokenIndices(Transition::EndRun), parentC};
       this->doEndRun_(cnstR, c);
     }

void EDAnalyzerBase::doEndRun_	(	Run const &	rp,
		EventSetup const &	c
	)

privatevirtual

Definition at line 159 of file EDAnalyzerBase.cc.

Referenced by doEndRun().

159 {}

bool EDAnalyzerBase::doEvent	(	EventTransitionInfo const &	info,
		ActivityRegistry *	act,
		ModuleCallingContext const *	mcc
	)

private

Definition at line 54 of file EDAnalyzerBase.cc.

References analyze(), c, alignCSCRings::e, edm::EDConsumerBase::esGetTokenIndices(), edm::Event, info(), moduleDescription_, resourcesAcquirer_, edm::Event::setConsumer(), and edm::Event::setSharedResourcesAcquirer().

                                                                   {
       Event e(info, moduleDescription_, mcc);
       e.setConsumer(this);
       e.setSharedResourcesAcquirer(&resourcesAcquirer_);
       EventSignalsSentry sentry(act, mcc);
       ESParentContext parentC(mcc);
       const EventSetup c{
           info, static_cast<unsigned int>(Transition::Event), esGetTokenIndices(Transition::Event), parentC};
       this->analyze(e, c);
       return true;
     }

void EDAnalyzerBase::doPreallocate ( PreallocationConfiguration const & iPrealloc )

private

Definition at line 84 of file EDAnalyzerBase.cc.

References edm::PreallocationConfiguration::numberOfLuminosityBlocks(), and preallocLumis().

                                                                                   {
       preallocLumis(iPrealloc.numberOfLuminosityBlocks());
     }

void edm::one::EDAnalyzerBase::doRegisterThinnedAssociations	(	ProductRegistry const &	,
		ThinnedAssociationsHelper &
	)

inlineprivate

Definition at line 99 of file EDAnalyzerBase.h.

99 {}

void edm::one::EDAnalyzerBase::doRespondToCloseInputFile ( FileBlock const & )

inlineprivate

Definition at line 97 of file EDAnalyzerBase.h.

97 {}

void edm::one::EDAnalyzerBase::doRespondToCloseOutputFile ( )

inlineprivate

Definition at line 98 of file EDAnalyzerBase.h.

References clearInputProcessBlockCaches().

98 { clearInputProcessBlockCaches(); }

edm::one::EDAnalyzerBase::clearInputProcessBlockCaches

virtual void clearInputProcessBlockCaches()

Definition: EDAnalyzerBase.cc:163

void edm::one::EDAnalyzerBase::doRespondToOpenInputFile ( FileBlock const & )

inlineprivate

Definition at line 96 of file EDAnalyzerBase.h.

96 {}

virtual void edm::one::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 165 of file EDAnalyzerBase.cc.

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

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

SerialTaskQueue * EDAnalyzerBase::globalLuminosityBlocksQueue ( )

virtual

Definition at line 74 of file EDAnalyzerBase.cc.

74 { return nullptr; };

SerialTaskQueue * EDAnalyzerBase::globalRunsQueue ( )

virtual

Definition at line 73 of file EDAnalyzerBase.cc.

73 { return nullptr; }

bool edm::one::EDAnalyzerBase::hasAccumulator ( ) const

inlineprivate

Definition at line 121 of file EDAnalyzerBase.h.

121 { return false; }

bool edm::one::EDAnalyzerBase::hasAcquire ( ) const

inlineprivate

Definition at line 120 of file EDAnalyzerBase.h.

120 { return false; }

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

inline

Definition at line 63 of file EDAnalyzerBase.h.

References moduleDescription_.

Referenced by edm::SecSourceAnalyzer::getBranches().

63 { return moduleDescription_; }

edm::one::EDAnalyzerBase::moduleDescription_

ModuleDescription moduleDescription_

Definition: EDAnalyzerBase.h:126

void edm::one::EDAnalyzerBase::preActionBeforeRunEventAsync	(	WaitingTaskHolder	,
		ModuleCallingContext const &	,
		Principal const &
	)		const

inlineprivate

Definition at line 79 of file EDAnalyzerBase.h.

81 {}

void EDAnalyzerBase::preallocLumis ( unsigned int )

privatevirtual

Definition at line 87 of file EDAnalyzerBase.cc.

Referenced by doPreallocate().

87 {};

void EDAnalyzerBase::prevalidate ( ConfigurationDescriptions & descriptions )

static

Definition at line 171 of file EDAnalyzerBase.cc.

References edm::edmodule_mightGet_config().

171 { edmodule_mightGet_config(iConfig); }

edm::edmodule_mightGet_config

void edmodule_mightGet_config(ConfigurationDescriptions &iDesc)

Definition: edmodule_mightGet_config.cc:36

iConfig

Definition: TSGFromPropagation.cc:56

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

private

Definition at line 177 of file EDAnalyzerBase.cc.

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

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