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

Constructor & Destructor Documentation

edm::ProductRegistryHelper::~ProductRegistryHelper ( )

virtualnoexcept

Definition at line 18 of file ProductRegistryHelper.cc.

18 {}

edm::ProductRegistryHelper::ProductRegistryHelper ( )

inline

Definition at line 26 of file ProductRegistryHelper.h.

26 : typeLabelList_() {}

edm::ProductRegistryHelper::typeLabelList_

TypeLabelList typeLabelList_

Definition: ProductRegistryHelper.h:171

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 34 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, Exception, hasAbilityToProduceInLumis(), hasAbilityToProduceInRuns(), edm::InEvent, edm::isEndTransition(), edm::ProductRegistryHelper::TypeLabelItem::kSwitchAlias, edm::errors::LogicError, edm::ModuleDescription::moduleLabel(), edm::ModuleDescription::moduleName(), AlCaHLTBitMon_ParallelJobs::p, edm::ModuleDescription::parameterSetID(), edm::ModuleDescription::processName(), edm::setIsMergeable(), 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 (p->aliasType_ == TypeLabelItem::AliasType::kSwitchAlias) {
         if (p->branchAlias_.empty()) {
           throw edm::Exception(edm::errors::LogicError)
               << "Branch alias type has been set to SwitchAlias, but the alias content is empty.\n"
               << "Please report this error to the FWCore developers";
         }
         pdesc.setSwitchAliasModuleLabel(p->branchAlias_);
       }
       setIsMergeable(pdesc);
 
       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

Definition at line 168 of file ProductRegistryHelper.h.

Referenced by addToRegistry().

168 { return false; }

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

inlinevirtual

Definition at line 166 of file ProductRegistryHelper.h.

Referenced by addToRegistry().

166 { 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 108 of file ProductRegistryHelper.h.

References AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by CaloTruthAccumulator::CaloTruthAccumulator(), CastorDigiProducer::CastorDigiProducer(), EcalDigiProducer::EcalDigiProducer(), EcalTBDigiProducer::EcalTBDigiProducer(), EcalTimeDigiProducer::EcalTimeDigiProducer(), FTLDigitizerBase::FTLDigitizerBase(), HcalDigiProducer::HcalDigiProducer(), HcalTBDigiProducer::HcalTBDigiProducer(), HGCDigiProducer::HGCDigiProducer(), MTDDigitizerBase::MTDDigitizerBase(), pat::PATPackedCandidateProducer::PATPackedCandidateProducer(), cms::Phase2TrackerDigitizer::Phase2TrackerDigitizer(), PhotonIDValueMapProducer::PhotonIDValueMapProducer(), cms::PileupVertexAccumulator::PileupVertexAccumulator(), PreMixingCaloParticleWorker::PreMixingCaloParticleWorker(), edm::PreMixingCrossingFrameWorker< T >::PreMixingCrossingFrameWorker(), PreMixingDigiSimLinkWorker< DigiSimLinkCollection >::PreMixingDigiSimLinkWorker(), PreMixingEcalWorker::PreMixingEcalWorker(), PreMixingHcalWorker::PreMixingHcalWorker(), PreMixingHGCalWorker::PreMixingHGCalWorker(), PreMixingMuonWorker< DigiCollection >::PreMixingMuonWorker(), edm::PreMixingPileupCopy::PreMixingPileupCopy(), PreMixingSiPixelWorker::PreMixingSiPixelWorker(), PreMixingSiStripWorker::PreMixingSiStripWorker(), PreMixingTrackingParticleWorker::PreMixingTrackingParticleWorker(), hitTripletEDProducerT::ImplSeedingHitSets::produces(), hitTripletEDProducerT::ImplIntermediateHitTriplets::produces(), RecoTrackAccumulator::RecoTrackAccumulator(), VariableNTupler::registerleaves(), StringBasedNTupler::registerleaves(), fastsim::TrackerSimHitProducer::registerProducts(), cms::SiPixelDigitizer::SiPixelDigitizer(), SiStripDigitizer::SiStripDigitizer(), edm::SwitchProducer::SwitchProducer(), and TrackingTruthAccumulator::TrackingTruthAccumulator().

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

template<class ProductType >

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

inline

Definition at line 113 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 118 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 123 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 130 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 135 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 141 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 148 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 157 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}};
     }