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

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

◆ TypeLabelList

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

Definition at line 86 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 26 of file ProductRegistryHelper.h.

26 : typeLabelList_() {}

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.

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

References edm::ProductRegistry::addProduct(), edm::BeginLuminosityBlock, edm::BeginProcessBlock, edm::BeginRun, edm::checkClassDictionaries(), edm::checkDictionary(), edm::checkDictionaryOfWrappedType(), 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().

◆ hasAbilityToProduceInBeginLumis()

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

inlinevirtual

Definition at line 172 of file ProductRegistryHelper.h.

172 { return false; }

Referenced by addToRegistry().

◆ hasAbilityToProduceInBeginProcessBlocks()

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

inlinevirtual

Definition at line 166 of file ProductRegistryHelper.h.

166 { return false; }

Referenced by addToRegistry().

◆ hasAbilityToProduceInBeginRuns()

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

inlinevirtual

Definition at line 169 of file ProductRegistryHelper.h.

169 { return false; }

Referenced by addToRegistry().

◆ hasAbilityToProduceInEndLumis()

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

inlinevirtual

Definition at line 173 of file ProductRegistryHelper.h.

173 { return false; }

Referenced by addToRegistry().

◆ hasAbilityToProduceInEndProcessBlocks()

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

inlinevirtual

Definition at line 167 of file ProductRegistryHelper.h.

167 { return false; }

Referenced by addToRegistry().

◆ hasAbilityToProduceInEndRuns()

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

inlinevirtual

Definition at line 170 of file ProductRegistryHelper.h.

170 { return false; }

Referenced by addToRegistry().

◆ produces() [1/9]

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.

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

References AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by pat::PATPackedCandidateProducer::PATPackedCandidateProducer(), and edm::SwitchProducer::SwitchProducer().

◆ produces() [2/9]

template<typename ProductType , BranchType B>

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

inline

Definition at line 118 of file ProductRegistryHelper.h.

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

References AlCaHLTBitMon_QueryRunRegistry::string.

◆ produces() [3/9]

template<typename ProductType , Transition B>

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

inline

Definition at line 130 of file ProductRegistryHelper.h.

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

References AlCaHLTBitMon_QueryRunRegistry::string.

◆ produces() [4/9]

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

inline

Definition at line 141 of file ProductRegistryHelper.h.

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

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

◆ produces() [5/9]

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.

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

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

◆ produces() [6/9]

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.

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

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

◆ produces() [7/9]

template<class ProductType >

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

inline

Definition at line 113 of file ProductRegistryHelper.h.

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

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

◆ produces() [8/9]

template<typename ProductType , BranchType B>

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

inline

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

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

◆ produces() [9/9]

template<typename ProductType , Transition B>

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

inline

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

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

◆ recordProvenanceList()

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

inline

Definition at line 91 of file ProductRegistryHelper.h.

91 { return recordProvenanceList_; }

References recordProvenanceList_.

◆ typeLabelList()

ProductRegistryHelper::TypeLabelList const & edm::ProductRegistryHelper::typeLabelList ( ) const

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

Definition at line 20 of file ProductRegistryHelper.cc.

20 { return typeLabelList_; }

References typeLabelList_.

Referenced by edm::ProducerBase::registerProducts(), and edm::ProducerBase::resolvePutIndicies().

Member Data Documentation

◆ recordProvenanceList_

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

private

Definition at line 177 of file ProductRegistryHelper.h.

Referenced by produces(), and recordProvenanceList().

◆ typeLabelList_

TypeLabelList edm::ProductRegistryHelper::typeLabelList_

private

Definition at line 176 of file ProductRegistryHelper.h.

Referenced by produces(), and typeLabelList().

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ TypeLabelList

Constructor & Destructor Documentation

◆ ~ProductRegistryHelper()

◆ ProductRegistryHelper()

Member Function Documentation

◆ addToRegistry()

◆ hasAbilityToProduceInBeginLumis()

◆ hasAbilityToProduceInBeginProcessBlocks()

◆ hasAbilityToProduceInBeginRuns()

◆ hasAbilityToProduceInEndLumis()

◆ hasAbilityToProduceInEndProcessBlocks()

◆ hasAbilityToProduceInEndRuns()

◆ 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]

◆ recordProvenanceList()

◆ typeLabelList()

Member Data Documentation

◆ recordProvenanceList_

◆ typeLabelList_