edm::ProductRegistryHelper Class Reference

#include <ProductRegistryHelper.h>

Inheritance diagram for edm::ProductRegistryHelper:

Classes
struct	BranchAliasSetter
struct	BranchAliasSetterT
struct	has_donotrecordparents
struct	TypeLabelItem

Public Types
typedef std::vector< TypeLabelItem >	TypeLabelList

Public Member Functions
virtual bool	hasAbilityToProduceInLumis () const
virtual bool	hasAbilityToProduceInRuns () const
template<class ProductType >
BranchAliasSetterT< ProductType >	produces ()
	declare what type of product will make and with which optional label More...
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)

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

Private Attributes
std::vector< bool >	recordProvenanceList_
TypeLabelList	typeLabelList_

Detailed Description

Definition at line 23 of file ProductRegistryHelper.h.

Member Typedef Documentation

typedef std::vector<TypeLabelItem> edm::ProductRegistryHelper::TypeLabelList

Definition at line 81 of file ProductRegistryHelper.h.

Constructor & Destructor Documentation

edm::ProductRegistryHelper::~ProductRegistryHelper ( )

virtualnoexcept

Definition at line 17 of file ProductRegistryHelper.cc.

{ }

edm::ProductRegistryHelper::ProductRegistryHelper ( )

inline

Definition at line 26 of file ProductRegistryHelper.h.

: typeLabelList_() {}

Member Function Documentation

void edm::ProductRegistryHelper::addToRegistry ( TypeLabelList::const_iterator const &  iBegin, TypeLabelList::const_iterator const &  iEnd, ModuleDescription const &  iDesc, ProductRegistry &  iReg, ProductRegistryHelper *  iProd, bool  iIsListener = false  )

static

Definition at line 39 of file ProductRegistryHelper.cc.

References edm::ProductRegistry::addProduct(), edm::BeginLuminosityBlock, edm::BeginRun, revisionDML::branchType(), edm::checkClassDictionaries(), edm::checkDictionary(), edm::checkDictionaryOfWrappedType(), edm::convertToBranchType(), edm::EndLuminosityBlock, edm::EndRun, mps_splice::entry, hasAbilityToProduceInLumis(), hasAbilityToProduceInRuns(), edm::InEvent, edm::BranchDescription::insertBranchAlias(), edm::isEndTransition(), edm::ModuleDescription::moduleLabel(), edm::ModuleDescription::moduleName(), AlCaHLTBitMon_ParallelJobs::p, edm::ModuleDescription::parameterSetID(), edm::ModuleDescription::processName(), AlCaHLTBitMon_QueryRunRegistry::string, and edm::throwMissingDictionariesException().

Referenced by recordProvenanceList(), edm::ProducerBase::registerProducts(), and edm::ProducerBase::registrationCallback().

                                                         {

    std::vector<std::string> missingDictionaries;
    std::vector<std::string> producedTypes;
    std::set<std::tuple<BranchType,std::type_index,std::string>> registeredProducts;

    for(TypeLabelList::const_iterator p = iBegin; p != iEnd; ++p) {
      if (p->transition_ == Transition::BeginRun ||
          p->transition_ == Transition::EndRun) {
        if (not iProd->hasAbilityToProduceInRuns()) {
          throwProducesWithoutAbility("Run", p->typeID_.userClassName());
        }
      } else if (p->transition_ == Transition::BeginLuminosityBlock ||
                 p->transition_ == Transition::EndLuminosityBlock) {
        if (not iProd->hasAbilityToProduceInLumis()) {
          throwProducesWithoutAbility("LuminosityBlock", p->typeID_.userClassName());
        }
      }
      if (!checkDictionary(missingDictionaries, p->typeID_)) {
        checkDictionaryOfWrappedType(missingDictionaries, p->typeID_);
        producedTypes.emplace_back(p->typeID_.className());
        continue;
      }
      auto branchType = convertToBranchType(p->transition_);
      if(branchType != InEvent) {
        std::tuple<BranchType, std::type_index, std::string> entry{ branchType,p->typeID_.typeInfo(),p->productInstanceName_};
        if(registeredProducts.end() != registeredProducts.find(entry) ) {
          //ignore registration of items if in both begin and end transitions for now
          // This is to work around ExternalLHEProducer
          continue;
        } else {
          registeredProducts.insert(entry);
        }
      }

      TypeWithDict type(p->typeID_.typeInfo());
      BranchDescription pdesc(branchType,
                              iDesc.moduleLabel(),
                              iDesc.processName(),
                              p->typeID_.userClassName(),
                              p->typeID_.friendlyClassName(),
                              p->productInstanceName_,
                              iDesc.moduleName(),
                              iDesc.parameterSetID(),
                              type,
                              true,
                              isEndTransition(p->transition_));

      if (pdesc.transient()) {
        if (!checkDictionary(missingDictionaries, pdesc.wrappedName(), pdesc.wrappedType())) {
          // It is should be impossible to get here, because the only way to
          // make it transient is in the line that causes the wrapped dictionary
          // to be created. Just to be safe I leave this check here ...
          producedTypes.emplace_back(pdesc.className());
          continue;
        }
      } else {
        // also check constituents of wrapped types if it is not transient
        if (!checkClassDictionaries(missingDictionaries, pdesc.wrappedName(), pdesc.wrappedType())) {
          producedTypes.emplace_back(pdesc.className());
          continue;
        }
      }
      if (!p->branchAlias_.empty()) pdesc.insertBranchAlias(p->branchAlias_);
      iReg.addProduct(pdesc, iIsListener);
    }

    if (!missingDictionaries.empty()) {
      std::string context("Calling ProductRegistryHelper::addToRegistry, checking dictionaries for produced types");
      throwMissingDictionariesException(missingDictionaries, context, producedTypes);
    }
  }

virtual bool edm::ProductRegistryHelper::hasAbilityToProduceInLumis ( ) const

inlinevirtual

Reimplemented in edm::limited::EDFilter< T >, edm::stream::EDFilter< T >, edm::stream::EDFilter< edm::GlobalCache< AlCaIsoTracks::Counters > >, edm::stream::EDFilter< edm::GlobalCache< PythiaFilterIsoTracks::Counters > >, edm::stream::EDFilter<>, edm::stream::EDFilter< edm::GlobalCache< AlCaIsoTracksProdFilter::Counters > >, edm::stream::EDFilter< edm::GlobalCache< trigger::Efficiency > >, edm::stream::EDFilter< edm::GlobalCache< AlCaHBHEMuons::Counters > >, edm::stream::EDFilter< edm::GlobalCache< AlCaIsolatedBunch::Counters > >, edm::stream::EDFilter< edm::GlobalCache< gsfidhelper::HeavyObjectCache > >, edm::stream::EDFilter< edm::GlobalCache< AlCaGammaJet::Counters > >, edm::global::EDFilter< T >, edm::global::EDFilter< edm::RunCache< leef::RunErrors >, edm::LuminosityBlockCache< LumiErrors >, edm::EndLuminosityBlockProducer >, edm::global::EDFilter<>, edm::limited::EDProducer< T >, edm::global::EDProducer< T >, edm::global::EDProducer< edm::BeginLuminosityBlockProducer >, edm::global::EDProducer<>, edm::global::EDProducer< edm::BeginRunProducer >, edm::global::EDProducer< edm::StreamCache< Counter >, edm::RunCache< DynamicWeightChoice >, edm::RunSummaryCache< Counter >, edm::EndRunProducer >, edm::global::EDProducer< edm::EndLuminosityBlockProducer, edm::LuminosityBlockCache< Sums > >, edm::global::EDProducer< edm::StreamCache< CSCTriggerPrimitivesBuilder > >, edm::global::EDProducer< edm::RunCache< GEMROmap > >, edm::global::EDProducer< edm::RunCache< ConvertParticle > >, edm::global::EDProducer< edm::RunCache< IDto3Charge > >, edm::one::EDProducer< T >, edm::one::EDProducer< edm::one::WatchRuns, edm::one::WatchLuminosityBlocks, edm::one::SharedResources, edm::EndLuminosityBlockProducer, edm::EndRunProducer >, edm::one::EDProducer< edm::Accumulator, edm::EndLuminosityBlockProducer, edm::EndRunProducer, edm::one::WatchLuminosityBlocks, edm::one::WatchRuns, edm::one::SharedResources >, edm::one::EDProducer< edm::BeginLuminosityBlockProducer >, edm::one::EDProducer< edm::one::WatchRuns, edm::BeginLuminosityBlockProducer, edm::EndRunProducer >, edm::one::EDProducer<>, edm::one::EDProducer< edm::BeginRunProducer >, edm::one::EDProducer< edm::one::WatchRuns, edm::one::WatchLuminosityBlocks, edm::EndLuminosityBlockProducer, edm::EndRunProducer, edm::one::SharedResources >, edm::one::EDProducer< edm::EndRunProducer, edm::EndLuminosityBlockProducer >, edm::one::EDProducer< EndRunProducer, one::WatchLuminosityBlocks >, edm::one::EDProducer< EndRunProducer, one::WatchLuminosityBlocks, one::SharedResources >, edm::one::EDProducer< edm::EndRunProducer, edm::EndLuminosityBlockProducer, edm::one::WatchRuns, edm::one::WatchLuminosityBlocks >, edm::one::EDProducer< edm::EndLuminosityBlockProducer >, edm::one::EDProducer< edm::EndLuminosityBlockProducer, edm::one::WatchLuminosityBlocks, edm::Accumulator >, edm::one::EDProducer< edm::one::WatchLuminosityBlocks, edm::EndLuminosityBlockProducer >, edm::one::EDProducer< edm::one::SharedResources, edm::one::WatchRuns >, edm::one::EDProducer< edm::BeginRunProducer, edm::EndRunProducer >, edm::one::EDProducer< edm::EndLuminosityBlockProducer, edm::one::WatchLuminosityBlocks >, edm::one::EDProducer< one::WatchRuns, EndRunProducer >, edm::one::EDProducer< edm::Accumulator, edm::EndLuminosityBlockProducer, edm::EndRunProducer, edm::one::WatchLuminosityBlocks, edm::one::WatchRuns >, edm::one::EDProducer< edm::EndRunProducer >, edm::one::EDProducer< edm::one::SharedResources >, edm::one::EDFilter< T >, edm::PuttableSourceBase, edm::one::EDFilter<>, edm::one::EDFilter< EndRunProducer, BeginLuminosityBlockProducer, EndLuminosityBlockProducer, one::WatchRuns, one::WatchLuminosityBlocks, one::SharedResources >, edm::one::EDFilter< EndRunProducer, BeginLuminosityBlockProducer, EndLuminosityBlockProducer, one::WatchLuminosityBlocks, one::SharedResources >, and edm::one::EDFilter< edm::one::WatchLuminosityBlocks >.

Definition at line 162 of file ProductRegistryHelper.h.

Referenced by addToRegistry().

                                                    {
      return false;
    }

virtual bool edm::ProductRegistryHelper::hasAbilityToProduceInRuns ( ) const

inlinevirtual

Reimplemented in edm::limited::EDFilter< T >, edm::stream::EDFilter< T >, edm::stream::EDFilter< edm::GlobalCache< AlCaIsoTracks::Counters > >, edm::stream::EDFilter< edm::GlobalCache< PythiaFilterIsoTracks::Counters > >, edm::stream::EDFilter<>, edm::stream::EDFilter< edm::GlobalCache< AlCaIsoTracksProdFilter::Counters > >, edm::stream::EDFilter< edm::GlobalCache< trigger::Efficiency > >, edm::stream::EDFilter< edm::GlobalCache< AlCaHBHEMuons::Counters > >, edm::stream::EDFilter< edm::GlobalCache< AlCaIsolatedBunch::Counters > >, edm::stream::EDFilter< edm::GlobalCache< gsfidhelper::HeavyObjectCache > >, edm::stream::EDFilter< edm::GlobalCache< AlCaGammaJet::Counters > >, edm::global::EDFilter< T >, edm::global::EDFilter< edm::RunCache< leef::RunErrors >, edm::LuminosityBlockCache< LumiErrors >, edm::EndLuminosityBlockProducer >, edm::global::EDFilter<>, edm::limited::EDProducer< T >, edm::global::EDProducer< T >, edm::global::EDProducer< edm::BeginLuminosityBlockProducer >, edm::global::EDProducer<>, edm::global::EDProducer< edm::BeginRunProducer >, edm::global::EDProducer< edm::StreamCache< Counter >, edm::RunCache< DynamicWeightChoice >, edm::RunSummaryCache< Counter >, edm::EndRunProducer >, edm::global::EDProducer< edm::EndLuminosityBlockProducer, edm::LuminosityBlockCache< Sums > >, edm::global::EDProducer< edm::StreamCache< CSCTriggerPrimitivesBuilder > >, edm::global::EDProducer< edm::RunCache< GEMROmap > >, edm::global::EDProducer< edm::RunCache< ConvertParticle > >, edm::global::EDProducer< edm::RunCache< IDto3Charge > >, edm::one::EDProducer< T >, edm::one::EDProducer< edm::one::WatchRuns, edm::one::WatchLuminosityBlocks, edm::one::SharedResources, edm::EndLuminosityBlockProducer, edm::EndRunProducer >, edm::one::EDProducer< edm::Accumulator, edm::EndLuminosityBlockProducer, edm::EndRunProducer, edm::one::WatchLuminosityBlocks, edm::one::WatchRuns, edm::one::SharedResources >, edm::one::EDProducer< edm::BeginLuminosityBlockProducer >, edm::one::EDProducer< edm::one::WatchRuns, edm::BeginLuminosityBlockProducer, edm::EndRunProducer >, edm::one::EDProducer<>, edm::one::EDProducer< edm::BeginRunProducer >, edm::one::EDProducer< edm::one::WatchRuns, edm::one::WatchLuminosityBlocks, edm::EndLuminosityBlockProducer, edm::EndRunProducer, edm::one::SharedResources >, edm::one::EDProducer< edm::EndRunProducer, edm::EndLuminosityBlockProducer >, edm::one::EDProducer< EndRunProducer, one::WatchLuminosityBlocks >, edm::one::EDProducer< EndRunProducer, one::WatchLuminosityBlocks, one::SharedResources >, edm::one::EDProducer< edm::EndRunProducer, edm::EndLuminosityBlockProducer, edm::one::WatchRuns, edm::one::WatchLuminosityBlocks >, edm::one::EDProducer< edm::EndLuminosityBlockProducer >, edm::one::EDProducer< edm::EndLuminosityBlockProducer, edm::one::WatchLuminosityBlocks, edm::Accumulator >, edm::one::EDProducer< edm::one::WatchLuminosityBlocks, edm::EndLuminosityBlockProducer >, edm::one::EDProducer< edm::one::SharedResources, edm::one::WatchRuns >, edm::one::EDProducer< edm::BeginRunProducer, edm::EndRunProducer >, edm::one::EDProducer< edm::EndLuminosityBlockProducer, edm::one::WatchLuminosityBlocks >, edm::one::EDProducer< one::WatchRuns, EndRunProducer >, edm::one::EDProducer< edm::Accumulator, edm::EndLuminosityBlockProducer, edm::EndRunProducer, edm::one::WatchLuminosityBlocks, edm::one::WatchRuns >, edm::one::EDProducer< edm::EndRunProducer >, edm::one::EDProducer< edm::one::SharedResources >, edm::one::EDFilter< T >, edm::PuttableSourceBase, edm::one::EDFilter<>, edm::one::EDFilter< EndRunProducer, BeginLuminosityBlockProducer, EndLuminosityBlockProducer, one::WatchRuns, one::WatchLuminosityBlocks, one::SharedResources >, edm::one::EDFilter< EndRunProducer, BeginLuminosityBlockProducer, EndLuminosityBlockProducer, one::WatchLuminosityBlocks, one::SharedResources >, and edm::one::EDFilter< edm::one::WatchLuminosityBlocks >.

Definition at line 158 of file ProductRegistryHelper.h.

Referenced by addToRegistry().

                                                   {
      return false;
    }

template<class ProductType >

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

inline

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

References AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by CaloTruthAccumulator::CaloTruthAccumulator(), CastorDigiProducer::CastorDigiProducer(), EcalTBDigiProducer::EcalTBDigiProducer(), EcalTimeDigiProducer::EcalTimeDigiProducer(), FTLDigitizerBase::FTLDigitizerBase(), HcalDigiProducer::HcalDigiProducer(), HcalTBDigiProducer::HcalTBDigiProducer(), HGCDigiProducer::HGCDigiProducer(), cms::Phase2TrackerDigitizer::Phase2TrackerDigitizer(), cms::PileupVertexAccumulator::PileupVertexAccumulator(), hitTripletEDProducerT::ImplSeedingHitSets::produces(), hitTripletEDProducerT::ImplIntermediateHitTriplets::produces(), RecoTrackAccumulator::RecoTrackAccumulator(), VariableNTupler::registerleaves(), StringBasedNTupler::registerleaves(), fastsim::TrackerSimHitProducer::registerProducts(), cms::SiPixelDigitizer::SiPixelDigitizer(), SiStripDigitizer::SiStripDigitizer(), and TrackingTruthAccumulator::TrackingTruthAccumulator().

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

template<class ProductType >

BranchAliasSetterT<ProductType> edm::ProductRegistryHelper::produces ( std::string  instanceName )

inline

Definition at line 110 of file ProductRegistryHelper.h.

References eostools::move().

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

template<typename ProductType , BranchType B>

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

inline

Definition at line 115 of file ProductRegistryHelper.h.

References AlCaHLTBitMon_QueryRunRegistry::string.

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

template<typename ProductType , BranchType B>

BranchAliasSetterT<ProductType> edm::ProductRegistryHelper::produces ( std::string  instanceName )

inline

Definition at line 120 of file ProductRegistryHelper.h.

References TtFullHadDaughter::B, edm::InEvent, and eostools::move().

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

template<typename ProductType , Transition B>

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

inline

Definition at line 127 of file ProductRegistryHelper.h.

References AlCaHLTBitMon_QueryRunRegistry::string.

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

template<typename ProductType , Transition B>

BranchAliasSetterT<ProductType> edm::ProductRegistryHelper::produces ( std::string  instanceName )

inline

Definition at line 132 of file ProductRegistryHelper.h.

References TtFullHadDaughter::B, edm::Event, and eostools::move().

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

BranchAliasSetter edm::ProductRegistryHelper::produces ( const TypeID &  id, std::string  instanceName = std::string(), bool  recordProvenance = true  )

inline

Definition at line 139 of file ProductRegistryHelper.h.

References triggerObjects_cff::id, MuonErrorMatrixAdjuster_cfi::instanceName, and eostools::move().

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

template<BranchType B>

BranchAliasSetter edm::ProductRegistryHelper::produces ( const TypeID &  id, std::string  instanceName = std::string(), bool  recordProvenance = true  )

inline

Definition at line 144 of file ProductRegistryHelper.h.

References TtFullHadDaughter::B, edm::convertToTransition(), edm::InEvent, MuonErrorMatrixAdjuster_cfi::instanceName, eostools::move(), recordProvenanceList_, and typeLabelList_.

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

template<Transition B>

BranchAliasSetter edm::ProductRegistryHelper::produces ( const TypeID &  id, std::string  instanceName = std::string(), bool  recordProvenance = true  )

inline

Definition at line 151 of file ProductRegistryHelper.h.

References TtFullHadDaughter::B, edm::Event, MuonErrorMatrixAdjuster_cfi::instanceName, eostools::move(), recordProvenanceList_, and typeLabelList_.

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

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

inline

Definition at line 86 of file ProductRegistryHelper.h.

References addToRegistry(), and recordProvenanceList_.

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

{ return recordProvenanceList_;}

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

(

)

const

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

Definition at line 19 of file ProductRegistryHelper.cc.

References Exception, edm::errors::LogicError, AlCaHLTBitMon_QueryRunRegistry::string, and typeLabelList_.

Referenced by edm::PrincipalGetAdapter::getPutTokenIndex(), edm::PrincipalGetAdapter::getTypeIDForPutTokenIndex(), edm::PrincipalGetAdapter::productInstanceLabel(), edm::ProducerBase::registerProducts(), edm::ProducerBase::registrationCallback(), and edm::ProducerBase::resolvePutIndicies().

                                                                                       {
    return typeLabelList_;
  }

Member Data Documentation

std::vector<bool> edm::ProductRegistryHelper::recordProvenanceList_

private

Definition at line 168 of file ProductRegistryHelper.h.

Referenced by produces(), and recordProvenanceList().

TypeLabelList edm::ProductRegistryHelper::typeLabelList_

private

Definition at line 167 of file ProductRegistryHelper.h.

Referenced by produces(), and typeLabelList().