edm::PrincipalGetAdapter Class Reference

#include <PrincipalGetAdapter.h>

Public Types
typedef std::vector< BasicHandle >	BasicHandleVec

Public Member Functions
template<typename PROD >
bool	checkIfComplete () const
BranchDescription const &	getBranchDescription (TypeID const &type, std::string const &productInstanceName) const
BasicHandle	getByLabel_ (TypeID const &tid, InputTag const &tag, ModuleCallingContext const *mcc) const
BasicHandle	getByLabel_ (TypeID const &tid, std::string const &label, std::string const &instance, std::string const &process, ModuleCallingContext const *mcc) const
BasicHandle	getByToken_ (TypeID const &id, KindOfType kindOfType, EDGetToken token, ModuleCallingContext const *mcc) const
template<typename PROD >
void	getManyByType (std::vector< Handle< PROD > > &results, ModuleCallingContext const *mcc) const
void	getManyByType_ (TypeID const &tid, BasicHandleVec &results, ModuleCallingContext const *mcc) const
BasicHandle	getMatchingSequenceByLabel_ (TypeID const &typeID, InputTag const &tag, ModuleCallingContext const *mcc) const
BasicHandle	getMatchingSequenceByLabel_ (TypeID const &typeID, std::string const &label, std::string const &instance, std::string const &process, ModuleCallingContext const *mcc) const
bool	isComplete () const
PrincipalGetAdapter &	operator= (PrincipalGetAdapter const &)=delete
Principal &	principal ()
Principal const &	principal () const
	PrincipalGetAdapter (Principal &pcpl, ModuleDescription const &md)
	PrincipalGetAdapter (PrincipalGetAdapter const &)=delete
ProcessHistory const &	processHistory () const
EDProductGetter const *	prodGetter () const
void	setConsumer (EDConsumerBase const *iConsumer)
	~PrincipalGetAdapter ()

Private Member Functions
BranchType const &	branchType () const
BasicHandle	makeFailToGetException (KindOfType, TypeID const &, EDGetToken) const
void	throwAmbiguousException (TypeID const &productType, EDGetToken token) const

Private Attributes
EDConsumerBase const *	consumer_
ModuleDescription const &	md_
Principal &	principal_

Detailed Description

Definition at line 125 of file PrincipalGetAdapter.h.

Member Typedef Documentation

typedef std::vector<BasicHandle> edm::PrincipalGetAdapter::BasicHandleVec

Definition at line 160 of file PrincipalGetAdapter.h.

Constructor & Destructor Documentation

PrincipalGetAdapter::PrincipalGetAdapter	(	Principal &	pcpl,
		ModuleDescription const &	md
	)

Definition at line 20 of file PrincipalGetAdapter.cc.

                                  :
    //putProducts_(),
    principal_(pcpl),
    md_(md),
    consumer_(nullptr)
  {
  }

PrincipalGetAdapter::~PrincipalGetAdapter

(

)

Definition at line 29 of file PrincipalGetAdapter.cc.

                                            {
  }

edm::PrincipalGetAdapter::PrincipalGetAdapter ( PrincipalGetAdapter const &  )

delete

Member Function Documentation

BranchType const & PrincipalGetAdapter::branchType ( ) const

private

Definition at line 137 of file PrincipalGetAdapter.cc.

References edm::Principal::branchType(), and principal_.

Referenced by getByToken_().

                                        {
    return principal_.branchType();
  }

template<typename PROD >

bool PrincipalGetAdapter::checkIfComplete ( ) const

inline

Definition at line 308 of file PrincipalGetAdapter.h.

References isComplete().

Referenced by edm::LuminosityBlock::getByLabel(), edm::Run::getByLabel(), edm::LuminosityBlock::getByToken(), edm::Run::getByToken(), edm::LuminosityBlock::getManyByType(), and edm::Run::getManyByType().

                                             { 
    return isComplete() || !detail::has_mergeProduct_function<PROD>::value;
  }

BranchDescription const & PrincipalGetAdapter::getBranchDescription	(	TypeID const &	type,
		std::string const &	productInstanceName
	)		const

Definition at line 216 of file PrincipalGetAdapter.cc.

References edm::ProductHolderBase::branchDescription(), edm::hlt::Exception, edm::TypeID::friendlyClassName(), edm::Principal::getProductHolderByIndex(), edm::ProductHolderIndexHelper::index(), cmsHarvester::index, edm::errors::InsertFailure, md_, edm::ModuleDescription::moduleLabel(), principal_, edm::ModuleDescription::processName(), edm::PRODUCT_TYPE, edm::ProductHolderIndexInvalid, edm::Principal::productLookup(), and edm::Principal::productRegistry().

Referenced by edm::Event::getRefBeforePut(), edm::LuminosityBlock::put(), edm::Run::put(), and edm::Event::put().

                                                                                        {
    ProductHolderIndexHelper const& productHolderIndexHelper = principal_.productLookup();
    ProductHolderIndex index = productHolderIndexHelper.index(PRODUCT_TYPE, type, md_.moduleLabel().c_str(),productInstanceName.c_str(), md_.processName().c_str());
    if(index == ProductHolderIndexInvalid) {
      throw edm::Exception(edm::errors::InsertFailure)
    << "Illegal attempt to 'put' an unregistered product.\n"
    << "No product is registered for\n"
    << "  product friendly class name: '" << type.friendlyClassName() << "'\n"
  << "  module label:                '" << md_.moduleLabel() << "'\n"
    << "  product instance name:       '" << productInstanceName << "'\n"
  << "  process name:                '" << md_.processName() << "'\n"

    << "The ProductRegistry contains:\n"
    << principal_.productRegistry()
    << '\n';
    }
    ProductHolderBase const*  phb = principal_.getProductHolderByIndex(index);
    assert(phb != nullptr);
    return phb->branchDescription();
  }

BasicHandle PrincipalGetAdapter::getByLabel_	(	TypeID const &	tid,
		InputTag const &	tag,
		ModuleCallingContext const *	mcc
	)		const

Definition at line 142 of file PrincipalGetAdapter.cc.

References consumer_, edm::Principal::getByLabel(), principal_, and edm::PRODUCT_TYPE.

Referenced by edm::LuminosityBlock::getByLabel(), edm::Run::getByLabel(), edm::Event::getByLabel(), edm::LuminosityBlock::getByLabelImpl(), edm::Run::getByLabelImpl(), and edm::Event::getByLabelImpl().

                                                                          {
    return principal_.getByLabel(PRODUCT_TYPE, typeID, tag, consumer_, mcc);
  }

BasicHandle PrincipalGetAdapter::getByLabel_	(	TypeID const &	tid,
		std::string const &	label,
		std::string const &	instance,
		std::string const &	process,
		ModuleCallingContext const *	mcc
	)		const

Definition at line 149 of file PrincipalGetAdapter.cc.

References consumer_, edm::Principal::getByLabel(), principal_, and edm::PRODUCT_TYPE.

                                                                          {
    return principal_.getByLabel(PRODUCT_TYPE, typeID, label, instance, process, consumer_, mcc);
  }

BasicHandle PrincipalGetAdapter::getByToken_	(	TypeID const &	id,
		KindOfType	kindOfType,
		EDGetToken	token,
		ModuleCallingContext const *	mcc
	)		const

Definition at line 158 of file PrincipalGetAdapter.cc.

References branchType(), consumer_, edm::Principal::getByToken(), h, cmsHarvester::index, edm::EDConsumerBase::indexFrom(), edm::BasicHandle::isValid(), makeFailToGetException(), principal_, edm::ProductHolderIndexAndSkipBit::productHolderIndex(), edm::ProductHolderIndexAmbiguous, edm::ProductHolderIndexInvalid, edm::ProductHolderIndexAndSkipBit::skipCurrentProcess(), throwAmbiguousException(), and unlikely.

Referenced by edm::LuminosityBlock::getByToken(), edm::Run::getByToken(), and edm::Event::getByToken().

                                                                          {
    ProductHolderIndexAndSkipBit indexAndBit = consumer_->indexFrom(token,branchType(),id);
    ProductHolderIndex index = indexAndBit.productHolderIndex();
    bool skipCurrentProcess = indexAndBit.skipCurrentProcess();
    if( unlikely(index == ProductHolderIndexInvalid)) {
      return makeFailToGetException(kindOfType,id,token);
    } else if( unlikely(index == ProductHolderIndexAmbiguous)) {
      // This deals with ambiguities where the process is specified
      throwAmbiguousException(id, token);
    }
    bool ambiguous = false;
    BasicHandle h = principal_.getByToken(kindOfType, id, index, skipCurrentProcess, ambiguous, mcc);
    if (ambiguous) {
      // This deals with ambiguities where the process is not specified
      throwAmbiguousException(id, token);
    } else if(!h.isValid()) {
      return makeFailToGetException(kindOfType,id,token);
    }
    return h;
  }

template<typename PROD >

void PrincipalGetAdapter::getManyByType ( std::vector< Handle< PROD > > &  results, ModuleCallingContext const *  mcc  ) const

inline

Definition at line 315 of file PrincipalGetAdapter.h.

References edm::convert_handle(), end, getManyByType_(), PROD, edm::es::products(), query::result, and python.entryComment::results.

Referenced by edm::LuminosityBlock::getManyByType(), edm::Run::getManyByType(), and edm::Event::getManyByType().

                                                                            { 
    BasicHandleVec bhv;
    this->getManyByType_(TypeID(typeid(PROD)), bhv, mcc);
    
    // Go through the returned handles; for each element,
    //   1. create a Handle<PROD> and
    //
    // This function presents an exception safety difficulty. If an
    // exception is thrown when converting a handle, the "got
    // products" record will be wrong.
    //
    // Since EDProducers are not allowed to use this function,
    // the problem does not seem too severe.
    //
    // Question: do we even need to keep track of the "got products"
    // for this function, since it is *not* to be used by EDProducers?
    std::vector<Handle<PROD> > products;

    typename BasicHandleVec::iterator it = bhv.begin();
    typename BasicHandleVec::iterator end = bhv.end();

    while (it != end) {
      Handle<PROD> result;
      convert_handle(std::move(*it), result);  // throws on conversion error
      products.push_back(result);
      ++it;
    }
    results.swap(products);
  }

void PrincipalGetAdapter::getManyByType_	(	TypeID const &	tid,
		BasicHandleVec &	results,
		ModuleCallingContext const *	mcc
	)		const

Definition at line 204 of file PrincipalGetAdapter.cc.

References consumer_, edm::Principal::getManyByType(), and principal_.

Referenced by getManyByType().

                                                                             {
    principal_.getManyByType(tid, results, consumer_, mcc);
  }

BasicHandle PrincipalGetAdapter::getMatchingSequenceByLabel_	(	TypeID const &	typeID,
		InputTag const &	tag,
		ModuleCallingContext const *	mcc
	)		const

Definition at line 181 of file PrincipalGetAdapter.cc.

References consumer_, edm::ELEMENT_TYPE, edm::Principal::getByLabel(), and principal_.

Referenced by edm::Event::getByLabel().

                                                                                          {
    return principal_.getByLabel(ELEMENT_TYPE, typeID, tag, consumer_, mcc);
  }

BasicHandle PrincipalGetAdapter::getMatchingSequenceByLabel_	(	TypeID const &	typeID,
		std::string const &	label,
		std::string const &	instance,
		std::string const &	process,
		ModuleCallingContext const *	mcc
	)		const

Definition at line 188 of file PrincipalGetAdapter.cc.

References consumer_, edm::ELEMENT_TYPE, edm::Principal::getByLabel(), h, and principal_.

                                                                                          {
    auto h= principal_.getByLabel(ELEMENT_TYPE,
                                  typeID,
                                  label,
                                  instance,
                                  process,
                                  consumer_,
                                  mcc);
    return h;
  }

bool PrincipalGetAdapter::isComplete

(

)

const

Definition at line 244 of file PrincipalGetAdapter.cc.

References edm::Principal::isComplete(), and principal_.

Referenced by checkIfComplete().

                                        {
    return principal_.isComplete();
  }

BasicHandle PrincipalGetAdapter::makeFailToGetException ( KindOfType  kindOfType, TypeID const &  productType, EDGetToken  token  ) const

private

Definition at line 100 of file PrincipalGetAdapter.cc.

References consumer_, cppFunctionSkipper::exception, tablePrinter::labels, edm::EDConsumerBase::labelsForToken(), edm::makeHandleExceptionFactory(), edm::EDConsumerBase::Labels::module, edm::EDConsumerBase::Labels::process, edm::PRODUCT_TYPE, edm::EDConsumerBase::Labels::productInstance, and edm::errors::ProductNotFound.

Referenced by getByToken_().

                                                                      {
    EDConsumerBase::Labels labels;
    consumer_->labelsForToken(token,labels);
    //no need to copy memory since the exception will no occur after the
    // const char* have been deleted
    return BasicHandle(makeHandleExceptionFactory([labels,kindOfType,productType]()->std::shared_ptr<cms::Exception> {
      std::shared_ptr<cms::Exception> exception(std::make_shared<Exception>(errors::ProductNotFound));
      if (kindOfType == PRODUCT_TYPE) {
        *exception << "Principal::getByToken: Found zero products matching all criteria\nLooking for type: " << productType << "\n"
        << "Looking for module label: " << labels.module << "\n" << "Looking for productInstanceName: " << labels.productInstance << "\n"
        << (0==labels.process[0] ? "" : "Looking for process: ") << labels.process << "\n";
      } else {
        *exception << "Principal::getByToken: Found zero products matching all criteria\nLooking for a container with elements of type: " << productType << "\n"
        << "Looking for module label: " << labels.module << "\n" << "Looking for productInstanceName: " << labels.productInstance << "\n"
        << (0==labels.process[0] ? "" : "Looking for process: ") << labels.process << "\n";
      }
      return exception;
    }));
  }

PrincipalGetAdapter& edm::PrincipalGetAdapter::operator= ( PrincipalGetAdapter const &  )

delete

Principal& edm::PrincipalGetAdapter::principal ( )

inline

Definition at line 154 of file PrincipalGetAdapter.h.

References principal_.

Referenced by edm::Event::eventPrincipal(), edm::Event::getAllProvenance(), edm::Event::getProvenance(), edm::LuminosityBlock::luminosityBlockPrincipal(), edm::Run::runPrincipal(), and edm::Event::size().

{return principal_;}

Principal const& edm::PrincipalGetAdapter::principal ( ) const

inline

Definition at line 155 of file PrincipalGetAdapter.h.

References principal_.

{return principal_;}

ProcessHistory const & PrincipalGetAdapter::processHistory

(

)

const

Definition at line 211 of file PrincipalGetAdapter.cc.

References principal_, and edm::Principal::processHistory().

Referenced by edm::LuminosityBlock::processHistory(), edm::Run::processHistory(), and edm::Event::processHistory().

                                            {
    return principal_.processHistory();
  }

EDProductGetter const * PrincipalGetAdapter::prodGetter

(

)

const

Definition at line 239 of file PrincipalGetAdapter.cc.

References principal_, and edm::Principal::prodGetter().

Referenced by edm::Event::getRefBeforePut().

                                       {
    return principal_.prodGetter();
  }

void edm::PrincipalGetAdapter::setConsumer ( EDConsumerBase const *  iConsumer )

inline

Definition at line 137 of file PrincipalGetAdapter.h.

References consumer_.

Referenced by edm::Run::setConsumer(), edm::Event::setConsumer(), and edm::LuminosityBlock::setConsumer().

                                                      {
      consumer_ = iConsumer;
    }

void PrincipalGetAdapter::throwAmbiguousException ( TypeID const &  productType, EDGetToken  token  ) const

private

Definition at line 123 of file PrincipalGetAdapter.cc.

References consumer_, cppFunctionSkipper::exception, tablePrinter::labels, edm::EDConsumerBase::labelsForToken(), edm::EDConsumerBase::Labels::module, edm::EDConsumerBase::Labels::process, and edm::EDConsumerBase::Labels::productInstance.

Referenced by getByToken_().

                                                                       {
    EDConsumerBase::Labels labels;
    consumer_->labelsForToken(token,labels);
    cms::Exception exception("AmbiguousProduct");
    exception << "Principal::getByToken: More than 1 product matches all criteria\nLooking for a container with elements of type: " << productType << "\n"
    << "Looking for module label: " << labels.module << "\n" << "Looking for productInstanceName: " << labels.productInstance << "\n"
    << (0==labels.process[0] ? "" : "Looking for process: ") << labels.process << "\n"
    << "This can only occur with get function calls using a Handle<View> argument.\n"
    << "Try a get not using a View or change the instance name of one of the products";
    throw exception;    
  }

Member Data Documentation

EDConsumerBase const* edm::PrincipalGetAdapter::consumer_

private

Definition at line 228 of file PrincipalGetAdapter.h.

Referenced by getByLabel_(), getByToken_(), getManyByType_(), getMatchingSequenceByLabel_(), makeFailToGetException(), setConsumer(), and throwAmbiguousException().

ModuleDescription const& edm::PrincipalGetAdapter::md_

private

Definition at line 226 of file PrincipalGetAdapter.h.

Referenced by getBranchDescription().

Principal& edm::PrincipalGetAdapter::principal_

private

Definition at line 222 of file PrincipalGetAdapter.h.

Referenced by branchType(), getBranchDescription(), getByLabel_(), getByToken_(), getManyByType_(), getMatchingSequenceByLabel_(), isComplete(), principal(), processHistory(), and prodGetter().