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 (WrapperOwningHolder const &prod) const
void	deleteProduct ()
void	mergeProduct (WrapperOwningHolder const &edp, ProductProvenance &productProvenance)
void	mergeProduct (WrapperOwningHolder const &edp) const
void	mergeTheProduct (WrapperOwningHolder const &edp) const
std::string const &	moduleLabel () const
bool	onDemand () const
ProductHolderBase &	operator= (ProductHolderBase const &)=delete
std::string const &	processName () const
boost::shared_ptr< void const >	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 (WrapperOwningHolder const &edp, ProductProvenance const &productProvenance)
void	putProduct (WrapperOwningHolder const &edp) const
void	reallyCheckType (WrapperOwningHolder const &prod) const
void	resetBranchDescription (boost::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 (boost::shared_ptr< ProductProvenanceRetriever > provRetriever, ProcessHistory const &ph, ProductID const &pid)
bool	singleProduct () const
void	swap (ProductHolderBase &rhs)
void	throwProductDeletedException () const
WrapperHolder	wrapper () const
void	write (std::ostream &os) const
virtual	~ProductHolderBase ()

Private Member Functions
virtual BranchDescription const &	branchDescription_ () const
virtual void	checkType_ (WrapperOwningHolder const &prod) const
virtual void	mergeProduct_ (WrapperOwningHolder const &edp, ProductProvenance &productProvenance)
virtual void	mergeProduct_ (WrapperOwningHolder const &edp) const
virtual ProductProvenance *	productProvenancePtr_ () const
virtual bool	productUnavailable_ () const
virtual bool	productWasDeleted_ () const
virtual bool	putOrMergeProduct_ () const
virtual void	putProduct_ (WrapperOwningHolder const &edp, ProductProvenance const &productProvenance)
virtual void	putProduct_ (WrapperOwningHolder const &edp) const
virtual void	resetBranchDescription_ (boost::shared_ptr< BranchDescription const > bd)
virtual void	resetProductData_ ()
virtual std::string const &	resolvedModuleLabel_ () const
virtual void	setPrincipal_ (Principal *principal)
virtual void	setProcessHistory_ (ProcessHistory const &ph)
virtual void	setProductDeleted_ ()
virtual void	setProvenance_ (boost::shared_ptr< ProductProvenanceRetriever > provRetriever, ProcessHistory const &ph, ProductID const &pid)
virtual bool	singleProduct_ () const
virtual ProductStatus &	status_ () const =0

Detailed Description

Definition at line 268 of file ProductHolder.h.

Member Enumeration Documentation

enum edm::ProducedProductHolder::ProductStatus

Enumerator
Present
NotRun
NotCompleted
NotPut
UnscheduledNotRun
ProductDeleted
Uninitialized

Definition at line 270 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 279 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

inlineprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 297 of file ProductHolder.h.

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

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

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

inlineprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 290 of file ProductHolder.h.

References edm::ProductHolderBase::reallyCheckType().

                                                                     {
        reallyCheckType(prod);
      }

void edm::ProducedProductHolder::mergeProduct_ ( WrapperOwningHolder const &  edp, ProductProvenance &  productProvenance  )

privatevirtual

Implements edm::ProductHolderBase.

Definition at line 134 of file ProductHolder.cc.

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

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

void edm::ProducedProductHolder::mergeProduct_ ( WrapperOwningHolder const &  edp ) const

privatevirtual

Implements edm::ProductHolderBase.

Definition at line 149 of file ProductHolder.cc.

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

                                                                           {
    assert(status() == Present);
    mergeTheProduct(edp);
  }

void edm::ProducedProductHolder::producerCompleted

(

)

void edm::ProducedProductHolder::producerStarted

(

)

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

privatevirtual

Implements edm::ProductHolderBase.

Definition at line 326 of file ProductHolder.cc.

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

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

bool edm::ProducedProductHolder::productUnavailable_ ( ) const

privatevirtual

Implements edm::ProductHolderBase.

Definition at line 297 of file ProductHolder.cc.

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

                                                   {
    // 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() && wrapper().isPresent());
    return unavailable;
  }

bool edm::ProducedProductHolder::productWasDeleted_ ( ) const

privatevirtual

Implements edm::ProductHolderBase.

Definition at line 307 of file ProductHolder.cc.

References ProductDeleted, and status().

                                                  {
    return status() == ProductDeleted;
  }

bool edm::ProducedProductHolder::putOrMergeProduct_ ( ) const

privatevirtual

Implements edm::ProductHolderBase.

Definition at line 144 of file ProductHolder.cc.

References edm::ProductHolderBase::productUnavailable().

                                                  {
    return productUnavailable();
  }

void edm::ProducedProductHolder::putProduct_ ( WrapperOwningHolder const &  edp, ProductProvenance const &  productProvenance  )

privatevirtual

Implements edm::ProductHolderBase.

Definition at line 112 of file ProductHolder.cc.

References edm::ProductHolderBase::branchDescription(), edm::BranchDescription::branchName(), edm::hlt::Exception, edm::errors::InsertFailure, edm::WrapperHolder::interface(), edm::WrapperHolder::isValid(), Present, edm::es::produced, edm::WrapperOwningHolder::product(), 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.isValid());
    assert(!provenance()->productProvenanceValid());
    assert(status() != Present);
    assert(status() != Uninitialized);
    setProductProvenance(productProvenance);
    assert(provenance()->productProvenanceValid());
    if(productData().getInterface() != 0) {
      assert(productData().getInterface()->sameType(*edp.interface()));
    }
    productData().wrapper_ = edp.product();
    status_() = Present;
  }

void edm::ProducedProductHolder::putProduct_ ( WrapperOwningHolder const &  edp ) const

privatevirtual

Implements edm::ProductHolderBase.

Definition at line 155 of file ProductHolder.cc.

References edm::ProductHolderBase::branchDescription(), edm::BranchDescription::branchName(), edm::hlt::Exception, edm::errors::InsertFailure, edm::WrapperHolder::interface(), edm::WrapperHolder::isValid(), Present, edm::es::produced, edm::WrapperOwningHolder::product(), 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.isValid());
    assert(status() != Present);
    assert(status() != Uninitialized);
    if(productData().getInterface() != 0) {
      assert(productData().getInterface()->sameType(*edp.interface()));
    }
    productData().wrapper_ = edp.product();
    status_() = Present;
  }

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

inlineprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 298 of file ProductHolder.h.

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

{productData().resetBranchDescription(bd);}

void edm::ProducedProductHolder::resetProductData_ ( )

privatevirtual

Implements edm::ProductHolderBase.

Definition at line 330 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

inlineprivatevirtual

Implements edm::ProductHolderBase.

Definition at line 299 of file ProductHolder.h.

References edm::ProductHolderBase::moduleLabel().

{return moduleLabel();}

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

privatevirtual

Implements edm::ProductHolderBase.

Definition at line 339 of file ProductHolder.cc.

References edm::hlt::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 )

privatevirtual

Implements edm::ProductHolderBase.

Definition at line 322 of file ProductHolder.cc.

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

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

void edm::ProducedProductHolder::setProductDeleted_ ( )

privatevirtual

Implements edm::ProductHolderBase.

Definition at line 312 of file ProductHolder.cc.

References ProductDeleted, and status().

                                            {
    status() = ProductDeleted;
  }

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

privatevirtual

Implements edm::ProductHolderBase.

Definition at line 316 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

privatevirtual

Implements edm::ProductHolderBase.

Definition at line 335 of file ProductHolder.cc.

                                                   {
    return true;
  }

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

inline

Definition at line 283 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().