edm::InputProductHolder Class Reference

#include <ProductHolder.h>

Inheritance diagram for edm::InputProductHolder:

Public Member Functions
	InputProductHolder (std::shared_ptr< BranchDescription const > bd)
bool	productIsUnavailable () const
void	setProduct (std::unique_ptr< WrapperBase > prod) const
void	setProductUnavailable () const
virtual	~InputProductHolder ()
Public Member Functions inherited from edm::ProductHolderBase
BranchDescription const &	branchDescription () const
void	checkType (WrapperBase const &prod) const
void	mergeProduct (std::unique_ptr< WrapperBase > edp, ProductProvenance const &productProvenance) const
void	mergeProduct (std::unique_ptr< WrapperBase > edp) const
void	mergeTheProduct (std::unique_ptr< WrapperBase > edp) const
std::string const &	moduleLabel () const
bool	onDemand () const
ProductHolderBase &	operator= (ProductHolderBase const &)=delete
std::string const &	processName () const
WrapperBase const *	product () const
WrapperBase *	product ()
ProductData const &	productData () const
ProductData &	productData ()
	ProductHolderBase ()
	ProductHolderBase (ProductHolderBase const &)=delete
ProductID const &	productID () const
std::string const &	productInstanceName () const
ProductProvenance const *	productProvenancePtr () const
TypeID	productType () const
bool	productUnavailable () const
bool	productWasDeleted () const
Provenance const *	provenance () const
bool	provenanceAvailable () const
bool	putOrMergeProduct () const
void	putProduct (std::unique_ptr< WrapperBase > edp, ProductProvenance const &productProvenance) const
void	putProduct (std::unique_ptr< WrapperBase > edp) const
void	reallyCheckType (WrapperBase const &prod) const
void	resetBranchDescription (std::shared_ptr< BranchDescription const > bd)
void	resetProductData ()
void	resetStatus ()
std::string const &	resolvedModuleLabel () const
ProductData const *	resolveProduct (ResolveStatus &resolveStatus, Principal const &principal, bool skipCurrentProcess, SharedResourcesAcquirer *sra, ModuleCallingContext const *mcc) const
void	setProcessHistory (ProcessHistory const &ph)
void	setProductDeleted ()
void	setProvenance (ProductProvenanceRetriever const *provRetriever, ProcessHistory const &ph, ProductID const &pid)
bool	singleProduct () const
void	swap (ProductHolderBase &rhs)
void	throwProductDeletedException () const
void	unsafe_deleteProduct () const
void	write (std::ostream &os) const
virtual	~ProductHolderBase ()

Private Member Functions
virtual BranchDescription const &	branchDescription_ () const override
virtual void	checkType_ (WrapperBase const &) const override
virtual ProductData const &	getProductData () const override
virtual ProductData &	getProductData () override
virtual void	mergeProduct_ (std::unique_ptr< WrapperBase > edp, ProductProvenance const &productProvenance) const override
virtual void	mergeProduct_ (std::unique_ptr< WrapperBase > edp) const override
virtual bool	onDemand_ () const override
virtual ProductProvenance const *	productProvenancePtr_ () const override
virtual bool	productUnavailable_ () const override
virtual bool	productWasDeleted_ () const override
virtual bool	putOrMergeProduct_ () const override
virtual void	putProduct_ (std::unique_ptr< WrapperBase > edp, ProductProvenance const &productProvenance) const override
virtual void	putProduct_ (std::unique_ptr< WrapperBase > edp) const override
virtual void	resetBranchDescription_ (std::shared_ptr< BranchDescription const > bd) override
virtual void	resetProductData_ () override
virtual void	resetStatus_ () override
virtual std::string const &	resolvedModuleLabel_ () const override
virtual ProductData const *	resolveProduct_ (ResolveStatus &resolveStatus, Principal const &principal, bool skipCurrentProcess, SharedResourcesAcquirer *sra, ModuleCallingContext const *mcc) const override
virtual void	setProcessHistory_ (ProcessHistory const &ph) override
virtual void	setProductDeleted_ () const override
virtual void	setProvenance_ (ProductProvenanceRetriever const *provRetriever, ProcessHistory const &ph, ProductID const &pid) override
virtual bool	singleProduct_ () const override
virtual void	swap_ (ProductHolderBase &rhs) override

Private Attributes
ProductData	productData_
bool	productHasBeenDeleted_
bool	productIsUnavailable_

Additional Inherited Members
Public Types inherited from edm::ProductHolderBase
enum	ResolveStatus { ProductFound, ProductNotFound, Ambiguous }

Detailed Description

Definition at line 211 of file ProductHolder.h.

Constructor & Destructor Documentation

edm::InputProductHolder::InputProductHolder ( std::shared_ptr< BranchDescription const >  bd )

inlineexplicit

Definition at line 213 of file ProductHolder.h.

                                                                           :
        ProductHolderBase(), productData_(bd), productIsUnavailable_(false),
        productHasBeenDeleted_(false) {}

edm::InputProductHolder::~InputProductHolder ( )

virtual

Definition at line 30 of file ProductHolder.cc.

{}

Member Function Documentation

virtual BranchDescription const& edm::InputProductHolder::branchDescription_ ( ) const

inlineoverrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 250 of file ProductHolder.h.

References edm::ProductData::branchDescription(), and edm::ProductHolderBase::productData().

{return *productData().branchDescription();}

virtual void edm::InputProductHolder::checkType_ ( WrapperBase const &  ) const

inlineoverrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 241 of file ProductHolder.h.

{}

virtual ProductData const& edm::InputProductHolder::getProductData ( ) const

inlineoverrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 247 of file ProductHolder.h.

References productData_.

{return productData_;}

virtual ProductData& edm::InputProductHolder::getProductData ( )

inlineoverrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 248 of file ProductHolder.h.

References productData_.

{return productData_;}

void edm::InputProductHolder::mergeProduct_ ( std::unique_ptr< WrapperBase >  edp, ProductProvenance const &  productProvenance  ) const

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 180 of file ProductHolder.cc.

References assert().

                                        {
    assert(nullptr);
  }

void edm::InputProductHolder::mergeProduct_ ( std::unique_ptr< WrapperBase >  edp ) const

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 187 of file ProductHolder.cc.

References edm::ProductHolderBase::mergeTheProduct(), and eostools::move().

                                                                        {
    mergeTheProduct(std::move(edp));
  }

virtual bool edm::InputProductHolder::onDemand_ ( ) const

inlineoverrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 244 of file ProductHolder.h.

{return false;}

bool edm::InputProductHolder::productIsUnavailable ( ) const

inline

Definition at line 222 of file ProductHolder.h.

References productIsUnavailable_.

Referenced by productUnavailable_().

{return productIsUnavailable_;}

ProductProvenance const * edm::InputProductHolder::productProvenancePtr_ ( ) const

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 246 of file ProductHolder.cc.

References edm::Provenance::productProvenance(), and edm::ProductHolderBase::provenance().

                                                                           {
    return provenance()->productProvenance();
  }

bool edm::InputProductHolder::productUnavailable_ ( ) const

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 263 of file ProductHolder.cc.

References edm::WrapperBase::isPresent(), edm::ProductHolderBase::product(), productIsUnavailable(), and setProductUnavailable().

                                                {
    if(productIsUnavailable()) {
      return true;
    }
    // If there is a product, we know if it is real or a dummy.
    if(product()) {
      bool unavailable = !(product()->isPresent());
      if(unavailable) {
        setProductUnavailable();
      }
      return unavailable;
    }
    return false;
  }

virtual bool edm::InputProductHolder::productWasDeleted_ ( ) const

inlineoverrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 246 of file ProductHolder.h.

References productHasBeenDeleted_.

{return productHasBeenDeleted_;}

bool edm::InputProductHolder::putOrMergeProduct_ ( ) const

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 192 of file ProductHolder.cc.

References edm::ProductHolderBase::product().

                                               {
    return(!product());
  }

void edm::InputProductHolder::putProduct_ ( std::unique_ptr< WrapperBase >  edp, ProductProvenance const &  productProvenance  ) const

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 172 of file ProductHolder.cc.

References assert(), eostools::move(), edm::ProductHolderBase::product(), and setProduct().

                                                          {
    assert(!product());
    setProduct(std::move(edp));
  }

void edm::InputProductHolder::putProduct_ ( std::unique_ptr< WrapperBase >  edp ) const

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 197 of file ProductHolder.cc.

References assert(), eostools::move(), edm::ProductHolderBase::product(), and setProduct().

                                                                      {
    assert(!product());
    setProduct(std::move(edp));
  }

virtual void edm::InputProductHolder::resetBranchDescription_ ( std::shared_ptr< BranchDescription const >  bd )

inlineoverrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 251 of file ProductHolder.h.

References edm::ProductHolderBase::productData(), and edm::ProductData::resetBranchDescription().

{productData().resetBranchDescription(bd);}

void edm::InputProductHolder::resetProductData_ ( )

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 250 of file ProductHolder.cc.

References edm::ProductHolderBase::productData(), edm::ProductData::resetProductData(), and edm::ProductHolderBase::resetStatus().

                                             {
    productData().resetProductData();
    resetStatus();
  }

virtual void edm::InputProductHolder::resetStatus_ ( )

inlineoverrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 242 of file ProductHolder.h.

References productHasBeenDeleted_, and productIsUnavailable_.

                                           {productIsUnavailable_ = false;
        productHasBeenDeleted_=false;}

virtual std::string const& edm::InputProductHolder::resolvedModuleLabel_ ( ) const

inlineoverrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 252 of file ProductHolder.h.

References edm::ProductHolderBase::moduleLabel().

{return moduleLabel();}

ProductData const * edm::InputProductHolder::resolveProduct_ ( ResolveStatus &  resolveStatus, Principal const &  principal, bool  skipCurrentProcess, SharedResourcesAcquirer *  sra, ModuleCallingContext const *  mcc  ) const

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 39 of file ProductHolder.cc.

References edm::ProductHolderBase::product(), productData_, edm::ProductHolderBase::ProductFound, edm::ProductHolderBase::ProductNotFound, edm::ProductHolderBase::productUnavailable(), edm::ProductHolderBase::productWasDeleted(), edm::Principal::readFromSource(), and edm::ProductHolderBase::throwProductDeletedException().

                                                                             {
    if(productWasDeleted()) {
      throwProductDeletedException();
    }
    if(!productUnavailable()) {
      principal.readFromSource(*this, mcc);
      // If the product is a dummy filler, product holder will now be marked unavailable.
      if(product() && !productUnavailable()) {
        // Found the match
        resolveStatus = ProductFound;
        return &productData_;
      }
    }
    resolveStatus = ProductNotFound;
    return nullptr;
  }

void edm::InputProductHolder::setProcessHistory_ ( ProcessHistory const &  ph )

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 242 of file ProductHolder.cc.

References edm::ProductHolderBase::productData(), and edm::ProductData::setProcessHistory().

                                                                      {
    productData().setProcessHistory(ph);
  }

void edm::InputProductHolder::setProduct

(

std::unique_ptr< WrapperBase >

prod

)

const

Definition at line 230 of file ProductHolder.cc.

References assert(), eostools::move(), edm::ProductHolderBase::product(), edm::ProductHolderBase::productData(), setProductUnavailable(), and edm::ProductData::unsafe_setWrapper().

Referenced by putProduct_().

                                                                      {
    assert (!product());
    if(prod.get() == nullptr || !prod->isPresent()) {
      setProductUnavailable();
    }
    productData().unsafe_setWrapper(std::move(prod));  // ProductHolder takes ownership
  }

virtual void edm::InputProductHolder::setProductDeleted_ ( ) const

inlineoverrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 249 of file ProductHolder.h.

References productHasBeenDeleted_.

{productHasBeenDeleted_ = true;}

void edm::InputProductHolder::setProductUnavailable ( ) const

inline

Definition at line 223 of file ProductHolder.h.

References productIsUnavailable_.

Referenced by productUnavailable_(), and setProduct().

{productIsUnavailable_ = true;}

void edm::InputProductHolder::setProvenance_ ( ProductProvenanceRetriever const *  provRetriever, ProcessHistory const &  ph, ProductID const &  pid  )

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 238 of file ProductHolder.cc.

References edm::ProductHolderBase::productData(), and edm::ProductData::setProvenance().

                                                                                                                                         {
    productData().setProvenance(provRetriever,ph,pid);
  }

bool edm::InputProductHolder::singleProduct_ ( ) const

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 255 of file ProductHolder.cc.

                                                {
    return true;
  }

virtual void edm::InputProductHolder::swap_ ( ProductHolderBase &  rhs )

inlineoverrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 226 of file ProductHolder.h.

References productData_, productIsUnavailable_, edm::swap(), and std::swap().

                                                          {
        InputProductHolder& other = dynamic_cast<InputProductHolder&>(rhs);
        edm::swap(productData_, other.productData_);
        std::swap(productIsUnavailable_, other.productIsUnavailable_);
      }

Member Data Documentation

ProductData edm::InputProductHolder::productData_

private

Definition at line 259 of file ProductHolder.h.

Referenced by getProductData(), resolveProduct_(), and swap_().

bool edm::InputProductHolder::productHasBeenDeleted_

mutableprivate

Definition at line 261 of file ProductHolder.h.

Referenced by productWasDeleted_(), resetStatus_(), and setProductDeleted_().

bool edm::InputProductHolder::productIsUnavailable_

mutableprivate

Definition at line 260 of file ProductHolder.h.

Referenced by productIsUnavailable(), resetStatus_(), setProductUnavailable(), and swap_().