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

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

Member Typedef Documentation

◆ TypeLabelList

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

Definition at line 95 of file ProductRegistryHelper.h.

Constructor & Destructor Documentation

◆ ~ProductRegistryHelper()

edm::ProductRegistryHelper::~ProductRegistryHelper ( )

virtualnoexcept

Definition at line 18 of file ProductRegistryHelper.cc.

18 {}

◆ ProductRegistryHelper()

edm::ProductRegistryHelper::ProductRegistryHelper ( )

inline

Definition at line 29 of file ProductRegistryHelper.h.

29 : typeLabelList_() {}

edm::ProductRegistryHelper::typeLabelList_

TypeLabelList typeLabelList_

Definition: ProductRegistryHelper.h:194

Member Function Documentation

◆ addToRegistry()

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::BeginProcessBlock, edm::BeginRun, edm::checkClassDictionaries(), edm::checkDictionary(), edm::checkDictionaryOfWrappedType(), visDQMUpload::context, edm::convertToBranchType(), edm::EndLuminosityBlock, edm::EndProcessBlock, edm::EndRun, mps_splice::entry, Exception, hasAbilityToProduceInBeginLumis(), hasAbilityToProduceInBeginProcessBlocks(), hasAbilityToProduceInBeginRuns(), hasAbilityToProduceInEndLumis(), hasAbilityToProduceInEndProcessBlocks(), hasAbilityToProduceInEndRuns(), 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 edm::ProducerBase::registerProducts().

                                                               {
     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 && not iProd->hasAbilityToProduceInBeginRuns()) {
         throwProducesWithoutAbility("BeginRun", p->typeID_.userClassName());
       } else if (p->transition_ == Transition::EndRun && not iProd->hasAbilityToProduceInEndRuns()) {
         throwProducesWithoutAbility("EndRun", p->typeID_.userClassName());
       } else if (p->transition_ == Transition::BeginLuminosityBlock && not iProd->hasAbilityToProduceInBeginLumis()) {
         throwProducesWithoutAbility("BeginLuminosityBlock", p->typeID_.userClassName());
       } else if (p->transition_ == Transition::EndLuminosityBlock && not iProd->hasAbilityToProduceInEndLumis()) {
         throwProducesWithoutAbility("EndLuminosityBlock", p->typeID_.userClassName());
       } else if (p->transition_ == Transition::BeginProcessBlock &&
                  not iProd->hasAbilityToProduceInBeginProcessBlocks()) {
         throwProducesWithoutAbility("BeginProcessBlock", p->typeID_.userClassName());
       } else if (p->transition_ == Transition::EndProcessBlock && not iProd->hasAbilityToProduceInEndProcessBlocks()) {
         throwProducesWithoutAbility("EndProcessBlock", 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);
     }
   }

◆ hasAbilityToProduceInBeginLumis()

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

inlinevirtual

Definition at line 190 of file ProductRegistryHelper.h.

Referenced by addToRegistry().

190 { return false; }

◆ hasAbilityToProduceInBeginProcessBlocks()

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

inlinevirtual

Definition at line 184 of file ProductRegistryHelper.h.

Referenced by addToRegistry().

184 { return false; }

◆ hasAbilityToProduceInBeginRuns()

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

inlinevirtual

Definition at line 187 of file ProductRegistryHelper.h.

Referenced by addToRegistry().

187 { return false; }

◆ hasAbilityToProduceInEndLumis()

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

inlinevirtual

Definition at line 191 of file ProductRegistryHelper.h.

Referenced by addToRegistry().

191 { return false; }

◆ hasAbilityToProduceInEndProcessBlocks()

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

inlinevirtual

Definition at line 185 of file ProductRegistryHelper.h.

Referenced by addToRegistry().

185 { return false; }

◆ hasAbilityToProduceInEndRuns()

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

inlinevirtual

Definition at line 188 of file ProductRegistryHelper.h.

Referenced by addToRegistry().

188 { return false; }

◆ produces() [1/11]

template<Transition Tr = Transition::Event>

auto edm::ProductRegistryHelper::produces ( std::string instanceName )

inlinenoexcept

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.

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

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

◆ produces() [2/11]

template<Transition Tr = Transition::Event>

auto edm::ProductRegistryHelper::produces ( )

inlinenoexcept

Definition at line 121 of file ProductRegistryHelper.h.

Referenced by edm::EndPathStatusInserter::EndPathStatusInserter(), edm::LogErrorHarvester::LogErrorHarvester(), LowPtGsfElectronIDProducer::LowPtGsfElectronIDProducer(), edm::PathStatusInserter::PathStatusInserter(), pat::PATPackedCandidateProducer::PATPackedCandidateProducer(), edm::SwitchProducer::SwitchProducer(), and edm::TriggerResultInserter::TriggerResultInserter().

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

◆ produces() [3/11]

template<class ProductType >

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

inline

Definition at line 126 of file ProductRegistryHelper.h.

References AlCaHLTBitMon_QueryRunRegistry::string.

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

◆ produces() [4/11]

template<class ProductType >

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

inline

Definition at line 131 of file ProductRegistryHelper.h.

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

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

◆ produces() [5/11]

template<typename ProductType , BranchType B>

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

inline

Definition at line 136 of file ProductRegistryHelper.h.

References AlCaHLTBitMon_QueryRunRegistry::string.

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

◆ produces() [6/11]

template<typename ProductType , BranchType B>

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

inline

Definition at line 141 of file ProductRegistryHelper.h.

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

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

◆ produces() [7/11]

template<typename ProductType , Transition B>

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

inline

Definition at line 148 of file ProductRegistryHelper.h.

References AlCaHLTBitMon_QueryRunRegistry::string.

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

◆ produces() [8/11]

template<typename ProductType , Transition B>

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

inline

Definition at line 153 of file ProductRegistryHelper.h.

References B, edm::Event, MuonErrorMatrixAdjuster_cfi::instanceName, 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)};
     }

◆ produces() [9/11]

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

inline

Definition at line 159 of file ProductRegistryHelper.h.

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

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

◆ produces() [10/11]

template<BranchType B>

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

inline

Definition at line 166 of file ProductRegistryHelper.h.

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

◆ produces() [11/11]

template<Transition B>

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

inline

Definition at line 175 of file ProductRegistryHelper.h.

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