#include <ProductResolvers.h>

Inheritance diagram for edm::DataManagingProductResolver:

Public Types
enum	ProductStatus { ProductStatus::ProductSet, ProductStatus::NotPut, ProductStatus::ResolveFailed, ProductStatus::ResolveNotRun, ProductStatus::ProductDeleted }

Public Member Functions
void	connectTo (ProductResolverBase const &, Principal const *) final

	DataManagingProductResolver (std::shared_ptr< BranchDescription const > bd, ProductStatus iDefaultStatus)

void	resetProductData_ (bool deleteEarly) override

void	resetStatus ()

template<bool callResolver, typename FUNC >
ProductResolverBase::Resolution	resolveProductImpl (FUNC resolver) const

Public Member Functions inherited from edm::DataManagingOrAliasProductResolver
	DataManagingOrAliasProductResolver ()

Public Member Functions inherited from edm::ProductResolverBase
BranchDescription const &	branchDescription () const

std::string const &	moduleLabel () const

ProductResolverBase &	operator= (ProductResolverBase const &)=delete

void	prefetchAsync (WaitingTaskHolder waitTask, Principal const &principal, bool skipCurrentProcess, ServiceToken const &token, SharedResourcesAcquirer sra, ModuleCallingContext const mcc) const

std::string const &	processName () const

ProductID const &	productID () const

std::string const &	productInstanceName () const

ProductProvenance const *	productProvenancePtr () const

bool	productResolved () const

	ProductResolverBase ()

	ProductResolverBase (ProductResolverBase const &)=delete

TypeID	productType () const

bool	productUnavailable () const

bool	productWasDeleted () const

bool	productWasFetchedAndIsValid (bool iSkipCurrentProcess) const

Provenance const *	provenance () const

bool	provenanceAvailable () const

void	resetBranchDescription (std::shared_ptr< BranchDescription const > bd)

void	resetProductData ()

std::string const &	resolvedModuleLabel () const

Resolution	resolveProduct (Principal const &principal, bool skipCurrentProcess, SharedResourcesAcquirer sra, ModuleCallingContext const mcc) const

void	retrieveAndMerge (Principal const &principal, MergeableRunProductMetadata const *mergeableRunProductMetadata) const

void	setMergeableRunProductMetadata (MergeableRunProductMetadata const *mrpm)

void	setProductID (ProductID const &pid)

void	setProductProvenanceRetriever (ProductProvenanceRetriever const *provRetriever)

virtual void	setupUnscheduled (UnscheduledConfigurator const &)

bool	singleProduct () const

StableProvenance const *	stableProvenance () const

void	unsafe_deleteProduct () const

bool	unscheduledWasNotRun () const

void	write (std::ostream &os) const

virtual	~ProductResolverBase ()

Protected Member Functions
void	checkType (WrapperBase const &prod) const

ProductStatus	defaultStatus () const

ProductData const &	getProductData () const final

template<bool callResolver, typename FUNC >
Resolution	resolveProductImpl (FUNC resolver) const

void	setFailedStatus () const

void	setMergeableRunProductMetadataInProductData (MergeableRunProductMetadata const *)

void	setProduct (std::unique_ptr< WrapperBase > edp) const

void	setProduct (std::shared_ptr< WrapperBase > edp) const

ProductStatus	status () const

Private Member Functions
BranchDescription const &	branchDescription_ () const final

virtual bool	isFromCurrentProcess () const =0

ProductProvenance const *	productProvenancePtr_ () const final

bool	productResolved_ () const final

bool	productUnavailable_ () const final

bool	productWasDeleted_ () const final

bool	productWasFetchedAndIsValid_ (bool iSkipCurrentProcess) const final

Provenance const *	provenance_ () const final

void	resetBranchDescription_ (std::shared_ptr< BranchDescription const > bd) final

std::string const &	resolvedModuleLabel_ () const final

void	setProductID_ (ProductID const &pid) final

void	setProductProvenanceRetriever_ (ProductProvenanceRetriever const *provRetriever) final

bool	singleProduct_ () const final

void	throwProductDeletedException () const

Private Attributes
ProductStatus const	defaultStatus_

ProductData	productData_

std::atomic< ProductStatus >	theStatus_

Detailed Description

Definition at line 50 of file ProductResolvers.h.

Member Enumeration Documentation

◆ ProductStatus

enum edm::DataManagingProductResolver::ProductStatus

strong

Enumerator
ProductSet
NotPut
ResolveFailed
ResolveNotRun
ProductDeleted

Definition at line 52 of file ProductResolvers.h.

52 { ProductSet, NotPut, ResolveFailed, ResolveNotRun, ProductDeleted };

Constructor & Destructor Documentation

◆ DataManagingProductResolver()

edm::DataManagingProductResolver::DataManagingProductResolver	(	std::shared_ptr< BranchDescription const >	bd,
		ProductStatus	iDefaultStatus
	)

inline

Definition at line 54 of file ProductResolvers.h.

         : DataManagingOrAliasProductResolver(),
           productData_(bd),
           theStatus_(iDefaultStatus),
           defaultStatus_(iDefaultStatus) {}

Member Function Documentation

◆ branchDescription_()

BranchDescription const& edm::DataManagingProductResolver::branchDescription_ ( ) const

inlinefinalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 89 of file ProductResolvers.h.

References edm::ProductData::branchDescription(), and getProductData().

89 { return *getProductData().branchDescription(); }

edm::DataManagingProductResolver::getProductData

ProductData const & getProductData() const final

Definition: ProductResolvers.h:75

edm::ProductData::branchDescription

std::shared_ptr< BranchDescription const > const & branchDescription() const

Definition: ProductData.h:29

◆ checkType()

void edm::DataManagingProductResolver::checkType ( WrapperBase const & prod ) const

protected

Definition at line 512 of file ProductResolvers.cc.

References edm::ProductResolverBase::branchDescription(), edm::BranchDescription::branchName(), edm::BranchDescription::className(), edm::errors::EventCorruption, Exception, dumpMFGeometry_cfg::prod, edm::TypeWithDict::unvalidatedTypeInfo(), and edm::BranchDescription::unwrappedType().

Referenced by edm::MergeableInputProductResolver::mergeProduct(), and setProduct().

                                                                            {
     // Check if the types match.
     TypeID typeID(prod.dynamicTypeInfo());
     if (typeID != TypeID{branchDescription().unwrappedType().unvalidatedTypeInfo()}) {
       // Types do not match.
       throw Exception(errors::EventCorruption)
           << "Product on branch " << branchDescription().branchName() << " is of wrong type.\n"
           << "It is supposed to be of type " << branchDescription().className() << ".\n"
           << "It is actually of type " << typeID.className() << ".\n";
     }
   }

◆ connectTo()

void edm::DataManagingProductResolver::connectTo	(	ProductResolverBase const &	iOther,
		Principal const *
	)

finalvirtual

Implements edm::ProductResolverBase.

Definition at line 510 of file ProductResolvers.cc.

References cms::cuda::assert().

510 { assert(false); }

cms::cuda::assert

assert(be >=bs)

◆ defaultStatus()

ProductStatus edm::DataManagingProductResolver::defaultStatus ( ) const

inlineprotected

Definition at line 70 of file ProductResolvers.h.

References defaultStatus_.

Referenced by productResolved_(), edm::PutOnReadInputProductResolver::putProduct(), edm::ProducedProductResolver::putProduct(), edm::DelayedReaderInputProductResolver::retrieveAndMerge_(), and edm::MergeableInputProductResolver::setOrMergeProduct().

70 { return defaultStatus_; }

edm::DataManagingProductResolver::defaultStatus_

ProductStatus const defaultStatus_

Definition: ProductResolvers.h:103

◆ getProductData()

ProductData const& edm::DataManagingProductResolver::getProductData ( ) const

inlinefinalprotectedvirtual

Implements edm::DataManagingOrAliasProductResolver.

Definition at line 75 of file ProductResolvers.h.

References productData_.

Referenced by branchDescription_(), edm::MergeableInputProductResolver::mergeProduct(), productUnavailable_(), productWasFetchedAndIsValid_(), and resolveProductImpl().

75 { return productData_; }

edm::DataManagingProductResolver::productData_

ProductData productData_

Definition: ProductResolvers.h:101

◆ isFromCurrentProcess()

virtual bool edm::DataManagingProductResolver::isFromCurrentProcess ( ) const

privatepure virtual

Implemented in edm::ProducedProductResolver, edm::PutOnReadInputProductResolver, and edm::DelayedReaderInputProductResolver.

Referenced by productWasFetchedAndIsValid_().

◆ productProvenancePtr_()

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

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 585 of file ProductResolvers.cc.

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

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

◆ productResolved_()

bool edm::DataManagingProductResolver::productResolved_ ( ) const

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 554 of file ProductResolvers.cc.

References defaultStatus(), or, ProductDeleted, alignCSCRings::s, and status().

                                                            {
     auto s = status();
     return (s != defaultStatus()) or (s == ProductStatus::ProductDeleted);
   }

◆ productUnavailable_()

bool edm::DataManagingProductResolver::productUnavailable_ ( ) const

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 546 of file ProductResolvers.cc.

References getProductData(), edm::WrapperBase::isPresent(), ProductSet, ResolveNotRun, status(), and edm::ProductData::wrapper().

                                                               {
     auto presentStatus = status();
     if (presentStatus == ProductStatus::ProductSet) {
       return !(getProductData().wrapper()->isPresent());
     }
     return presentStatus != ProductStatus::ResolveNotRun;
   }

◆ productWasDeleted_()

bool edm::DataManagingProductResolver::productWasDeleted_ ( ) const

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 560 of file ProductResolvers.cc.

References ProductDeleted, and status().

560 { return status() == ProductStatus::ProductDeleted; }

edm::DataManagingProductResolver::status

ProductStatus status() const

Definition: ProductResolvers.h:69

edm::DataManagingProductResolver::ProductStatus::ProductDeleted

◆ productWasFetchedAndIsValid_()

bool edm::DataManagingProductResolver::productWasFetchedAndIsValid_ ( bool iSkipCurrentProcess ) const

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 562 of file ProductResolvers.cc.

References getProductData(), isFromCurrentProcess(), ProductSet, status(), and wrapper.

                                                                                                {
     if (iSkipCurrentProcess and isFromCurrentProcess()) {
       return false;
     }
     if (status() == ProductStatus::ProductSet) {
       if (getProductData().wrapper()->isPresent()) {
         return true;
       }
     }
     return false;
   }

◆ provenance_()

Provenance const* edm::DataManagingProductResolver::provenance_ ( ) const

inlinefinalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 93 of file ProductResolvers.h.

References productData_, and edm::ProductData::provenance().

93 { return &productData_.provenance(); }

edm::ProductData::provenance

Provenance const & provenance() const

Definition: ProductData.h:33

edm::DataManagingProductResolver::productData_

ProductData productData_

Definition: ProductResolvers.h:101

◆ resetBranchDescription_()

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

inlinefinalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 90 of file ProductResolvers.h.

References productData_, and edm::ProductData::resetBranchDescription().

                                                                                   {
       productData_.resetBranchDescription(bd);
     }

◆ resetProductData_()

void edm::DataManagingProductResolver::resetProductData_ ( bool deleteEarly )

overridevirtual

Implements edm::DataManagingOrAliasProductResolver.

Reimplemented in edm::UnscheduledProductResolver, and edm::DelayedReaderInputProductResolver.

Definition at line 589 of file ProductResolvers.cc.

References productData_, ProductDeleted, ProductSet, edm::ProductData::resetProductData(), resetStatus(), and theStatus_.

Referenced by edm::DelayedReaderInputProductResolver::resetProductData_(), and edm::UnscheduledProductResolver::resetProductData_().

                                                                       {
     if (theStatus_ == ProductStatus::ProductSet) {
       productData_.resetProductData();
     }
     if (deleteEarly) {
       theStatus_ = ProductStatus::ProductDeleted;
     } else {
       resetStatus();
     }
   }

◆ resetStatus()

void edm::DataManagingProductResolver::resetStatus ( )

inline

Definition at line 62 of file ProductResolvers.h.

References defaultStatus_, and theStatus_.

Referenced by resetProductData_().

62 { theStatus_ = defaultStatus_; }

edm::DataManagingProductResolver::defaultStatus_

ProductStatus const defaultStatus_

Definition: ProductResolvers.h:103

edm::DataManagingProductResolver::theStatus_

std::atomic< ProductStatus > theStatus_

Definition: ProductResolvers.h:102

◆ resolvedModuleLabel_()

std::string const& edm::DataManagingProductResolver::resolvedModuleLabel_ ( ) const

inlinefinalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 95 of file ProductResolvers.h.

References edm::ProductResolverBase::moduleLabel().

95 { return moduleLabel(); }

edm::ProductResolverBase::moduleLabel

std::string const & moduleLabel() const

Definition: ProductResolverBase.h:119

◆ resolveProductImpl() [1/2]

template<bool callResolver, typename FUNC >

ProductResolverBase::Resolution edm::DataManagingProductResolver::resolveProductImpl ( FUNC resolver ) const

Definition at line 47 of file ProductResolvers.cc.

References getProductData(), ProductSet, edm::ProductResolverBase::productWasDeleted(), Resolution, ResolveNotRun, setFailedStatus(), status(), and throwProductDeletedException().

                                                                                                    {
     if (productWasDeleted()) {
       throwProductDeletedException();
     }
     auto presentStatus = status();
 
     if (callResolver && presentStatus == ProductStatus::ResolveNotRun) {
       //if resolver fails because of exception or not setting product
       // make sure the status goes to failed
       auto failedStatusSetter = [this](ProductStatus* iPresentStatus) {
         if (this->status() == ProductStatus::ResolveNotRun) {
           this->setFailedStatus();
         }
         *iPresentStatus = this->status();
       };
       std::unique_ptr<ProductStatus, decltype(failedStatusSetter)> failedStatusGuard(&presentStatus,
                                                                                      failedStatusSetter);
 
       //If successful, this will call setProduct
       resolver();
     }
 
     if (presentStatus == ProductStatus::ProductSet) {
       auto pd = &getProductData();
       if (pd->wrapper()->isPresent()) {
         return Resolution(pd);
       }
     }
 
     return Resolution(nullptr);
   }

◆ resolveProductImpl() [2/2]

template<bool callResolver, typename FUNC >

Resolution edm::DataManagingProductResolver::resolveProductImpl ( FUNC resolver ) const

protected

◆ setFailedStatus()

void edm::DataManagingProductResolver::setFailedStatus ( ) const

inlineprotected

Definition at line 71 of file ProductResolvers.h.

References ResolveFailed, and theStatus_.

Referenced by resolveProductImpl(), edm::DelayedReaderInputProductResolver::retrieveAndMerge_(), and setProduct().

71 { theStatus_ = ProductStatus::ResolveFailed; }

edm::DataManagingProductResolver::ProductStatus::ResolveFailed

edm::DataManagingProductResolver::theStatus_

std::atomic< ProductStatus > theStatus_

Definition: ProductResolvers.h:102

◆ setMergeableRunProductMetadataInProductData()

void edm::DataManagingProductResolver::setMergeableRunProductMetadataInProductData ( MergeableRunProductMetadata const * mrpm )

protected

Definition at line 580 of file ProductResolvers.cc.

References productData_, and edm::ProductData::setMergeableRunProductMetadata().

Referenced by edm::DelayedReaderInputProductResolver::setMergeableRunProductMetadata_().

                                                {
     productData_.setMergeableRunProductMetadata(mrpm);
   }

◆ setProduct() [1/2]

void edm::DataManagingProductResolver::setProduct ( std::unique_ptr< WrapperBase > edp ) const

protected

Definition at line 524 of file ProductResolvers.cc.

References checkType(), eostools::move(), productData_, ProductSet, setFailedStatus(), theStatus_, and edm::ProductData::unsafe_setWrapper().

Referenced by edm::MergeableInputProductResolver::mergeProduct(), edm::DelayedReaderInputProductResolver::prefetchAsync_(), edm::PutOnReadInputProductResolver::putProduct(), edm::ProducedProductResolver::putProduct(), edm::DelayedReaderInputProductResolver::resolveProduct_(), and edm::MergeableInputProductResolver::setOrMergeProduct().

                                                                                    {
     if (edp) {
       checkType(*edp);
       productData_.unsafe_setWrapper(std::move(edp));
       theStatus_ = ProductStatus::ProductSet;
     } else {
       setFailedStatus();
     }
   }

◆ setProduct() [2/2]

void edm::DataManagingProductResolver::setProduct ( std::shared_ptr< WrapperBase > edp ) const

protected

Definition at line 533 of file ProductResolvers.cc.

References checkType(), eostools::move(), productData_, ProductSet, setFailedStatus(), theStatus_, and edm::ProductData::unsafe_setWrapper().

                                                                                    {
     if (edp) {
       checkType(*edp);
       productData_.unsafe_setWrapper(std::move(edp));
       theStatus_ = ProductStatus::ProductSet;
     } else {
       setFailedStatus();
     }
   }

◆ setProductID_()

void edm::DataManagingProductResolver::setProductID_ ( ProductID const & pid )

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 578 of file ProductResolvers.cc.

References productData_, and edm::ProductData::setProductID().

578 { productData_.setProductID(pid); }

edm::ProductData::setProductID

void setProductID(ProductID const &pid)

Definition: ProductData.h:58

edm::DataManagingProductResolver::productData_

ProductData productData_

Definition: ProductResolvers.h:101

◆ setProductProvenanceRetriever_()

void edm::DataManagingProductResolver::setProductProvenanceRetriever_ ( ProductProvenanceRetriever const * provRetriever )

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 574 of file ProductResolvers.cc.

References productData_, and edm::ProductData::setProvenance().

                                                                                                                   {
     productData_.setProvenance(provRetriever);
   }

◆ singleProduct_()

bool edm::DataManagingProductResolver::singleProduct_ ( ) const

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 600 of file ProductResolvers.cc.

600 { return true; }

◆ status()

ProductStatus edm::DataManagingProductResolver::status ( void ) const

inlineprotected

Definition at line 69 of file ProductResolvers.h.

References theStatus_.

Referenced by edm::MergeableInputProductResolver::mergeProduct(), productResolved_(), productUnavailable_(), productWasDeleted_(), productWasFetchedAndIsValid_(), edm::PutOnReadInputProductResolver::putProduct(), edm::ProducedProductResolver::putProduct(), resolveProductImpl(), edm::DelayedReaderInputProductResolver::retrieveAndMerge_(), edm::MergeableInputProductResolver::setOrMergeProduct(), and edm::UnscheduledProductResolver::unscheduledWasNotRun_().

69 { return theStatus_; }

edm::DataManagingProductResolver::theStatus_

std::atomic< ProductStatus > theStatus_

Definition: ProductResolvers.h:102

◆ throwProductDeletedException()

void edm::DataManagingProductResolver::throwProductDeletedException ( ) const

private

Definition at line 33 of file ProductResolvers.cc.

References edm::ProductResolverBase::branchDescription(), cppFunctionSkipper::exception, edm::ProductResolverBase::moduleLabel(), edm::ProductResolverBase::processName(), edm::ProductResolverBase::productInstanceName(), and edm::BranchDescription::unwrappedTypeID().

Referenced by resolveProductImpl().

                                                                        {
     ProductDeletedException exception;
     exception << "DataManagingProductResolver::resolveProduct_: The product matching all criteria was already deleted\n"
               << "Looking for type: " << branchDescription().unwrappedTypeID() << "\n"
               << "Looking for module label: " << moduleLabel() << "\n"
               << "Looking for productInstanceName: " << productInstanceName() << "\n"
               << (processName().empty() ? "" : "Looking for process: ") << processName() << "\n"
               << "This means there is a configuration error.\n"
               << "The module which is asking for this data must be configured to state that it will read this data.";
     throw exception;
   }

Member Data Documentation

◆ defaultStatus_

ProductStatus const edm::DataManagingProductResolver::defaultStatus_

private

Definition at line 103 of file ProductResolvers.h.

Referenced by defaultStatus(), and resetStatus().

◆ productData_

ProductData edm::DataManagingProductResolver::productData_

private

Definition at line 101 of file ProductResolvers.h.

Referenced by edm::SwitchBaseProductResolver::branchDescription_(), getProductData(), edm::SwitchBaseProductResolver::getProductData(), provenance_(), edm::SwitchBaseProductResolver::provenance_(), resetBranchDescription_(), edm::SwitchBaseProductResolver::resetBranchDescription_(), resetProductData_(), setMergeableRunProductMetadataInProductData(), setProduct(), setProductID_(), and setProductProvenanceRetriever_().

◆ theStatus_

std::atomic<ProductStatus> edm::DataManagingProductResolver::theStatus_

mutableprivate

Definition at line 102 of file ProductResolvers.h.

Referenced by resetProductData_(), resetStatus(), setFailedStatus(), setProduct(), and status().

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ ProductStatus

Constructor & Destructor Documentation

◆ DataManagingProductResolver()

Member Function Documentation

◆ branchDescription_()

◆ checkType()

◆ connectTo()

◆ defaultStatus()

◆ getProductData()

◆ isFromCurrentProcess()

◆ productProvenancePtr_()

◆ productResolved_()

◆ productUnavailable_()

◆ productWasDeleted_()

◆ productWasFetchedAndIsValid_()

◆ provenance_()

◆ resetBranchDescription_()

◆ resetProductData_()

◆ resetStatus()

◆ resolvedModuleLabel_()

◆ resolveProductImpl() [1/2]

◆ resolveProductImpl() [2/2]

◆ setFailedStatus()

◆ setMergeableRunProductMetadataInProductData()

◆ setProduct() [1/2]

◆ setProduct() [2/2]

◆ setProductID_()

◆ setProductProvenanceRetriever_()

◆ singleProduct_()

◆ status()

◆ throwProductDeletedException()

Member Data Documentation

◆ defaultStatus_

◆ productData_

◆ theStatus_