edm::ProductRegistryHelper Class Reference

#include <ProductRegistryHelper.h>

Inheritance diagram for edm::ProductRegistryHelper:

Classes
struct	TypeLabelItem

Public Types
typedef std::list< TypeLabelItem >	TypeLabelList

Public Member Functions
template<class ProductType >
TypeLabelItem const &	produces ()
	declare what type of product will make and with which optional label More...
template<class ProductType >
TypeLabelItem const &	produces (std::string const &instanceName)
template<typename ProductType , BranchType B>
TypeLabelItem const &	produces ()
template<typename ProductType , BranchType B>
TypeLabelItem const &	produces (std::string const &instanceName)
TypeLabelItem const &	produces (const TypeID &id, std::string const &instanceName=std::string())
template<BranchType B>
TypeLabelItem const &	produces (const TypeID &id, std::string const &instanceName=std::string())
	ProductRegistryHelper ()
TypeLabelList &	typeLabelList ()
	used by the fwk to register the list of products of this module More...
	~ProductRegistryHelper ()

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

Private Attributes
TypeLabelList	typeLabelList_

Detailed Description

Definition at line 18 of file ProductRegistryHelper.h.

Member Typedef Documentation

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

Definition at line 37 of file ProductRegistryHelper.h.

Constructor & Destructor Documentation

edm::ProductRegistryHelper::ProductRegistryHelper ( )

inline

Definition at line 21 of file ProductRegistryHelper.h.

: typeLabelList_() {}

edm::ProductRegistryHelper::~ProductRegistryHelper

(

)

Definition at line 15 of file ProductRegistryHelper.cc.

{ }

Member Function Documentation

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

static

Definition at line 22 of file ProductRegistryHelper.cc.

References edm::ProductRegistry::addProduct(), edm::TypeWithDict::byName(), edm::errors::DictionaryNotFound, Exception, edm::hasDictionary(), edm::BranchDescription::insertBranchAlias(), edm::ModuleDescription::moduleLabel(), edm::ModuleDescription::moduleName(), AlCaHLTBitMon_ParallelJobs::p, edm::ModuleDescription::parameterSetID(), and edm::ModuleDescription::processName().

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

                                                         {
    for(TypeLabelList::const_iterator p = iBegin; p != iEnd; ++p) {
      // This should load the dictionary if not already loaded.
      TClass::GetClass(p->typeID_.typeInfo());
      if(!hasDictionary(p->typeID_.typeInfo())) {
        // a second attempt to load
        TypeWithDict::byName(p->typeID_.userClassName());
      }
      if(!hasDictionary(p->typeID_.typeInfo())) {
        throw Exception(errors::DictionaryNotFound)
           << "No data dictionary found for class:\n\n"
           <<  p->typeID_.className()
           << "\nMost likely the dictionary was never generated,\n"
           << "but it may be that it was generated in the wrong package.\n"
           << "Please add (or move) the specification\n"
           << "<class name=\"whatever\"/>\n"
           << "to the appropriate classes_def.xml file.\n"
           << "If the class is a template instance, you may need\n"
           << "to define a dummy variable of this type in classes.h.\n"
           << "Also, if this class has any transient members,\n"
           << "you need to specify them in classes_def.xml.";
      }
      TypeWithDict type(p->typeID_.typeInfo());
      BranchDescription pdesc(p->branchType_,
                              iDesc.moduleLabel(),
                              iDesc.processName(),
                              p->typeID_.userClassName(),
                              p->typeID_.friendlyClassName(),
                              p->productInstanceName_,
                              iDesc.moduleName(),
                              iDesc.parameterSetID(),
                              type);
      if (!p->branchAlias_.empty()) pdesc.insertBranchAlias(p->branchAlias_);
      iReg.addProduct(pdesc, iIsListener);
    }//for
  }

template<class ProductType >

TypeLabelItem const& 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 58 of file ProductRegistryHelper.h.

References AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by GoodSeedProducer::GoodSeedProducer(), MuonProducer::MuonProducer(), PFCandidateMixer::PFCandidateMixer(), VariableNTupler::registerleaves(), and StringBasedNTupler::registerleaves().

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

template<class ProductType >

TypeLabelItem const& edm::ProductRegistryHelper::produces ( std::string const &  instanceName )

inline

Definition at line 63 of file ProductRegistryHelper.h.

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

template<typename ProductType , BranchType B>

TypeLabelItem const& edm::ProductRegistryHelper::produces ( )

inline

Definition at line 68 of file ProductRegistryHelper.h.

References AlCaHLTBitMon_QueryRunRegistry::string.

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

template<typename ProductType , BranchType B>

TypeLabelItem const& edm::ProductRegistryHelper::produces ( std::string const &  instanceName )

inline

Definition at line 73 of file ProductRegistryHelper.h.

                                                                 {
      TypeID tid(typeid(ProductType));
      return produces<B>(tid,instanceName);
    }

TypeLabelItem const& edm::ProductRegistryHelper::produces ( const TypeID &  id, std::string const &  instanceName = std::string()  )

inline

Definition at line 79 of file ProductRegistryHelper.h.

                                                                                               {
       return produces<InEvent>(id,instanceName);
    }

template<BranchType B>

TypeLabelItem const& edm::ProductRegistryHelper::produces ( const TypeID &  id, std::string const &  instanceName = std::string()  )

inline

Definition at line 84 of file ProductRegistryHelper.h.

References typeLabelList_.

                                                                                               {
       typeLabelList_.emplace_back(B, id, instanceName);
       return *typeLabelList_.rbegin();
    }

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

(

)

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

Definition at line 17 of file ProductRegistryHelper.cc.

References typeLabelList_.

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

                                                                            {
    return typeLabelList_;
  }

Member Data Documentation

TypeLabelList edm::ProductRegistryHelper::typeLabelList_

private

Definition at line 89 of file ProductRegistryHelper.h.

Referenced by produces(), and typeLabelList().