#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

BranchDescription const &	getBranchDescription (unsigned int iPutTokenIndex) 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

ProductID const &	getProductID (unsigned int iPutTokenIndex) const

EDPutToken::value_type	getPutTokenIndex (TypeID const &type, std::string const &productInstanceName) const

TypeID const &	getTypeIDForPutTokenIndex (EDPutToken::value_type index) const

bool	isComplete () const

void	labelsForToken (EDGetToken const &iToken, ProductLabels &oLabels) const

size_t	numberOfProductsConsumed () const

PrincipalGetAdapter &	operator= (PrincipalGetAdapter const &)=delete

Principal const &	principal () const

	PrincipalGetAdapter (Principal const &pcpl, ModuleDescription const &md, bool isComplete)

	PrincipalGetAdapter (PrincipalGetAdapter const &)=delete

ProcessHistory const &	processHistory () const

EDProductGetter const *	prodGetter () const

std::string const &	productInstanceLabel (EDPutToken) const

std::vector< edm::ProductResolverIndex > const &	putTokenIndexToProductResolverIndex () const

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

void	setConsumer (EDConsumerBase const *iConsumer)

void	setProducer (ProducerBase const *iProd)

void	setSharedResourcesAcquirer (SharedResourcesAcquirer *iSra)

Transition	transition () const

	~PrincipalGetAdapter ()

Private Member Functions
BranchType const &	branchType () const

BasicHandle	makeFailToGetException (KindOfType, TypeID const &, EDGetToken) const

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

void	throwUnregisteredPutException (TypeID const &type, std::string const &productInstanceLabel) const

Private Attributes
EDConsumerBase const *	consumer_

bool	isComplete_

ModuleDescription const &	md_

Principal const &	principal_

ProducerBase const *	prodBase_ = 0

SharedResourcesAcquirer *	resourcesAcquirer_

Detailed Description

Definition at line 134 of file PrincipalGetAdapter.h.

Member Typedef Documentation

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

Definition at line 185 of file PrincipalGetAdapter.h.

Constructor & Destructor Documentation

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

Definition at line 21 of file PrincipalGetAdapter.cc.

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

PrincipalGetAdapter::~PrincipalGetAdapter ( )

Definition at line 32 of file PrincipalGetAdapter.cc.

32 {

33 }

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

delete

Member Function Documentation

BranchType const & PrincipalGetAdapter::branchType ( ) const

private

Definition at line 173 of file PrincipalGetAdapter.cc.

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

Referenced by getByToken_(), and transition().

                                         {
     return principal_.branchType();
   }

template<typename PROD >

bool PrincipalGetAdapter::checkIfComplete ( ) const

inline

Definition at line 338 of file PrincipalGetAdapter.h.

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

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

Definition at line 278 of file PrincipalGetAdapter.cc.

References edm::ProductResolverBase::branchDescription(), edm::Principal::getProductResolverByIndex(), edm::ProductResolverIndexHelper::index(), md_, edm::ModuleDescription::moduleLabel(), principal_, edm::ModuleDescription::processName(), edm::PRODUCT_TYPE, edm::Principal::productLookup(), edm::ProductResolverIndexInvalid, throwUnregisteredPutException(), and unlikely.

                                                                                         {
     ProductResolverIndexHelper const& productResolverIndexHelper = principal_.productLookup();
     ProductResolverIndex index = productResolverIndexHelper.index(PRODUCT_TYPE, type, md_.moduleLabel().c_str(),productInstanceName.c_str(), md_.processName().c_str());
     if(unlikely(index == ProductResolverIndexInvalid)) {
       throwUnregisteredPutException(type, productInstanceName);
     }
     ProductResolverBase const*  phb = principal_.getProductResolverByIndex(index);
     assert(phb != nullptr);
     return phb->branchDescription();
   }

BranchDescription const & PrincipalGetAdapter::getBranchDescription ( unsigned int iPutTokenIndex ) const

Definition at line 291 of file PrincipalGetAdapter.cc.

References edm::ProductResolverBase::branchDescription(), edm::Principal::getProductResolverByIndex(), principal_, prodBase_, and edm::ProducerBase::putTokenIndexToProductResolverIndex().

                                                                              {
     auto index = prodBase_->putTokenIndexToProductResolverIndex()[iPutTokenIndex];
     ProductResolverBase const*  phb = principal_.getProductResolverByIndex(index);
     assert(phb != nullptr);
     return phb->branchDescription();
   }

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

Definition at line 178 of file PrincipalGetAdapter.cc.

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

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

                                                                           {
     return principal_.getByLabel(PRODUCT_TYPE, typeID, tag, consumer_, resourcesAcquirer_, 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 185 of file PrincipalGetAdapter.cc.

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

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

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

Definition at line 194 of file PrincipalGetAdapter.cc.

References branchType(), consumer_, edm::Principal::getByToken(), h, edm::EDConsumerBase::indexFrom(), edm::BasicHandle::isValid(), makeFailToGetException(), principal_, edm::ProductResolverIndexAndSkipBit::productResolverIndex(), edm::ProductResolverIndexAmbiguous, edm::ProductResolverIndexInvalid, resourcesAcquirer_, edm::ProductResolverIndexAndSkipBit::skipCurrentProcess(), throwAmbiguousException(), and unlikely.

Referenced by edm::OccurrenceForOutput::getByToken().

                                                                           {
     ProductResolverIndexAndSkipBit indexAndBit = consumer_->indexFrom(token,branchType(),id);
     ProductResolverIndex index = indexAndBit.productResolverIndex();
     bool skipCurrentProcess = indexAndBit.skipCurrentProcess();
     if( unlikely(index == ProductResolverIndexInvalid)) {
       return makeFailToGetException(kindOfType,id,token);
     } else if( unlikely(index == ProductResolverIndexAmbiguous)) {
       // This deals with ambiguities where the process is specified
       throwAmbiguousException(id, token);
     }
     bool ambiguous = false;
     BasicHandle h = principal_.getByToken(kindOfType, id, index, skipCurrentProcess, ambiguous, resourcesAcquirer_, 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 345 of file PrincipalGetAdapter.h.

References edm::convert_handle(), end, eostools::move(), PROD, edm::es::products(), mps_fire::result, and mps_update::results.

                                                                             { 
     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 241 of file PrincipalGetAdapter.cc.

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

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

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

Definition at line 217 of file PrincipalGetAdapter.cc.

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

                                                                                           {
     return principal_.getByLabel(ELEMENT_TYPE, typeID, tag, consumer_, resourcesAcquirer_, 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 224 of file PrincipalGetAdapter.cc.

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

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

ProductID const & PrincipalGetAdapter::getProductID ( unsigned int iPutTokenIndex ) const

Definition at line 299 of file PrincipalGetAdapter.cc.

References edm::Principal::getProductResolverByIndex(), principal_, prodBase_, edm::ProducerBase::putTokenIndexToProductResolverIndex(), and edm::ProductResolverBase::stableProvenance().

                                                                      {
     auto index = prodBase_->putTokenIndexToProductResolverIndex()[iPutTokenIndex];
     ProductResolverBase const*  phb = principal_.getProductResolverByIndex(index);
     assert(phb != nullptr);
     auto prov = phb->stableProvenance();
     assert(prov != nullptr);
     return prov->productID();
   }

EDPutToken::value_type PrincipalGetAdapter::getPutTokenIndex	(	TypeID const &	type,
		std::string const &	productInstanceName
	)		const

Definition at line 328 of file PrincipalGetAdapter.cc.

References SiStripPI::max, prodBase_, AlCaHLTBitMon_QueryRunRegistry::string, throwUnregisteredPutException(), transition(), and edm::ProductRegistryHelper::typeLabelList().

                                                                                                       {
     auto tran = transition();
     size_t index = 0;
     for(auto const& tl : prodBase_->typeLabelList()) {
       if((tran == tl.transition_) and (type == tl.typeID_)
          and (productInstanceName == tl.productInstanceName_)) {
         return index;
       }
       ++index;
     }
     throwUnregisteredPutException(type, productInstanceName);
     return std::numeric_limits<unsigned int>::max();
   }

TypeID const & PrincipalGetAdapter::getTypeIDForPutTokenIndex ( EDPutToken::value_type index ) const

Definition at line 349 of file PrincipalGetAdapter.cc.

References prodBase_, and edm::ProductRegistryHelper::typeLabelList().

                                                                                  {
     return prodBase_->typeLabelList()[index].typeID_;
   }

bool edm::PrincipalGetAdapter::isComplete ( ) const

inline

Definition at line 160 of file PrincipalGetAdapter.h.

References mps_update::results.

Referenced by edm::OccurrenceForOutput::getByToken(), and transition().

160 { return isComplete_;}

edm::PrincipalGetAdapter::isComplete_

bool isComplete_

Definition: PrincipalGetAdapter.h:270

void PrincipalGetAdapter::labelsForToken	(	EDGetToken const &	iToken,
		ProductLabels &	oLabels
	)		const

Definition at line 131 of file PrincipalGetAdapter.cc.

References consumer_, and edm::EDConsumerBase::labelsForToken().

                                                                                             {
     consumer_->labelsForToken(iToken,oLabels);
   }

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

private

Definition at line 136 of file PrincipalGetAdapter.cc.

References consumer_, cppFunctionSkipper::exception, tablePrinter::labels, edm::EDConsumerBase::labelsForToken(), edm::makeHandleExceptionFactory(), edm::ProductLabels::module, edm::ProductLabels::process, edm::PRODUCT_TYPE, edm::ProductLabels::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;
     }));
   }

size_t PrincipalGetAdapter::numberOfProductsConsumed ( ) const

Definition at line 126 of file PrincipalGetAdapter.cc.

References consumer_, edm::InEvent, and edm::EDConsumerBase::itemsToGetFrom().

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

                                                       {
     return consumer_->itemsToGetFrom(InEvent).size();
   }

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

delete

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

inline

ProcessHistory const & PrincipalGetAdapter::processHistory ( ) const

Definition at line 248 of file PrincipalGetAdapter.cc.

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

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

                                             {
     return principal_.processHistory();
   }

EDProductGetter const * PrincipalGetAdapter::prodGetter ( ) const

Definition at line 366 of file PrincipalGetAdapter.cc.

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

                                        {
     return principal_.prodGetter();
   }

std::string const & PrincipalGetAdapter::productInstanceLabel ( EDPutToken iToken ) const

Definition at line 344 of file PrincipalGetAdapter.cc.

References edm::EDPutToken::index(), prodBase_, and edm::ProductRegistryHelper::typeLabelList().

                                                                    {
     return prodBase_->typeLabelList()[iToken.index()].productInstanceName_;
   }

std::vector< edm::ProductResolverIndex > const & PrincipalGetAdapter::putTokenIndexToProductResolverIndex ( ) const

Definition at line 355 of file PrincipalGetAdapter.cc.

References prodBase_, and edm::ProducerBase::putTokenIndexToProductResolverIndex().

Referenced by edm::LuminosityBlock::commit_(), edm::Run::commit_(), edm::Event::commit_aux(), edm::Run::setProducer(), edm::LuminosityBlock::setProducer(), and edm::Event::setProducerCommon().

                                                                  {
     return prodBase_->putTokenIndexToProductResolverIndex();
   }

std::vector< bool > const & PrincipalGetAdapter::recordProvenanceList ( ) const

Definition at line 360 of file PrincipalGetAdapter.cc.

References prodBase_, and edm::ProductRegistryHelper::recordProvenanceList().

Referenced by edm::Event::commit_aux(), and edm::Event::setProducer().

                                                   {
     return prodBase_->recordProvenanceList();
   }

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

inline

Definition at line 146 of file PrincipalGetAdapter.h.

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

                                                       {
       consumer_ = iConsumer;
     }

void edm::PrincipalGetAdapter::setProducer ( ProducerBase const * iProd )

inline

Definition at line 154 of file PrincipalGetAdapter.h.

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

                                                 {
       prodBase_ = iProd;
     }

void edm::PrincipalGetAdapter::setSharedResourcesAcquirer ( SharedResourcesAcquirer * iSra )

inline

Definition at line 150 of file PrincipalGetAdapter.h.

Referenced by edm::LuminosityBlock::setSharedResourcesAcquirer(), and edm::Event::setSharedResourcesAcquirer().

                                                                    {
       resourcesAcquirer_ = iSra;
     }

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

private

Definition at line 159 of file PrincipalGetAdapter.cc.

References consumer_, cppFunctionSkipper::exception, tablePrinter::labels, edm::EDConsumerBase::labelsForToken(), edm::ProductLabels::module, edm::ProductLabels::process, and edm::ProductLabels::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;    
   }

void PrincipalGetAdapter::throwUnregisteredPutException	(	TypeID const &	type,
		std::string const &	productInstanceLabel
	)		const

private

Definition at line 253 of file PrincipalGetAdapter.cc.

References edm::ProductRegistry::allBranchDescriptions(), Exception, edm::TypeID::friendlyClassName(), edm::errors::InsertFailure, md_, edm::ModuleDescription::moduleLabel(), principal_, edm::ModuleDescription::processName(), edm::Principal::productRegistry(), and harvestTrackValidationPlots::str.

Referenced by getBranchDescription(), and getPutTokenIndex().

                                                                                                  {
     std::ostringstream str;
     for(auto branchDescription: principal_.productRegistry().allBranchDescriptions()) {
       if (branchDescription->moduleLabel() == md_.moduleLabel() and branchDescription->processName() == md_.processName()) {
         str << *branchDescription<< "-----\n";
       }
     }
     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 following data products are registered for production by "<<md_.moduleLabel()<<":\n"
     << str.str()
     << '\n'
     << "To correct the problem:\n"
     "   1) make sure the proper 'produce' call is being made in the module's constructor,\n"
     "   2) if 'produce' exists and uses a product instance name make sure that same name is used during the 'put' call.";
   }

Transition PrincipalGetAdapter::transition ( ) const

Definition at line 309 of file PrincipalGetAdapter.cc.

References edm::BeginLuminosityBlock, edm::BeginRun, branchType(), edm::EndLuminosityBlock, edm::EndRun, edm::Event, edm::InEvent, edm::InRun, isComplete(), likely, and principal().

Referenced by edm::LuminosityBlock::commit_(), edm::Run::commit_(), and getPutTokenIndex().

                                         {
     if(likely(principal().branchType() == InEvent)) {
       return Transition::Event;
     }
     if(principal().branchType() == InRun) {
       if(isComplete()) {
         return Transition::EndRun;
       } else {
         return Transition::BeginRun;
       }
     }
     if(isComplete()) {
       return Transition::EndLuminosityBlock;
     }
     return Transition::BeginLuminosityBlock;
     //Must be lumi
   }