edm::ProducerBase Class Reference

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

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<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 Tr = Transition::Event>
auto	produces () noexcept
template<class ProductType >
BranchAliasSetterT< ProductType >	produces ()
template<class ProductType >
BranchAliasSetterT< ProductType >	produces (std::string instanceName)
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces ()
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces ()
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)
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)
	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 71 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 90 of file ProducerBase.h.

TypeLabelList

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

Definition at line 73 of file ProducerBase.h.

Constructor & Destructor Documentation

ProducerBase()

edm::ProducerBase::ProducerBase

(

)

Definition at line 16 of file ProducerBase.cc.

: ProductRegistryHelper(), callWhenNewProductsRegistered_() {}

~ProducerBase()

edm::ProducerBase::~ProducerBase ( )

overridenoexcept

Definition at line 17 of file ProducerBase.cc.

{}

Member Function Documentation

callWhenNewProductsRegistered()

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

inline

Definition at line 85 of file ProducerBase.h.

References callWhenNewProductsRegistered_, and EcalMonitorTask_cff::func.

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

                                                                                                {
      callWhenNewProductsRegistered_ = func;
    }

commit_() [1/2]

template<typename P >

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

inlineprivate

Definition at line 121 of file ProducerBase.h.

References putIndicies_.

Referenced by edm::PuttableSourceBase::doBeginLumi(), edm::EDProducer::doBeginLuminosityBlock(), edm::EDFilter::doBeginLuminosityBlock(), edm::one::EDFilterBase::doBeginLuminosityBlock(), edm::one::EDProducerBase::doBeginLuminosityBlock(), edm::global::EDProducerBase::doBeginLuminosityBlock(), edm::limited::EDProducerBase::doBeginLuminosityBlock(), edm::global::EDFilterBase::doBeginLuminosityBlock(), edm::limited::EDFilterBase::doBeginLuminosityBlock(), edm::one::EDProducerBase::doBeginProcessBlock(), edm::one::EDFilterBase::doBeginProcessBlock(), edm::global::EDProducerBase::doBeginProcessBlock(), edm::limited::EDProducerBase::doBeginProcessBlock(), edm::limited::EDFilterBase::doBeginProcessBlock(), edm::global::EDFilterBase::doBeginProcessBlock(), edm::PuttableSourceBase::doBeginRun(), edm::EDProducer::doBeginRun(), edm::EDFilter::doBeginRun(), edm::one::EDProducerBase::doBeginRun(), edm::one::EDFilterBase::doBeginRun(), edm::global::EDProducerBase::doBeginRun(), edm::limited::EDProducerBase::doBeginRun(), edm::limited::EDFilterBase::doBeginRun(), edm::global::EDFilterBase::doBeginRun(), edm::EDProducer::doEndLuminosityBlock(), edm::EDFilter::doEndLuminosityBlock(), edm::one::EDProducerBase::doEndLuminosityBlock(), edm::one::EDFilterBase::doEndLuminosityBlock(), edm::global::EDProducerBase::doEndLuminosityBlock(), edm::limited::EDProducerBase::doEndLuminosityBlock(), edm::global::EDFilterBase::doEndLuminosityBlock(), edm::limited::EDFilterBase::doEndLuminosityBlock(), edm::one::EDProducerBase::doEndProcessBlock(), edm::one::EDFilterBase::doEndProcessBlock(), edm::global::EDProducerBase::doEndProcessBlock(), edm::limited::EDProducerBase::doEndProcessBlock(), edm::global::EDFilterBase::doEndProcessBlock(), edm::limited::EDFilterBase::doEndProcessBlock(), edm::EDProducer::doEndRun(), edm::EDFilter::doEndRun(), edm::one::EDFilterBase::doEndRun(), edm::one::EDProducerBase::doEndRun(), edm::global::EDProducerBase::doEndRun(), edm::limited::EDProducerBase::doEndRun(), edm::limited::EDFilterBase::doEndRun(), edm::global::EDFilterBase::doEndRun(), edm::EDProducer::doEvent(), edm::global::EDFilterBase::doEvent(), edm::EDFilter::doEvent(), edm::one::EDProducerBase::doEvent(), edm::one::EDFilterBase::doEvent(), edm::global::EDProducerBase::doEvent(), edm::limited::EDFilterBase::doEvent(), and edm::limited::EDProducerBase::doEvent().

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

commit_() [2/2]

template<typename P , typename I >

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

inlineprivate

Definition at line 126 of file ProducerBase.h.

References putIndicies_.

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

indiciesForPutProducts()

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

inline

Definition at line 95 of file ProducerBase.h.

References putIndicies_.

                                                                                                   {
      return putIndicies_[iBranchType];
    }

produces() [1/11]

template<typename ProductType , Transition B>

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

inlineprotected

Definition at line 153 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() [2/11]

template<typename ProductType , BranchType B>

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

inlineprotected

Definition at line 136 of file ProductRegistryHelper.h.

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

produces() [3/11]

template<typename ProductType , BranchType B>

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

inlineprotected

Definition at line 141 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)};
    }

produces() [4/11]

template<typename ProductType , Transition B>

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

inlineprotected

Definition at line 148 of file ProductRegistryHelper.h.

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

produces() [5/11]

template<class ProductType >

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

inlineprotected

Definition at line 131 of file ProductRegistryHelper.h.

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

produces() [6/11]

BranchAliasSetter edm::ProductRegistryHelper::produces

inlineprotected

Definition at line 159 of file ProductRegistryHelper.h.

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

produces() [7/11]

template<BranchType B>

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

inlineprotected

Definition at line 166 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() [8/11]

template<Transition B>

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

inlineprotected

Definition at line 175 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() [9/11]

template<Transition Tr = Transition::Event>

auto edm::ProductRegistryHelper::produces ( Transition  Tr = Transition::Event )

inlineprotectednoexcept

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 117 of file ProductRegistryHelper.h.

                                                                 {
      return ProductRegistryHelperAdaptor<Tr>(*this, std::move(instanceName));
    }

produces() [10/11]

template<Transition Tr = Transition::Event>

auto edm::ProductRegistryHelper::produces ( Transition  Tr = Transition::Event )

inlineprotectednoexcept

Definition at line 121 of file ProductRegistryHelper.h.

                                           {
      return ProductRegistryHelperAdaptor<Tr>(*this);
    }

produces() [11/11]

template<class ProductType >

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

inlineprotected

Definition at line 126 of file ProductRegistryHelper.h.

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

producesCollector()

ProducesCollector edm::ProducerBase::producesCollector ( )

protected

Definition at line 105 of file ProducerBase.cc.

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

{ return ProducesCollector{this}; }

putTokenIndexToProductResolverIndex()

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

inline

Definition at line 99 of file ProducerBase.h.

References putTokenToResolverIndex_.

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

                                                                                          {
      return putTokenToResolverIndex_;
    }

recordProvenanceList()

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

inline

Definition at line 100 of file ProductRegistryHelper.h.

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

{ return recordProvenanceList_; }

registerProducts()

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

Definition at line 57 of file ProducerBase.cc.

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

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

                                                                                                                {
    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));
    }
  }

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.

References callWhenNewProductsRegistered_.

Referenced by registerProducts().

                                                                                       {
    return callWhenNewProductsRegistered_;
  }

resolvePutIndicies()

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

Definition at line 79 of file ProducerBase.cc.

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

                                                                      {
    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;
      }
    }
  }

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.

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

{ return typeLabelList_; }

Friends And Related Function Documentation

EDFilter

friend class EDFilter

friend

Definition at line 109 of file ProducerBase.h.

EDProducer

friend class EDProducer

friend

Definition at line 108 of file ProducerBase.h.

global::EDFilterBase

friend class global::EDFilterBase

friend

Definition at line 113 of file ProducerBase.h.

global::EDProducerBase

friend class global::EDProducerBase

friend

Definition at line 112 of file ProducerBase.h.

limited::EDFilterBase

friend class limited::EDFilterBase

friend

Definition at line 115 of file ProducerBase.h.

limited::EDProducerBase

friend class limited::EDProducerBase

friend

Definition at line 114 of file ProducerBase.h.

one::EDFilterBase

friend class one::EDFilterBase

friend

Definition at line 111 of file ProducerBase.h.

one::EDProducerBase

friend class one::EDProducerBase

friend

Definition at line 110 of file ProducerBase.h.

PuttableSourceBase

friend class PuttableSourceBase

friend

Definition at line 116 of file ProducerBase.h.

stream::ProducingModuleAdaptorBase

template<typename T >

friend class stream::ProducingModuleAdaptorBase

friend

Definition at line 118 of file ProducerBase.h.

Member Data Documentation

callWhenNewProductsRegistered_

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

private

Definition at line 130 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 131 of file ProducerBase.h.

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

putTokenToResolverIndex_

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

private

Definition at line 132 of file ProducerBase.h.

Referenced by putTokenIndexToProductResolverIndex(), and resolvePutIndicies().