edm::ProducedProductHolder Class Reference

#include <ProductHolder.h>

Inheritance diagram for edm::ProducedProductHolder:

Public Types
enum	ProductStatus {   Present = 0, NotRun = 3, NotCompleted = 4, NotPut = 5,   UnscheduledNotRun = 6, ProductDeleted =7, Uninitialized = 0xff }
Public Types inherited from edm::ProductHolderBase
enum	ResolveStatus { ProductFound, ProductNotFound, Ambiguous }

Public Member Functions
	ProducedProductHolder ()
void	producerCompleted ()
void	producerStarted ()
ProductStatus &	status () const
virtual	~ProducedProductHolder ()
Public Member Functions inherited from edm::ProductHolderBase
BranchDescription const &	branchDescription () const
void	checkType (WrapperBase const &prod) const
void	deleteProduct ()
void	mergeProduct (std::unique_ptr< WrapperBase > edp, ProductProvenance &productProvenance)
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 *	product () const
ProductData const &	productData () const
ProductData &	productData ()
	ProductHolderBase ()
	ProductHolderBase (ProductHolderBase const &)=delete
ProductID const &	productID () const
std::string const &	productInstanceName () const
ProductProvenance *	productProvenancePtr () const
TypeID	productType () const
bool	productUnavailable () const
bool	productWasDeleted () const
Provenance *	provenance () const
bool	provenanceAvailable () const
bool	putOrMergeProduct () const
void	putProduct (std::unique_ptr< WrapperBase > edp, ProductProvenance const &productProvenance)
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, bool skipCurrentProcess, ModuleCallingContext const *mcc) const
void	setPrincipal (Principal *principal)
void	setProcessHistory (ProcessHistory const &ph)
void	setProductDeleted ()
void	setProductProvenance (ProductProvenance const &prov) const
void	setProvenance (std::shared_ptr< ProductProvenanceRetriever > provRetriever, ProcessHistory const &ph, ProductID const &pid)
bool	singleProduct () const
void	swap (ProductHolderBase &rhs)
void	throwProductDeletedException () const
void	write (std::ostream &os) const
virtual	~ProductHolderBase ()

Private Member Functions
virtual BranchDescription const &	branchDescription_ () const override
virtual void	checkType_ (WrapperBase const &prod) const override
virtual void	mergeProduct_ (std::unique_ptr< WrapperBase > edp, ProductProvenance &productProvenance) override
virtual void	mergeProduct_ (std::unique_ptr< WrapperBase > edp) const override
virtual ProductProvenance *	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) 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 std::string const &	resolvedModuleLabel_ () const override
virtual void	setPrincipal_ (Principal *principal) override
virtual void	setProcessHistory_ (ProcessHistory const &ph) override
virtual void	setProductDeleted_ () override
virtual void	setProvenance_ (std::shared_ptr< ProductProvenanceRetriever > provRetriever, ProcessHistory const &ph, ProductID const &pid) override
virtual bool	singleProduct_ () const override
virtual ProductStatus &	status_ () const =0

Detailed Description

Definition at line 263 of file ProductHolder.h.

Member Enumeration Documentation

enum edm::ProducedProductHolder::ProductStatus

Enumerator
Present
NotRun
NotCompleted
NotPut
UnscheduledNotRun
ProductDeleted
Uninitialized

Definition at line 265 of file ProductHolder.h.

                       {
      Present = 0,
      NotRun = 3,
      NotCompleted = 4,
      NotPut = 5,
      UnscheduledNotRun = 6,
      ProductDeleted =7,
      Uninitialized = 0xff
    };

Constructor & Destructor Documentation

edm::ProducedProductHolder::ProducedProductHolder ( )

inline

Definition at line 274 of file ProductHolder.h.

: ProductHolderBase() {}

edm::ProducedProductHolder::~ProducedProductHolder ( )

virtual

Definition at line 31 of file ProductHolder.cc.

{}

Member Function Documentation

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

inlineoverrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 292 of file ProductHolder.h.

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

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

virtual void edm::ProducedProductHolder::checkType_ ( WrapperBase const &  prod ) const

inlineoverrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 285 of file ProductHolder.h.

References edm::ProductHolderBase::reallyCheckType().

                                                                      {
        reallyCheckType(prod);
      }

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

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 131 of file ProductHolder.cc.

References assert(), edm::ProductHolderBase::mergeTheProduct(), Present, edm::ProductHolderBase::provenance(), edm::ProductHolderBase::setProductProvenance(), and status().

                                              {
    assert(provenance()->productProvenanceValid());
    assert(status() == Present);
    setProductProvenance(productProvenance);
    mergeTheProduct(std::move(edp));
  }

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

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 146 of file ProductHolder.cc.

References assert(), edm::ProductHolderBase::mergeTheProduct(), Present, and status().

                                                                           {
    assert(status() == Present);
    mergeTheProduct(std::move(edp));
  }

void edm::ProducedProductHolder::producerCompleted

(

)

void edm::ProducedProductHolder::producerStarted

(

)

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

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 319 of file ProductHolder.cc.

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

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

bool edm::ProducedProductHolder::productUnavailable_ ( ) const

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 290 of file ProductHolder.cc.

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

                                                   {
    // If unscheduled production, the product is potentially available.
    if(onDemand()) return false;
    // The product is available if and only if a product has been put.
    bool unavailable = !(product() && product()->isPresent());
    return unavailable;
  }

bool edm::ProducedProductHolder::productWasDeleted_ ( ) const

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 300 of file ProductHolder.cc.

References ProductDeleted, and status().

                                                  {
    return status() == ProductDeleted;
  }

bool edm::ProducedProductHolder::putOrMergeProduct_ ( ) const

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 141 of file ProductHolder.cc.

References edm::ProductHolderBase::productUnavailable().

                                                  {
    return productUnavailable();
  }

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

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 112 of file ProductHolder.cc.

References assert(), edm::ProductHolderBase::branchDescription(), edm::BranchDescription::branchName(), Exception, edm::errors::InsertFailure, Present, edm::es::produced, edm::ProductHolderBase::product(), edm::ProductHolderBase::productData(), edm::ProductHolderBase::provenance(), edm::ProductHolderBase::setProductProvenance(), status(), status_(), Uninitialized, and edm::ProductData::wrapper_.

                                                    {
    if(product()) {
      throw Exception(errors::InsertFailure)
          << "Attempt to insert more than one product on branch " << branchDescription().branchName() << "\n";
    }
    assert(branchDescription().produced());
    assert(edp.get() != nullptr);
    assert(!provenance()->productProvenanceValid());
    assert(status() != Present);
    assert(status() != Uninitialized);
    setProductProvenance(productProvenance);
    assert(provenance()->productProvenanceValid());
    productData().wrapper_ = std::move(edp); // ProductHolder takes ownership
    status_() = Present;
  }

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

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 152 of file ProductHolder.cc.

References assert(), edm::ProductHolderBase::branchDescription(), edm::BranchDescription::branchName(), Exception, edm::errors::InsertFailure, Present, edm::es::produced, edm::ProductHolderBase::product(), edm::ProductHolderBase::productData(), status(), status_(), Uninitialized, and edm::ProductData::wrapper_.

                                                                         {
    if(product()) {
      throw Exception(errors::InsertFailure)
          << "Attempt to insert more than one product on branch " << branchDescription().branchName() << "\n";
    }
    assert(branchDescription().produced());
    assert(edp.get() != nullptr);
    assert(status() != Present);
    assert(status() != Uninitialized);
    productData().wrapper_ = std::move(edp);  // ProductHolder takes ownership
    status_() = Present;
  }

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

inlineoverrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 293 of file ProductHolder.h.

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

{productData().resetBranchDescription(bd);}

void edm::ProducedProductHolder::resetProductData_ ( )

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 323 of file ProductHolder.cc.

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

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

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

inlineoverrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 294 of file ProductHolder.h.

References edm::ProductHolderBase::moduleLabel().

{return moduleLabel();}

void edm::ProducedProductHolder::setPrincipal_ ( Principal *  principal )

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 332 of file ProductHolder.cc.

References Exception, and edm::errors::LogicError.

                                                      {
    throw Exception(errors::LogicError)
      << "ProducedProductHolder::setPrincipal__() not implemented and should never be called.\n"
      << "Contact a Framework developer\n";
  }

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

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 315 of file ProductHolder.cc.

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

                                                                         {
    productData().prov_.setProcessHistory(ph);
  }

void edm::ProducedProductHolder::setProductDeleted_ ( )

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 305 of file ProductHolder.cc.

References ProductDeleted, and status().

                                            {
    status() = ProductDeleted;
  }

void edm::ProducedProductHolder::setProvenance_ ( std::shared_ptr< ProductProvenanceRetriever >  provRetriever, ProcessHistory const &  ph, ProductID const &  pid  )

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 309 of file ProductHolder.cc.

References edm::ProductHolderBase::productData(), edm::ProductData::prov_, edm::Provenance::setProcessHistory(), edm::Provenance::setProductID(), and edm::Provenance::setStore().

                                                                                                                                                    {
    productData().prov_.setProductID(pid);
    productData().prov_.setStore(provRetriever);
    productData().prov_.setProcessHistory(ph);
  }

bool edm::ProducedProductHolder::singleProduct_ ( ) const

overrideprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 328 of file ProductHolder.cc.

                                                   {
    return true;
  }

ProductStatus& edm::ProducedProductHolder::status ( void  ) const

inline

Definition at line 278 of file ProductHolder.h.

References status_().

Referenced by mergeProduct_(), edm::UnscheduledProductHolder::onDemand_(), productWasDeleted_(), putProduct_(), setProductDeleted_(), and edm::AliasProductHolder::status().

{return status_();}

virtual ProductStatus& edm::ProducedProductHolder::status_ ( ) const

privatepure virtual

Implemented in edm::SourceProductHolder, edm::UnscheduledProductHolder, and edm::ScheduledProductHolder.

Referenced by putProduct_(), and status().