edm::stream::ProducingModuleAdaptorBase< T > Class Template Reference

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

Public Types
using	ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const *, const char *, edm::ProductResolverIndex >>

Public Member Functions
std::vector< ConsumesInfo >	consumesInfo () const
void	convertCurrentProcessAlias (std::string const &processName)
virtual bool	hasAccumulator () const =0
virtual bool	hasAcquire () const =0
std::vector< edm::ProductResolverIndex > const &	indiciesForPutProducts (BranchType iBranchType) const
void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
std::vector< ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType) const
const ModuleDescription &	moduleDescription () const
void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
	ProducingModuleAdaptorBase ()
void	registerProductsAndCallbacks (ProducingModuleAdaptorBase const *, ProductRegistry *reg)
void	resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)
void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)
virtual bool	wantsGlobalLuminosityBlocks () const =0
virtual bool	wantsGlobalRuns () const =0
bool	wantsStreamLuminosityBlocks () const
bool	wantsStreamRuns () const
virtual	~ProducingModuleAdaptorBase ()

Protected Member Functions
void	commit (Run &iRun)
void	commit (LuminosityBlock &iLumi)
template<typename I >
void	commit (Event &iEvent, I *iID)
const EDConsumerBase *	consumer ()
template<typename F >
void	createStreamModules (F iFunc)
const ProducerBase *	producer ()

Protected Attributes
std::vector< T * >	m_streamModules

Private Member Functions
void	doBeginJob ()
virtual void	doBeginLuminosityBlock (LuminosityBlockPrincipal const &lbp, EventSetupImpl const &c, ModuleCallingContext const *)=0
virtual void	doBeginRun (RunPrincipal const &rp, EventSetupImpl const &c, ModuleCallingContext const *)=0
void	doBeginStream (StreamID id)
virtual void	doEndJob ()=0
virtual void	doEndLuminosityBlock (LuminosityBlockPrincipal const &lbp, EventSetupImpl const &c, ModuleCallingContext const *)=0
virtual void	doEndRun (RunPrincipal const &rp, EventSetupImpl const &c, ModuleCallingContext const *)=0
void	doEndStream (StreamID id)
void	doPreallocate (PreallocationConfiguration const &)
void	doRegisterThinnedAssociations (ProductRegistry const &, ThinnedAssociationsHelper &)
void	doRespondToCloseInputFile (FileBlock const &fb)
void	doRespondToOpenInputFile (FileBlock const &fb)
void	doStreamBeginLuminosityBlock (StreamID id, LuminosityBlockPrincipal const &ep, EventSetupImpl const &c, ModuleCallingContext const *)
void	doStreamBeginRun (StreamID id, RunPrincipal const &ep, EventSetupImpl const &c, ModuleCallingContext const *)
void	doStreamEndLuminosityBlock (StreamID id, LuminosityBlockPrincipal const &ep, EventSetupImpl const &c, ModuleCallingContext const *)
void	doStreamEndRun (StreamID id, RunPrincipal const &ep, EventSetupImpl const &c, ModuleCallingContext const *)
const ProducingModuleAdaptorBase &	operator= (const ProducingModuleAdaptorBase &)=delete
virtual void	preallocLumis (unsigned int)
	ProducingModuleAdaptorBase (const ProducingModuleAdaptorBase &)=delete
void	setModuleDescription (ModuleDescription const &md)
virtual void	setupLuminosityBlock (T *, LuminosityBlockIndex)=0
virtual void	setupRun (T *, RunIndex)=0
virtual void	setupStreamModules ()=0
virtual void	streamEndLuminosityBlockSummary (T *, edm::LuminosityBlock const &, edm::EventSetup const &)=0
virtual void	streamEndRunSummary (T *, edm::Run const &, edm::EventSetup const &)=0

Private Attributes
ModuleDescription	moduleDescription_

Friends
template<typename U >
class	edm::maker::ModuleHolderT
template<typename U >
class	edm::WorkerT

Detailed Description

template<typename T>
class edm::stream::ProducingModuleAdaptorBase< T >

Description: [one line class summary]

Usage: <usage>

Definition at line 68 of file Event.h.

Member Typedef Documentation

template<typename T>

using edm::stream::ProducingModuleAdaptorBase< T >::ModuleToResolverIndicies = std::unordered_multimap<std::string, std::tuple<edm::TypeID const*, const char*, edm::ProductResolverIndex>>

Definition at line 107 of file ProducingModuleAdaptorBase.h.

Constructor & Destructor Documentation

template<typename T >

edm::stream::ProducingModuleAdaptorBase< T >::ProducingModuleAdaptorBase

(

)

Definition at line 39 of file ProducingModuleAdaptorBase.cc.

{}

template<typename T >

edm::stream::ProducingModuleAdaptorBase< T >::~ProducingModuleAdaptorBase ( )

virtual

Definition at line 42 of file ProducingModuleAdaptorBase.cc.

References funct::m.

                                                               {
      for (auto m : m_streamModules) {
        delete m;
      }
    }

template<typename T>

edm::stream::ProducingModuleAdaptorBase< T >::ProducingModuleAdaptorBase ( const ProducingModuleAdaptorBase< T > &  )

privatedelete

Member Function Documentation

template<typename T>

void edm::stream::ProducingModuleAdaptorBase< T >::commit ( Run &  iRun )

inlineprotected

Definition at line 124 of file ProducingModuleAdaptorBase.h.

{ iRun.commit_(m_streamModules[0]->indiciesForPutProducts(InRun)); }

template<typename T>

void edm::stream::ProducingModuleAdaptorBase< T >::commit ( LuminosityBlock &  iLumi )

inlineprotected

Definition at line 125 of file ProducingModuleAdaptorBase.h.

{ iLumi.commit_(m_streamModules[0]->indiciesForPutProducts(InLumi)); }

template<typename T>

template<typename I >

void edm::stream::ProducingModuleAdaptorBase< T >::commit ( Event &  iEvent, I *  iID  )

inlineprotected

Definition at line 127 of file ProducingModuleAdaptorBase.h.

                                         {
        iEvent.commit_(m_streamModules[0]->indiciesForPutProducts(InEvent), iID);
      }

template<typename T>

const EDConsumerBase* edm::stream::ProducingModuleAdaptorBase< T >::consumer ( )

inlineprotected

Definition at line 131 of file ProducingModuleAdaptorBase.h.

{ return m_streamModules[0]; }

template<typename T >

std::vector< edm::ConsumesInfo > edm::stream::ProducingModuleAdaptorBase< T >::consumesInfo

(

)

const

Definition at line 122 of file ProducingModuleAdaptorBase.cc.

                                                                                 {
      assert(not m_streamModules.empty());
      return m_streamModules[0]->consumesInfo();
    }

template<typename T >

void edm::stream::ProducingModuleAdaptorBase< T >::convertCurrentProcessAlias

(

std::string const &

processName

)

Definition at line 115 of file ProducingModuleAdaptorBase.cc.

References mod().

                                                                                               {
      for (auto mod : m_streamModules) {
        mod->convertCurrentProcessAlias(processName);
      }
    }

template<typename T>

template<typename F >

void edm::stream::ProducingModuleAdaptorBase< T >::createStreamModules ( F  iFunc )

inlineprotected

Definition at line 117 of file ProducingModuleAdaptorBase.h.

                                        {
        for (auto& m : m_streamModules) {
          m = iFunc();
          m->setModuleDescriptionPtr(&moduleDescription_);
        }
      }

template<typename T >

void edm::stream::ProducingModuleAdaptorBase< T >::doBeginJob ( )

private

Definition at line 158 of file ProducingModuleAdaptorBase.cc.

{}

template<typename T>

virtual void edm::stream::ProducingModuleAdaptorBase< T >::doBeginLuminosityBlock ( LuminosityBlockPrincipal const &  lbp, EventSetupImpl const &  c, ModuleCallingContext const *    )

privatepure virtual

template<typename T>

virtual void edm::stream::ProducingModuleAdaptorBase< T >::doBeginRun ( RunPrincipal const &  rp, EventSetupImpl const &  c, ModuleCallingContext const *    )

privatepure virtual

template<typename T >

void edm::stream::ProducingModuleAdaptorBase< T >::doBeginStream ( StreamID  id )

private

Definition at line 161 of file ProducingModuleAdaptorBase.cc.

References triggerObjects_cff::id.

                                                                 {
      m_streamModules[id]->beginStream(id);
    }

template<typename T>

virtual void edm::stream::ProducingModuleAdaptorBase< T >::doEndJob ( )

privatepure virtual

template<typename T>

virtual void edm::stream::ProducingModuleAdaptorBase< T >::doEndLuminosityBlock ( LuminosityBlockPrincipal const &  lbp, EventSetupImpl const &  c, ModuleCallingContext const *    )

privatepure virtual

template<typename T>

virtual void edm::stream::ProducingModuleAdaptorBase< T >::doEndRun ( RunPrincipal const &  rp, EventSetupImpl const &  c, ModuleCallingContext const *    )

privatepure virtual

template<typename T >

void edm::stream::ProducingModuleAdaptorBase< T >::doEndStream ( StreamID  id )

private

Definition at line 165 of file ProducingModuleAdaptorBase.cc.

References triggerObjects_cff::id.

                                                               {
      m_streamModules[id]->endStream();
    }

template<typename T >

void edm::stream::ProducingModuleAdaptorBase< T >::doPreallocate ( PreallocationConfiguration const &  iPrealloc )

private

Definition at line 53 of file ProducingModuleAdaptorBase.cc.

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

                                                                                                 {
      m_streamModules.resize(iPrealloc.numberOfStreams(), static_cast<T*>(nullptr));
      setupStreamModules();
      preallocLumis(iPrealloc.numberOfLuminosityBlocks());
    }

template<typename T >

void edm::stream::ProducingModuleAdaptorBase< T >::doRegisterThinnedAssociations ( ProductRegistry const &  registry, ThinnedAssociationsHelper &  helper  )

private

Definition at line 233 of file ProducingModuleAdaptorBase.cc.

References mod().

                                                                                                         {
      assert(not m_streamModules.empty());
      auto mod = m_streamModules[0];
      mod->registerThinnedAssociations(registry, helper);
    }

template<typename T >

void edm::stream::ProducingModuleAdaptorBase< T >::doRespondToCloseInputFile ( FileBlock const &  fb )

private

Definition at line 230 of file ProducingModuleAdaptorBase.cc.

{}

template<typename T >

void edm::stream::ProducingModuleAdaptorBase< T >::doRespondToOpenInputFile ( FileBlock const &  fb )

private

Definition at line 228 of file ProducingModuleAdaptorBase.cc.

{}

template<typename T >

void edm::stream::ProducingModuleAdaptorBase< T >::doStreamBeginLuminosityBlock ( StreamID  id, LuminosityBlockPrincipal const &  ep, EventSetupImpl const &  c, ModuleCallingContext const *  mcc  )

private

Definition at line 197 of file ProducingModuleAdaptorBase.cc.

References edm::BeginLuminosityBlock, EnergyCorrector::c, triggerObjects_cff::id, edm::LuminosityBlockPrincipal::index(), and mod().

                                                                                                      {
      auto mod = m_streamModules[id];
      setupLuminosityBlock(mod, lbp.index());

      LuminosityBlock lb(lbp, moduleDescription_, mcc, false);
      lb.setConsumer(mod);
      const EventSetup c{ci,
                         static_cast<unsigned int>(Transition::BeginLuminosityBlock),
                         mod->esGetTokenIndices(Transition::BeginLuminosityBlock)};
      mod->beginLuminosityBlock(lb, c);
    }

template<typename T >

void edm::stream::ProducingModuleAdaptorBase< T >::doStreamBeginRun ( StreamID  id, RunPrincipal const &  ep, EventSetupImpl const &  c, ModuleCallingContext const *  mcc  )

private

Definition at line 170 of file ProducingModuleAdaptorBase.cc.

References edm::BeginRun, EnergyCorrector::c, triggerObjects_cff::id, edm::RunPrincipal::index(), mod(), and alignCSCRings::r.

                                                                                          {
      auto mod = m_streamModules[id];
      setupRun(mod, rp.index());

      Run r(rp, moduleDescription_, mcc, false);
      r.setConsumer(mod);
      const EventSetup c{
          ci, static_cast<unsigned int>(Transition::BeginRun), mod->esGetTokenIndices(Transition::BeginRun)};
      mod->beginRun(r, c);
    }

template<typename T >

void edm::stream::ProducingModuleAdaptorBase< T >::doStreamEndLuminosityBlock ( StreamID  id, LuminosityBlockPrincipal const &  ep, EventSetupImpl const &  c, ModuleCallingContext const *  mcc  )

private

Definition at line 213 of file ProducingModuleAdaptorBase.cc.

References EnergyCorrector::c, edm::EndLuminosityBlock, triggerObjects_cff::id, mod(), and edm::LuminosityBlock::setConsumer().

                                                                                                    {
      auto mod = m_streamModules[id];
      LuminosityBlock lb(lbp, moduleDescription_, mcc, true);
      lb.setConsumer(mod);
      const EventSetup c{ci,
                         static_cast<unsigned int>(Transition::EndLuminosityBlock),
                         mod->esGetTokenIndices(Transition::EndLuminosityBlock)};
      mod->endLuminosityBlock(lb, c);
      streamEndLuminosityBlockSummary(mod, lb, c);
    }

template<typename T >

void edm::stream::ProducingModuleAdaptorBase< T >::doStreamEndRun ( StreamID  id, RunPrincipal const &  ep, EventSetupImpl const &  c, ModuleCallingContext const *  mcc  )

private

Definition at line 184 of file ProducingModuleAdaptorBase.cc.

References EnergyCorrector::c, edm::EndRun, triggerObjects_cff::id, mod(), alignCSCRings::r, and edm::Run::setConsumer().

                                                                                        {
      auto mod = m_streamModules[id];
      Run r(rp, moduleDescription_, mcc, true);
      r.setConsumer(mod);
      const EventSetup c{ci, static_cast<unsigned int>(Transition::EndRun), mod->esGetTokenIndices(Transition::EndRun)};
      mod->endRun(r, c);
      streamEndRunSummary(mod, r, c);
    }

template<typename T>

virtual bool edm::stream::ProducingModuleAdaptorBase< T >::hasAccumulator ( ) const

pure virtual

template<typename T>

virtual bool edm::stream::ProducingModuleAdaptorBase< T >::hasAcquire ( ) const

pure virtual

template<typename T >

std::vector< edm::ProductResolverIndex > const & edm::stream::ProducingModuleAdaptorBase< T >::indiciesForPutProducts

(

BranchType

iBranchType

)

const

Definition at line 152 of file ProducingModuleAdaptorBase.cc.

Referenced by edm::WorkerT< T >::updateLookup().

                                      {
      return m_streamModules[0]->indiciesForPutProducts(iBranchType);
    }

template<typename T >

void edm::stream::ProducingModuleAdaptorBase< T >::itemsMayGet	(	BranchType	iType,
		std::vector< ProductResolverIndexAndSkipBit > &	iIndices
	)		const

Definition at line 91 of file ProducingModuleAdaptorBase.cc.

                                                                                                               {
      assert(not m_streamModules.empty());
      m_streamModules[0]->itemsMayGet(iType, iIndices);
    }

template<typename T >

void edm::stream::ProducingModuleAdaptorBase< T >::itemsToGet	(	BranchType	iType,
		std::vector< ProductResolverIndexAndSkipBit > &	iIndices
	)		const

Definition at line 84 of file ProducingModuleAdaptorBase.cc.

                                                                                                              {
      assert(not m_streamModules.empty());
      m_streamModules[0]->itemsToGet(iType, iIndices);
    }

template<typename T >

std::vector< edm::ProductResolverIndexAndSkipBit > const & edm::stream::ProducingModuleAdaptorBase< T >::itemsToGetFrom

(

BranchType

iType

)

const

Definition at line 98 of file ProducingModuleAdaptorBase.cc.

                                {
      assert(not m_streamModules.empty());
      return m_streamModules[0]->itemsToGetFrom(iType);
    }

template<typename T>

const ModuleDescription& edm::stream::ProducingModuleAdaptorBase< T >::moduleDescription ( ) const

inline

Definition at line 79 of file ProducingModuleAdaptorBase.h.

{ return moduleDescription_; }

template<typename T >

void edm::stream::ProducingModuleAdaptorBase< T >::modulesWhoseProductsAreConsumed	(	std::vector< ModuleDescription const * > &	modules,
		ProductRegistry const &	preg,
		std::map< std::string, ModuleDescription const * > const &	labelsToDesc,
		std::string const &	processName
	)		const

Definition at line 105 of file ProducingModuleAdaptorBase.cc.

                                            {
      assert(not m_streamModules.empty());
      return m_streamModules[0]->modulesWhoseProductsAreConsumed(modules, preg, labelsToDesc, processName);
    }

template<typename T>

const ProducingModuleAdaptorBase& edm::stream::ProducingModuleAdaptorBase< T >::operator= ( const ProducingModuleAdaptorBase< T > &  )

privatedelete

template<typename T>

virtual void edm::stream::ProducingModuleAdaptorBase< T >::preallocLumis ( unsigned  int )

inlineprivatevirtual

Definition at line 141 of file ProducingModuleAdaptorBase.h.

{}

template<typename T>

const ProducerBase* edm::stream::ProducingModuleAdaptorBase< T >::producer ( )

inlineprotected

Definition at line 133 of file ProducingModuleAdaptorBase.h.

{ return m_streamModules[0]; }

template<typename T >

void edm::stream::ProducingModuleAdaptorBase< T >::registerProductsAndCallbacks	(	ProducingModuleAdaptorBase< T > const *	,
		ProductRegistry *	reg
	)

Definition at line 60 of file ProducingModuleAdaptorBase.cc.

References EnergyCorrector::c, callbacks, and mod().

                                                                                           {
      auto firstMod = m_streamModules[0];
      if (firstMod->registrationCallback() and m_streamModules.size() > 1) {
        //we have a callback so we will collect all callbacks and create a new callback which calls them all.

        std::vector<std::function<void(BranchDescription const&)>> callbacks;
        callbacks.reserve(m_streamModules.size());

        for (auto mod : m_streamModules) {
          callbacks.push_back(mod->registrationCallback());
        }
        //Since only the first module will actually do the registration
        // we will change its callback to call all the callbacks
        firstMod->callWhenNewProductsRegistered([callbacks](BranchDescription const& iBD) {
          for (auto c : callbacks) {
            c(iBD);
          }
        });
      }
      firstMod->registerProducts(firstMod, reg, moduleDescription_);
    }

template<typename T >

void edm::stream::ProducingModuleAdaptorBase< T >::resolvePutIndicies	(	BranchType	iBranchType,
		ModuleToResolverIndicies const &	iIndicies,
		std::string const &	moduleLabel
	)

Definition at line 143 of file ProducingModuleAdaptorBase.cc.

References mod().

Referenced by edm::WorkerT< T >::updateLookup().

                                                                                         {
      for (auto mod : m_streamModules) {
        mod->resolvePutIndicies(iBranchType, iIndicies, moduleLabel);
      }
    }

template<typename T>

void edm::stream::ProducingModuleAdaptorBase< T >::setModuleDescription ( ModuleDescription const &  md )

inlineprivate

Definition at line 179 of file ProducingModuleAdaptorBase.h.

{ moduleDescription_ = md; }

template<typename T>

virtual void edm::stream::ProducingModuleAdaptorBase< T >::setupLuminosityBlock ( T *  , LuminosityBlockIndex    )

privatepure virtual

template<typename T>

virtual void edm::stream::ProducingModuleAdaptorBase< T >::setupRun ( T *  , RunIndex    )

privatepure virtual

template<typename T>

virtual void edm::stream::ProducingModuleAdaptorBase< T >::setupStreamModules ( )

privatepure virtual

template<typename T>

virtual void edm::stream::ProducingModuleAdaptorBase< T >::streamEndLuminosityBlockSummary ( T *  , edm::LuminosityBlock const &  , edm::EventSetup const &    )

privatepure virtual

template<typename T>

virtual void edm::stream::ProducingModuleAdaptorBase< T >::streamEndRunSummary ( T *  , edm::Run const &  , edm::EventSetup const &    )

privatepure virtual

template<typename T >

void edm::stream::ProducingModuleAdaptorBase< T >::updateLookup	(	BranchType	iBranchType,
		ProductResolverIndexHelper const &	iHelper,
		bool	iPrefetchMayGet
	)

Definition at line 128 of file ProducingModuleAdaptorBase.cc.

References mod().

                                                                           {
      for (auto mod : m_streamModules) {
        mod->updateLookup(iType, iHelper, iPrefetchMayGet);
      }
    }

template<typename T >

void edm::stream::ProducingModuleAdaptorBase< T >::updateLookup

(

eventsetup::ESRecordsToProxyIndices const &

iPI

)

Definition at line 136 of file ProducingModuleAdaptorBase.cc.

References mod().

                                                                                                 {
      for (auto mod : m_streamModules) {
        mod->updateLookup(iPI);
      }
    }

template<typename T>

virtual bool edm::stream::ProducingModuleAdaptorBase< T >::wantsGlobalLuminosityBlocks ( ) const

pure virtual

template<typename T>

virtual bool edm::stream::ProducingModuleAdaptorBase< T >::wantsGlobalRuns ( ) const

pure virtual

template<typename T>

bool edm::stream::ProducingModuleAdaptorBase< T >::wantsStreamLuminosityBlocks ( ) const

inline

Definition at line 86 of file ProducingModuleAdaptorBase.h.

{ return true; }

template<typename T>

bool edm::stream::ProducingModuleAdaptorBase< T >::wantsStreamRuns ( ) const

inline

Definition at line 85 of file ProducingModuleAdaptorBase.h.

{ return true; }

Friends And Related Function Documentation

template<typename T>

template<typename U >

friend class edm::maker::ModuleHolderT

friend

Definition at line 69 of file ProducingModuleAdaptorBase.h.

template<typename T>

template<typename U >

friend class edm::WorkerT

friend

Definition at line 67 of file ProducingModuleAdaptorBase.h.

Member Data Documentation

template<typename T>

std::vector<T*> edm::stream::ProducingModuleAdaptorBase< T >::m_streamModules

protected

Definition at line 183 of file ProducingModuleAdaptorBase.h.

template<typename T>

ModuleDescription edm::stream::ProducingModuleAdaptorBase< T >::moduleDescription_

private

Definition at line 180 of file ProducingModuleAdaptorBase.h.