#include <ProducerBase.h>

Inheritance diagram for edm::ProducerBase:

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

typedef ProductRegistryHelper::TypeLabelList	TypeLabelList

Public Member Functions
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

Protected Member Functions
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 ()

Private Member Functions
template<typename P >
void	commit_ (P &iPrincipal)

template<typename P , typename I >
void	commit_ (P &iPrincipal, I *iID)

Private Member Functions inherited from edm::ProductRegistryHelper
virtual bool	hasAbilityToProduceInBeginLumis () const

virtual bool	hasAbilityToProduceInBeginProcessBlocks () const

virtual bool	hasAbilityToProduceInBeginRuns () const

virtual bool	hasAbilityToProduceInEndLumis () const

virtual bool	hasAbilityToProduceInEndProcessBlocks () const

virtual bool	hasAbilityToProduceInEndRuns () const

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<class ProductType >
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

	ProductRegistryHelper ()

std::vector< bool > const &	recordProvenanceList () const

TypeLabelList const &	typeLabelList () const
	used by the fwk to register the list of products of this module More...

virtual	~ProductRegistryHelper () noexcept(false)

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

std::array< std::vector< edm::ProductResolverIndex >, edm::NumBranchTypes >	putIndicies_

std::vector< edm::ProductResolverIndex >	putTokenToResolverIndex_

Friends
class	EDFilter

class	EDProducer

class	global::EDFilterBase

class	global::EDProducerBase

class	limited::EDFilterBase

class	limited::EDProducerBase

class	one::EDFilterBase

class	one::EDProducerBase

class	PuttableSourceBase

template<typename T >
class	stream::ProducingModuleAdaptorBase

Additional Inherited Members
Private Types inherited from edm::ProductRegistryHelper
typedef std::vector< TypeLabelItem >	TypeLabelList

Static Private Member Functions inherited from edm::ProductRegistryHelper
static void	addToRegistry (TypeLabelList::const_iterator const &iBegin, TypeLabelList::const_iterator const &iEnd, ModuleDescription const &iDesc, ProductRegistry &iReg, ProductRegistryHelper *iProd, bool iIsListener=false)

Detailed Description

Definition at line 70 of file ProducerBase.h.

Member Typedef Documentation

◆ ModuleToResolverIndicies

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

Definition at line 89 of file ProducerBase.h.

◆ TypeLabelList

typedef ProductRegistryHelper::TypeLabelList edm::ProducerBase::TypeLabelList

Definition at line 72 of file ProducerBase.h.

Constructor & Destructor Documentation

◆ ProducerBase()

edm::ProducerBase::ProducerBase ( )

Definition at line 16 of file ProducerBase.cc.

16 : ProductRegistryHelper(), callWhenNewProductsRegistered_() {}

◆ ~ProducerBase()

edm::ProducerBase::~ProducerBase ( )

overridenoexcept

Definition at line 17 of file ProducerBase.cc.

17 {}

Member Function Documentation

◆ callWhenNewProductsRegistered()

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

inline

Definition at line 84 of file ProducerBase.h.

                                                                                                 {
       callWhenNewProductsRegistered_ = func;
     }

References callWhenNewProductsRegistered_, and TrackCollections2monitor_cff::func.

Referenced by edm::ConcurrentHadronizerFilter< HAD, DEC >::ConcurrentHadronizerFilter(), DQMEDHarvester::DQMEDHarvester(), EcalDeadCellTriggerPrimitiveFilter::EcalDeadCellTriggerPrimitiveFilter(), edm::HadronizerFilter< HAD, DEC >::HadronizerFilter(), edm::SwitchProducer::SwitchProducer(), and TriggerSummaryProducerAOD::TriggerSummaryProducerAOD().

◆ commit_() [1/2]

template<typename P >

void edm::ProducerBase::commit_ ( P & iPrincipal )

inlineprivate

Definition at line 120 of file ProducerBase.h.

                                 {
       iPrincipal.commit_(putIndicies_[producerbasehelper::PrincipalTraits<P>::kBranchType]);
     }

References putIndicies_.

◆ commit_() [2/2]

template<typename P , typename I >

void edm::ProducerBase::commit_	(	P &	iPrincipal,
		I *	iID
	)

inlineprivate

Definition at line 125 of file ProducerBase.h.

                                         {
       iPrincipal.commit_(putIndicies_[producerbasehelper::PrincipalTraits<P>::kBranchType], iID);
     }

References putIndicies_.

◆ indiciesForPutProducts()

std::vector<edm::ProductResolverIndex> const& edm::ProducerBase::indiciesForPutProducts ( BranchType iBranchType ) const

inline

Definition at line 94 of file ProducerBase.h.

                                                                                                    {
       return putIndicies_[iBranchType];
     }

References putIndicies_.

◆ produces() [1/9]

template<typename ProductType , Transition B>

BranchAliasSetterT<ProductType> edm::ProductRegistryHelper::produces	(	typename ProductType	,
		Transition	B
	)

inlineprotected

Definition at line 130 of file ProductRegistryHelper.h.

                                                {
       return produces<ProductType, B>(std::string());
     }

◆ produces() [2/9]

template<class ProductType >

BranchAliasSetterT<ProductType> edm::ProductRegistryHelper::produces ( class ProductType )

inlineprotected

declare what type of product will make and with which optional label

the statement

produces<ProductType>("optlabel");

should be added to the producer ctor for every product

Definition at line 108 of file ProductRegistryHelper.h.

                                                {
       return produces<ProductType, InEvent>(std::string());
     }

◆ produces() [3/9]

template<typename ProductType , BranchType B>

BranchAliasSetterT<ProductType> edm::ProductRegistryHelper::produces	(	typename ProductType	,
		BranchType	B
	)

inlineprotected

Definition at line 118 of file ProductRegistryHelper.h.

                                                {
       return produces<ProductType, B>(std::string());
     }

◆ produces() [4/9]

template<BranchType B>

BranchAliasSetter edm::ProductRegistryHelper::produces ( BranchType B )

inlineprotected

Definition at line 148 of file ProductRegistryHelper.h.

                                                              {
       unsigned int index = typeLabelList_.size();
       typeLabelList_.emplace_back(convertToTransition(B), id, std::move(instanceName));
       recordProvenanceList_.push_back(recordProvenance and B == InEvent);
       return BranchAliasSetter{typeLabelList_.back(), EDPutToken{static_cast<unsigned int>(index)}};
     }

◆ produces() [5/9]

BranchAliasSetter edm::ProductRegistryHelper::produces

inlineprotected

Definition at line 141 of file ProductRegistryHelper.h.

                                                              {
       return produces<Transition::Event>(id, std::move(instanceName), recordProvenance);
     }

◆ produces() [6/9]

template<Transition B>

BranchAliasSetter edm::ProductRegistryHelper::produces ( Transition B )

inlineprotected

Definition at line 157 of file ProductRegistryHelper.h.

                                                              {
       unsigned int index = typeLabelList_.size();
       typeLabelList_.emplace_back(B, id, std::move(instanceName));
       recordProvenanceList_.push_back(recordProvenance and B == Transition::Event);
       return BranchAliasSetter{typeLabelList_.back(), EDPutToken{index}};
     }

◆ produces() [7/9]

template<typename ProductType , Transition B>

BranchAliasSetterT<ProductType> edm::ProductRegistryHelper::produces	(	typename ProductType	,
		Transition	B
	)

inlineprotected

Definition at line 135 of file ProductRegistryHelper.h.

                                                                      {
       TypeID tid(typeid(ProductType));
       return BranchAliasSetterT<ProductType>{produces<B>(
           tid, std::move(instanceName), (not has_donotrecordparents<ProductType>::value) and B == Transition::Event)};
     }

◆ produces() [8/9]

template<class ProductType >

BranchAliasSetterT<ProductType> edm::ProductRegistryHelper::produces ( class ProductType )

inlineprotected

Definition at line 113 of file ProductRegistryHelper.h.

                                                                      {
       return produces<ProductType, InEvent>(std::move(instanceName));
     }

◆ produces() [9/9]

template<typename ProductType , BranchType B>

BranchAliasSetterT<ProductType> edm::ProductRegistryHelper::produces	(	typename ProductType	,
		BranchType	B
	)

inlineprotected

Definition at line 123 of file ProductRegistryHelper.h.

                                                                      {
       TypeID tid(typeid(ProductType));
       return BranchAliasSetterT<ProductType>{
           produces<B>(tid, std::move(instanceName), (not has_donotrecordparents<ProductType>::value) and B == InEvent)};
     }

◆ producesCollector()

ProducesCollector edm::ProducerBase::producesCollector ( )

protected

Definition at line 105 of file ProducerBase.cc.

105 { return ProducesCollector{this}; }

Referenced by ConfigurableAnalysis::ConfigurableAnalysis(), and NTuplingDevice::NTuplingDevice().

◆ putTokenIndexToProductResolverIndex()

std::vector<edm::ProductResolverIndex> const& edm::ProducerBase::putTokenIndexToProductResolverIndex ( ) const

inline

Definition at line 98 of file ProducerBase.h.

                                                                                           {
       return putTokenToResolverIndex_;
     }

References putTokenToResolverIndex_.

Referenced by edm::PrincipalGetAdapter::getBranchDescription(), edm::PrincipalGetAdapter::getProductID(), and edm::PrincipalGetAdapter::putTokenIndexToProductResolverIndex().

◆ recordProvenanceList()

std::vector<bool> const& edm::ProductRegistryHelper::recordProvenanceList

inline

Definition at line 91 of file ProductRegistryHelper.h.

91 { return recordProvenanceList_; }

Referenced by edm::PrincipalGetAdapter::recordProvenanceList().

◆ registerProducts()

void edm::ProducerBase::registerProducts	(	ProducerBase *	producer,
		ProductRegistry *	iReg,
		ModuleDescription const &	md
	)

Definition at line 57 of file ProducerBase.cc.

                                                                                                                 {
     if (typeLabelList().empty() && !registrationCallback()) {
       return;
     }
     //If we have a callback, first tell the callback about all the entries already in the
     // product registry, then add any items this producer wants to add to the registry
     // and only after that do we register the callback. This is done so the callback does not
     // get called for items registered by this producer (avoids circular reference problems)
     bool isListener = false;
     if (registrationCallback()) {
       isListener = true;
       iReg->callForEachBranch(registrationCallback());
     }
     TypeLabelList const& plist = typeLabelList();
  
     ProductRegistryHelper::addToRegistry(plist.begin(), plist.end(), md, *(iReg), this, isListener);
     if (registrationCallback()) {
       Service<ConstProductRegistry> regService;
       regService->watchProductAdditions(CallbackWrapper(producer, registrationCallback(), iReg, md));
     }
   }

References edm::ProductRegistryHelper::addToRegistry(), edm::ProductRegistry::callForEachBranch(), relativeConstraints::empty, RawToDigi_Repacked_cff::producer, registrationCallback(), and edm::ProductRegistryHelper::typeLabelList().

Referenced by edm::EDProducer::registerProductsAndCallbacks(), edm::EDFilter::registerProductsAndCallbacks(), edm::one::EDProducerBase::registerProductsAndCallbacks(), edm::one::EDFilterBase::registerProductsAndCallbacks(), edm::limited::EDProducerBase::registerProductsAndCallbacks(), edm::global::EDProducerBase::registerProductsAndCallbacks(), edm::limited::EDFilterBase::registerProductsAndCallbacks(), and edm::global::EDFilterBase::registerProductsAndCallbacks().

◆ registrationCallback()

std::function< void(BranchDescription const &)> edm::ProducerBase::registrationCallback ( ) const

used by the fwk to register list of products

Definition at line 19 of file ProducerBase.cc.

                                                                                        {
     return callWhenNewProductsRegistered_;
   }

References callWhenNewProductsRegistered_.

Referenced by registerProducts().

◆ resolvePutIndicies()

void edm::ProducerBase::resolvePutIndicies	(	BranchType	iBranchType,
		ModuleToResolverIndicies const &	iIndicies,
		std::string const &	moduleLabel
	)

Definition at line 79 of file ProducerBase.cc.

                                                                       {
     auto const& plist = typeLabelList();
     if (putTokenToResolverIndex_.size() != plist.size()) {
       putTokenToResolverIndex_.resize(plist.size(), std::numeric_limits<unsigned int>::max());
     }
     auto range = iIndicies.equal_range(moduleLabel);
     putIndicies_[iBranchType].reserve(iIndicies.count(moduleLabel));
     for (auto it = range.first; it != range.second; ++it) {
       putIndicies_[iBranchType].push_back(std::get<2>(it->second));
       unsigned int i = 0;
       for (auto const& tl : plist) {
         if (convertToBranchType(tl.transition_) == iBranchType and (tl.typeID_ == *std::get<0>(it->second)) and
             (tl.productInstanceName_ == std::get<1>(it->second))) {
           putTokenToResolverIndex_[i] = std::get<2>(it->second);
           //NOTE: The ExternalLHEProducer puts the 'same' product in at
           // both beginRun and endRun. Therefore we can get multiple matches.
           // When the module is finally fixed, we can use the 'break'
           //break;
         }
         ++i;
       }
     }
   }

References edm::convertToBranchType(), mps_fire::i, SiStripPI::max, HerwigMaxPtPartonFilter_cfi::moduleLabel, putIndicies_, putTokenToResolverIndex_, FastTimerService_cff::range, and edm::ProductRegistryHelper::typeLabelList().

Referenced by edm::PuttableSourceBase::beginJob().

◆ typeLabelList()

ProductRegistryHelper::TypeLabelList const & edm::ProductRegistryHelper::typeLabelList

used by the fwk to register the list of products of this module

Definition at line 20 of file ProductRegistryHelper.cc.

20 { return typeLabelList_; }

Referenced by edm::PrincipalGetAdapter::getPutTokenIndex(), edm::PrincipalGetAdapter::getTypeIDForPutTokenIndex(), and edm::PrincipalGetAdapter::productInstanceLabel().

Friends And Related Function Documentation

◆ EDFilter

friend class EDFilter

friend

Definition at line 108 of file ProducerBase.h.

◆ EDProducer

friend class EDProducer

friend

Definition at line 107 of file ProducerBase.h.

◆ global::EDFilterBase

friend class global::EDFilterBase

friend

Definition at line 112 of file ProducerBase.h.

◆ global::EDProducerBase

friend class global::EDProducerBase

friend

Definition at line 111 of file ProducerBase.h.

◆ limited::EDFilterBase

friend class limited::EDFilterBase

friend

Definition at line 114 of file ProducerBase.h.

◆ limited::EDProducerBase

friend class limited::EDProducerBase

friend

Definition at line 113 of file ProducerBase.h.

◆ one::EDFilterBase

friend class one::EDFilterBase

friend

Definition at line 110 of file ProducerBase.h.

◆ one::EDProducerBase

friend class one::EDProducerBase

friend

Definition at line 109 of file ProducerBase.h.

◆ PuttableSourceBase

friend class PuttableSourceBase

friend

Definition at line 115 of file ProducerBase.h.

◆ stream::ProducingModuleAdaptorBase

template<typename T >

friend class stream::ProducingModuleAdaptorBase

friend

Definition at line 117 of file ProducerBase.h.

Member Data Documentation

◆ callWhenNewProductsRegistered_

std::function<void(BranchDescription const&)> edm::ProducerBase::callWhenNewProductsRegistered_

private

Definition at line 129 of file ProducerBase.h.

Referenced by callWhenNewProductsRegistered(), and registrationCallback().

◆ putIndicies_

std::array<std::vector<edm::ProductResolverIndex>, edm::NumBranchTypes> edm::ProducerBase::putIndicies_

private

Definition at line 130 of file ProducerBase.h.

Referenced by commit_(), indiciesForPutProducts(), and resolvePutIndicies().

◆ putTokenToResolverIndex_

std::vector<edm::ProductResolverIndex> edm::ProducerBase::putTokenToResolverIndex_

private

Definition at line 131 of file ProducerBase.h.

Referenced by putTokenIndexToProductResolverIndex(), and resolvePutIndicies().

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ModuleToResolverIndicies

◆ TypeLabelList

Constructor & Destructor Documentation

◆ ProducerBase()

◆ ~ProducerBase()

Member Function Documentation

◆ callWhenNewProductsRegistered()

◆ commit_() [1/2]

◆ commit_() [2/2]

◆ indiciesForPutProducts()

◆ produces() [1/9]

◆ produces() [2/9]

◆ produces() [3/9]

◆ produces() [4/9]

◆ produces() [5/9]

◆ produces() [6/9]

◆ produces() [7/9]

◆ produces() [8/9]

◆ produces() [9/9]

◆ producesCollector()

◆ putTokenIndexToProductResolverIndex()

◆ recordProvenanceList()

◆ registerProducts()

◆ registrationCallback()

◆ resolvePutIndicies()

◆ typeLabelList()

Friends And Related Function Documentation

◆ EDFilter

◆ EDProducer

◆ global::EDFilterBase

◆ global::EDProducerBase

◆ limited::EDFilterBase

◆ limited::EDProducerBase

◆ one::EDFilterBase

◆ one::EDProducerBase

◆ PuttableSourceBase

◆ stream::ProducingModuleAdaptorBase

Member Data Documentation

◆ callWhenNewProductsRegistered_

◆ putIndicies_

◆ putTokenToResolverIndex_