#include "AssnsGroupWithData.h"

Inheritance diagram for art::AssnsGroupWithData:

Public Member Functions
	AssnsGroupWithData ()=default

bool	isReady () const override

EDProduct const *	getIt () const override

EDProduct const *	uniqueProduct () const override

bool	productUnavailable () const

cet::exempt_ptr< ProductProvenance const >	productProvenancePtr () const

BranchDescription const &	productDescription () const

std::string const &	moduleLabel () const

std::string const &	productInstanceName () const

std::string const &	processName () const

ProductStatus	status () const

void	setResolvers (BranchMapper const &bm, DelayedReader const &dr)

bool	resolveProduct (TypeID const &) const override

void	write (std::ostream &os) const

ProductID const &	productID () const

TypeID const &	producedWrapperType () const

RangeSet const &	rangeOfValidity () const

Protected Member Functions
	AssnsGroupWithData (BranchDescription const &pd, ProductID const &pid, RangeSet &&rs, TypeID const &primary_wrapper_type, TypeID const &partner_wrapper_type, TypeID const &base_wrapper_type, TypeID const &partner_base_wrapper_type, std::unique_ptr< EDProduct > &&edp=nullptr, cet::exempt_ptr< Worker > productProducer=cet::exempt_ptr< Worker >())

	AssnsGroupWithData (BranchDescription const &pd, ProductID const &pid, RangeSet &&rs, std::unique_ptr< EDProduct > &&edp, TypeID const &primary_wrapper_type, TypeID const &partner_wrapper_type, TypeID const &base_wrapper_type, TypeID const &partner_base_wrapper_type)

	AssnsGroupWithData (BranchDescription const &pd, ProductID const &pid, RangeSet &&rs, cet::exempt_ptr< Worker > productProducer, TypeID const &primary_wrapper_type, TypeID const &partner_wrapper_type, TypeID const &base_wrapper_type, TypeID const &partner_base_wrapper_type)

EDProduct const *	anyProduct () const override

EDProduct const *	uniqueProduct (TypeID const &wanted_wrapper_type) const override

bool	resolveProductIfAvailable (TypeID const &) const override

void	removeCachedProduct () const override

TypeID const &	partnerWrapperType () const

bool	makePartner (TypeID const &wanted_wrapper_type, std::unique_ptr< EDProduct > &partner) const

std::unique_ptr< EDProduct >	obtainDesiredProduct (TypeID const &) const

void	setProduct (std::unique_ptr< EDProduct > &&prod) const

void	throwResolveLogicError (TypeID const &wanted_wrapper_type) const

Private Attributes
TypeID	baseWrapperType_

TypeID	partnerBaseWrapperType_

std::unique_ptr< EDProduct >	baseProduct_

std::unique_ptr< EDProduct >	partnerBaseProduct_

Friends
template<typename... ARGS>
std::unique_ptr< Group >	gfactory::detail::make_group (BranchDescription const &, ARGS &&...args)

Detailed Description

Definition at line 14 of file AssnsGroupWithData.h.

Constructor & Destructor Documentation

art::AssnsGroupWithData::AssnsGroupWithData ( )

default

art::AssnsGroupWithData::AssnsGroupWithData	(	BranchDescription const &	pd,
		ProductID const &	pid,
		RangeSet &&	rs,
		TypeID const &	primary_wrapper_type,
		TypeID const &	partner_wrapper_type,
		TypeID const &	base_wrapper_type,
		TypeID const &	partner_base_wrapper_type,
		std::unique_ptr< EDProduct > &&	edp = `nullptr`,
		cet::exempt_ptr< Worker >	productProducer = `cet::exempt_ptr<Worker>()`
	)

inlineprotected

Definition at line 26 of file AssnsGroupWithData.h.

References baseProduct_, partnerBaseProduct_, and partnerBaseWrapperType_.

     : AssnsGroup(pd,
                  pid,
                  std::move(rs),
                  primary_wrapper_type,
                  partner_wrapper_type,
                  std::move(edp),
                  productProducer)
     , baseWrapperType_{base_wrapper_type}
     , partnerBaseWrapperType_{partner_base_wrapper_type}
     , baseProduct_{}
     , partnerBaseProduct_{}
   {}

art::AssnsGroupWithData::AssnsGroupWithData	(	BranchDescription const &	pd,
		ProductID const &	pid,
		RangeSet &&	rs,
		std::unique_ptr< EDProduct > &&	edp,
		TypeID const &	primary_wrapper_type,
		TypeID const &	partner_wrapper_type,
		TypeID const &	base_wrapper_type,
		TypeID const &	partner_base_wrapper_type
	)

inlineprotected

Definition at line 49 of file AssnsGroupWithData.h.

     : AssnsGroupWithData(pd,
                          pid,
                          std::move(rs),
                          primary_wrapper_type,
                          partner_wrapper_type,
                          base_wrapper_type,
                          partner_base_wrapper_type,
                          std::move(edp))
   {}

art::AssnsGroupWithData::AssnsGroupWithData	(	BranchDescription const &	pd,
		ProductID const &	pid,
		RangeSet &&	rs,
		cet::exempt_ptr< Worker >	productProducer,
		TypeID const &	primary_wrapper_type,
		TypeID const &	partner_wrapper_type,
		TypeID const &	base_wrapper_type,
		TypeID const &	partner_base_wrapper_type
	)

inlineprotected

Definition at line 67 of file AssnsGroupWithData.h.

References anyProduct(), removeCachedProduct(), resolveProductIfAvailable(), and art::AssnsGroup::uniqueProduct().

     : AssnsGroupWithData(pd,
                          pid,
                          std::move(rs),
                          primary_wrapper_type,
                          partner_wrapper_type,
                          base_wrapper_type,
                          partner_base_wrapper_type,
                          nullptr,
                          productProducer)
   {}

Member Function Documentation

art::EDProduct const * art::AssnsGroupWithData::anyProduct ( ) const

overrideprotectedvirtual

Reimplemented from art::AssnsGroup.

Definition at line 4 of file AssnsGroupWithData.cc.

References art::AssnsGroup::anyProduct(), baseProduct_, and partnerBaseProduct_.

Referenced by AssnsGroupWithData().

 {
   art::EDProduct const* result = AssnsGroup::anyProduct();
   if (result == nullptr) {
     if ((result = baseProduct_.get()) == nullptr) {
       result = partnerBaseProduct_.get();
     }
   }
   return result;
 }

art::EDProduct const * art::AssnsGroup::getIt ( ) const

overridevirtualinherited

Implements art::EDProductGetter.

Definition at line 7 of file AssnsGroup.cc.

References art::AssnsGroup::uniqueProduct().

Referenced by art::AssnsGroup::isReady().

 {
   return uniqueProduct();
 }

bool art::AssnsGroup::isReady ( ) const

inlineoverridevirtualinherited

Implements art::EDProductGetter.

Definition at line 77 of file AssnsGroup.h.

References art::AssnsGroup::anyProduct(), art::AssnsGroup::getIt(), art::AssnsGroup::removeCachedProduct(), art::AssnsGroup::resolveProductIfAvailable(), and art::AssnsGroup::uniqueProduct().

     {
       return true;
     }

bool art::AssnsGroup::makePartner	(	TypeID const &	wanted_wrapper_type,
		std::unique_ptr< EDProduct > &	partner
	)		const

inlineprotectedinherited

Definition at line 103 of file AssnsGroup.h.

References art::EDProduct::makePartner(), art::TypeID::typeInfo(), and art::Group::uniqueProduct().

Referenced by art::AssnsGroup::resolveProductIfAvailable(), and resolveProductIfAvailable().

     {
       bool result;
       auto edp =
         Group::uniqueProduct()->makePartner(wanted_wrapper_type.typeInfo());
       if ((result = edp.get())) {
         partner = std::move(edp);
       }
       return result;
     }

std::string const& art::Group::moduleLabel ( ) const

inlineinherited

Definition at line 123 of file Group.h.

References art::Group::branchDescription_.

     {
       return branchDescription_->moduleLabel();
     }

std::unique_ptr< art::EDProduct > art::Group::obtainDesiredProduct ( TypeID const & wanted_wrapper_type ) const

protectedinherited

Definition at line 76 of file Group.cc.

References art::Group::productDescription(), art::Group::productResolver_, and art::Group::rangeOfValidity_.

Referenced by art::Group::rangeOfValidity(), and art::Group::resolveProductIfAvailable().

 {
   BranchKey const bk{productDescription()};
   return productResolver_->getProduct(
     bk, wanted_wrapper_type, rangeOfValidity_);
 }

TypeID const& art::AssnsGroup::partnerWrapperType ( ) const

inlineprotectedinherited

Definition at line 97 of file AssnsGroup.h.

References art::AssnsGroup::partnerWrapperType_.

Referenced by resolveProductIfAvailable().

     {
       return partnerWrapperType_;
     }

std::string const& art::Group::processName ( ) const

inlineinherited

Definition at line 135 of file Group.h.

References art::Group::branchDescription_, and art::Group::status().

     {
       return branchDescription_->processName();
     }

TypeID const& art::Group::producedWrapperType ( ) const

inlineinherited

Definition at line 162 of file Group.h.

References art::Group::removeCachedProduct(), and art::Group::wrapperType_.

Referenced by art::Group::getIt(), art::detail::PrincipalProcessor< DETAIL >::operator()(), art::AssnsGroup::resolveProductIfAvailable(), and resolveProductIfAvailable().

     {
       return wrapperType_;
     }

BranchDescription const& art::Group::productDescription ( ) const

inlineinherited

Definition at line 117 of file Group.h.

References art::Group::branchDescription_.

Referenced by art::Group::obtainDesiredProduct(), and art::Group::resolveProduct().

     {
       return *branchDescription_;
     }

ProductID const& art::Group::productID ( ) const

inlineinherited

Definition at line 156 of file Group.h.

References art::Group::pid_.

     {
       return pid_;
     };

std::string const& art::Group::productInstanceName ( ) const

inlineinherited

Definition at line 129 of file Group.h.

References art::Group::branchDescription_.

     {
       return branchDescription_->productInstanceName();
     }

cet::exempt_ptr< art::ProductProvenance const > art::Group::productProvenancePtr ( ) const

inherited

Definition at line 96 of file Group.cc.

References art::Group::branchDescription_, and art::Group::ppResolver_.

Referenced by art::detail::PrincipalProcessor< DETAIL >::operator()(), art::Group::resolveProduct(), art::Group::status(), and art::Group::uniqueProduct().

 {
   if (!ppResolver_) {
     return cet::exempt_ptr<ProductProvenance const>{};
   }
   return ppResolver_->branchToProductProvenance(
     branchDescription_->productID());
 }

bool art::Group::productUnavailable ( ) const

inherited

Definition at line 84 of file Group.cc.

References art::Group::dropped(), art::productstatus::present(), art::Group::status(), and art::productstatus::unknown().

Referenced by art::Group::Group(), art::Group::resolveProduct(), art::AssnsGroup::resolveProductIfAvailable(), resolveProductIfAvailable(), and art::Group::resolveProductIfAvailable().

 {
   if (dropped()) {
     return true;
   }
   if (productstatus::unknown(status())) {
     return false;
   }
   return !productstatus::present(status());
 }

RangeSet const& art::Group::rangeOfValidity ( ) const

inlineinherited

Definition at line 170 of file Group.h.

References art::Group::dropped(), art::Group::obtainDesiredProduct(), art::Group::rangeOfValidity_, art::Group::setProduct(), and art::Group::throwResolveLogicError().

     {
       return rangeOfValidity_;
     }

void art::AssnsGroupWithData::removeCachedProduct ( ) const

overrideprotectedvirtual

Reimplemented from art::AssnsGroup.

Definition at line 60 of file AssnsGroupWithData.cc.

References baseProduct_, partnerBaseProduct_, and art::AssnsGroup::removeCachedProduct().

Referenced by AssnsGroupWithData().

 {
   AssnsGroup::removeCachedProduct();
   baseProduct_.reset();
   partnerBaseProduct_.reset();
 }

bool art::Group::resolveProduct ( TypeID const & wanted_wrapper_type ) const

overridevirtualinherited

Implements art::EDProductGetter.

Definition at line 45 of file Group.cc.

References e, art::Group::productDescription(), art::errors::ProductNotFound, art::Group::productProvenancePtr(), art::Group::productUnavailable(), and art::Group::resolveProductIfAvailable().

Referenced by art::detail::PrincipalProcessor< DETAIL >::operator()(), and art::Group::setResolvers().

 {
   if (!productUnavailable()) {
     return resolveProductIfAvailable(wanted_wrapper_type);
   }
   art::Exception e{errors::ProductNotFound, "InaccessibleProduct"};
   e << "resolveProduct: product is not accessible\n"
     << productDescription() << '\n';
   if (productProvenancePtr()) {
     e << *productProvenancePtr() << '\n';
   }
   throw e;
 }

bool art::AssnsGroupWithData::resolveProductIfAvailable ( TypeID const & wanted_wrapper_type ) const

overrideprotectedvirtual

Reimplemented from art::AssnsGroup.

Definition at line 30 of file AssnsGroupWithData.cc.

References baseProduct_, baseWrapperType_, art::AssnsGroup::makePartner(), partnerBaseProduct_, partnerBaseWrapperType_, art::AssnsGroup::partnerWrapperType(), art::Group::producedWrapperType(), art::Group::productUnavailable(), art::AssnsGroup::resolveProductIfAvailable(), art::Group::throwResolveLogicError(), and art::AssnsGroup::uniqueProduct().

Referenced by AssnsGroupWithData().

 {
   // Prerequisite: ask us for something we can do.
   if (!(wanted_wrapper_type == producedWrapperType() ||
         wanted_wrapper_type == partnerWrapperType() ||
         wanted_wrapper_type == baseWrapperType_ ||
         wanted_wrapper_type == partnerBaseWrapperType_)) {
     throwResolveLogicError(wanted_wrapper_type);
   }
 
   TypeID const& upstream_wrapper_type =
     (wanted_wrapper_type == partnerBaseWrapperType_ ||
      wanted_wrapper_type == partnerWrapperType()) ?
       partnerWrapperType() :
       producedWrapperType();
   bool result = AssnsGroup::resolveProductIfAvailable(upstream_wrapper_type);
   if (!(productUnavailable() ||
         (result = uniqueProduct(wanted_wrapper_type))) &&
       AssnsGroup::uniqueProduct(upstream_wrapper_type)) {
     if (wanted_wrapper_type == baseWrapperType_) {
       result = makePartner(wanted_wrapper_type, baseProduct_);
     } else if (wanted_wrapper_type == partnerBaseWrapperType_) {
       result = makePartner(wanted_wrapper_type, partnerBaseProduct_);
     }
   }
   return result;
 }

void art::Group::setProduct ( std::unique_ptr< EDProduct > && prod ) const

protectedinherited

Definition at line 116 of file Group.cc.

References art::Group::product_.

Referenced by art::Group::rangeOfValidity(), and art::Group::resolveProductIfAvailable().

 {
   assert(!product_.get());
   product_ = std::move(prod);
 }

void art::Group::setResolvers	(	BranchMapper const &	bm,
		DelayedReader const &	dr
	)

inlineinherited

Definition at line 143 of file Group.h.

References art::Group::ppResolver_, art::Group::productResolver_, art::Group::resolveProduct(), art::Group::resolveProductIfAvailable(), and art::Group::write().

     {
       ppResolver_.reset(&bm);
       productResolver_.reset(&dr);
     }

art::ProductStatus art::Group::status ( ) const

inherited

Definition at line 14 of file Group.cc.

References art::productstatus::dropped(), art::Group::dropped(), art::productstatus::neverCreated(), art::productstatus::present(), art::Group::product_, art::Group::productProvenancePtr(), and art::productstatus::unknown().

Referenced by art::Group::processName(), and art::Group::productUnavailable().

 {
   if (dropped()) {
     return productstatus::dropped();
   }
   cet::exempt_ptr<ProductProvenance const> pp(productProvenancePtr());
   if (!pp) {
     // No provenance, must be new.
     if (product_.get()) {
       if (product_->isPresent()) {
         return productstatus::present();
       }
       return productstatus::neverCreated();
     }
     return productstatus::unknown();
   }
   if (product_.get()) {
     // Product has already been delay read, use the present flag
     // from the wrapper.
     // FIXME: Old CMS note said backward compatibility only?
     if (product_->isPresent()) {
       pp->setPresent();
     } else {
       pp->setNotPresent();
     }
   }
   // Not new, and not yet read, use the status from the provenance.
   return pp->productStatus();
 }

void art::Group::throwResolveLogicError ( TypeID const & wanted_wrapper_type ) const

protectedinherited

Definition at line 123 of file Group.cc.

References art::TypeID::className(), and art::errors::LogicError.

Referenced by art::Group::rangeOfValidity(), art::AssnsGroup::resolveProductIfAvailable(), resolveProductIfAvailable(), and art::Group::resolveProductIfAvailable().

 {
   throw Exception(errors::LogicError, "INTERNAL ERROR: ")
     << cet::demangle_symbol(typeid(*this).name())
     << " cannot resolve wanted product of type "
     << wanted_wrapper_type.className() << ".\n";
 }

art::EDProduct const * art::AssnsGroup::uniqueProduct ( ) const

overridevirtualinherited

Implements art::EDProductGetter.

Definition at line 23 of file AssnsGroup.cc.

References art::errors::LogicError.

Referenced by AssnsGroupWithData(), art::AssnsGroup::getIt(), art::AssnsGroup::isReady(), art::AssnsGroup::resolveProductIfAvailable(), resolveProductIfAvailable(), and uniqueProduct().

 {
   throw Exception(errors::LogicError, "AmbiguousProduct")
     << cet::demangle_symbol(typeid(*this).name())
     << " was asked for a held product (uniqueProduct()) "
     << "without specifying which one was wanted.\n";
 }

art::EDProduct const * art::AssnsGroupWithData::uniqueProduct ( TypeID const & wanted_wrapper_type ) const

overrideprotectedvirtual

Reimplemented from art::AssnsGroup.

Definition at line 16 of file AssnsGroupWithData.cc.

References baseProduct_, baseWrapperType_, partnerBaseProduct_, partnerBaseWrapperType_, and art::AssnsGroup::uniqueProduct().

 {
   EDProduct const* retval = nullptr;
   if (wanted_wrapper_type == partnerBaseWrapperType_) {
     retval = partnerBaseProduct_.get();
   } else if (wanted_wrapper_type == baseWrapperType_) {
     retval = baseProduct_.get();
   } else {
     retval = AssnsGroup::uniqueProduct(wanted_wrapper_type);
   }
   return retval;
 }

void art::Group::write ( std::ostream & os ) const

inherited

Definition at line 139 of file Group.cc.

References art::Group::pid_.

Referenced by art::operator<<(), and art::Group::setResolvers().

 {
   // This is grossly inadequate. It is also not critical for the
   // first pass.
   os << "Group for product with ID: " << pid_;
 }

Friends And Related Function Documentation

template<typename... ARGS>

std::unique_ptr<Group> gfactory::detail::make_group	(	BranchDescription const &	,
		ARGS &&...	args
	)

friend

Member Data Documentation

std::unique_ptr<EDProduct> art::AssnsGroupWithData::baseProduct_

mutableprivate

Definition at line 100 of file AssnsGroupWithData.h.

Referenced by anyProduct(), AssnsGroupWithData(), removeCachedProduct(), resolveProductIfAvailable(), and uniqueProduct().

TypeID art::AssnsGroupWithData::baseWrapperType_

private

Definition at line 98 of file AssnsGroupWithData.h.

Referenced by resolveProductIfAvailable(), and uniqueProduct().

std::unique_ptr<EDProduct> art::AssnsGroupWithData::partnerBaseProduct_

mutableprivate

Definition at line 101 of file AssnsGroupWithData.h.

Referenced by anyProduct(), AssnsGroupWithData(), removeCachedProduct(), resolveProductIfAvailable(), and uniqueProduct().

TypeID art::AssnsGroupWithData::partnerBaseWrapperType_

private

Definition at line 99 of file AssnsGroupWithData.h.

Referenced by AssnsGroupWithData(), resolveProductIfAvailable(), and uniqueProduct().

The documentation for this class was generated from the following files:

art/Framework/Principal/AssnsGroupWithData.h
art/Framework/Principal/AssnsGroupWithData.cc

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation