edm::DataManagingProductResolver Class Reference

#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::ProductResolverBase
BranchDescription const &	branchDescription () const
std::string const &	moduleLabel () const
ProductResolverBase &	operator= (ProductResolverBase const &)=delete
void	prefetchAsync (WaitingTask *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	putOrMergeProduct (std::unique_ptr< WrapperBase > edp) const
void	putProduct (std::unique_ptr< WrapperBase > edp) 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) const
void	setProcessHistory (ProcessHistory const &ph)
void	setProvenance (ProductProvenanceRetriever const *provRetriever, ProcessHistory const &ph, ProductID const &pid)
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
ProductStatus	defaultStatus () const
template<bool callResolver, typename FUNC >
Resolution	resolveProductImpl (FUNC resolver) const
void	setFailedStatus () const
void	setProduct (std::unique_ptr< WrapperBase > edp) const
ProductStatus	status () const

Private Member Functions
BranchDescription const &	branchDescription_ () const final
void	checkType (WrapperBase const &prod) const
ProductData const &	getProductData () const
virtual bool	isFromCurrentProcess () const =0
void	mergeProduct (std::unique_ptr< WrapperBase > edp) const
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	putOrMergeProduct_ (std::unique_ptr< WrapperBase > prod) const final
void	resetBranchDescription_ (std::shared_ptr< BranchDescription const > bd) final
std::string const &	resolvedModuleLabel_ () const final
void	setProcessHistory_ (ProcessHistory const &ph) final
void	setProvenance_ (ProductProvenanceRetriever const *provRetriever, ProcessHistory const &ph, ProductID const &pid) final
bool	singleProduct_ () const final
void	throwProductDeletedException () const

Private Attributes
ProductStatus const	defaultStatus_
ProductData	productData_
std::atomic< ProductStatus >	theStatus_

Detailed Description

Definition at line 35 of file ProductResolvers.h.

Member Enumeration Documentation

enum edm::DataManagingProductResolver::ProductStatus

strong

Enumerator
ProductSet
NotPut
ResolveFailed
ResolveNotRun
ProductDeleted

Definition at line 37 of file ProductResolvers.h.

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

Constructor & Destructor Documentation

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

inline

Definition at line 45 of file ProductResolvers.h.

References connectTo().

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

Member Function Documentation

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

inlinefinalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 81 of file ProductResolvers.h.

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

Referenced by edm::SingleChoiceNoProcessProductResolver::SingleChoiceNoProcessProductResolver().

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

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

private

Definition at line 459 of file ProductResolvers.cc.

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

Referenced by mergeProduct(), setFailedStatus(), 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";
    }
  }

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

finalvirtual

Implements edm::ProductResolverBase.

Definition at line 441 of file ProductResolvers.cc.

Referenced by DataManagingProductResolver(), and edm::SingleChoiceNoProcessProductResolver::SingleChoiceNoProcessProductResolver().

                                                                                            {
    assert(false);
  }

ProductStatus edm::DataManagingProductResolver::defaultStatus ( ) const

inlineprotected

Definition at line 60 of file ProductResolvers.h.

References defaultStatus_.

Referenced by productResolved_(), putOrMergeProduct_(), edm::ProducedProductResolver::putProduct_(), and edm::InputProductResolver::retrieveAndMerge_().

{ return defaultStatus_; }

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

inlineprivate

Definition at line 70 of file ProductResolvers.h.

References isFromCurrentProcess(), mergeProduct(), productData_, productResolved_(), productUnavailable_(), productWasDeleted_(), productWasFetchedAndIsValid_(), and putOrMergeProduct_().

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

{return productData_;}

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

privatepure virtual

Implemented in edm::ProducedProductResolver, and edm::InputProductResolver.

Referenced by getProductData(), edm::InputProductResolver::InputProductResolver(), edm::ProducedProductResolver::ProducedProductResolver(), and productWasFetchedAndIsValid_().

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

private

Definition at line 79 of file ProductResolvers.cc.

References edm::ProductResolverBase::branchDescription(), checkType(), getProductData(), definitions::original, ProductSet, status(), and edm::ProductData::unsafe_wrapper().

Referenced by getProductData(), and putOrMergeProduct_().

                                                                                  {
    assert(status() == ProductStatus::ProductSet);
    if(not iFrom) { return;}
    
    checkType(*iFrom);
    
    auto original =getProductData().unsafe_wrapper();
    if(original->isMergeable()) {
      original->mergeProduct(iFrom.get());
    } else if(original->hasIsProductEqual()) {
      if(!original->isProductEqual(iFrom.get())) {
        auto const& bd = branchDescription();
        edm::LogError("RunLumiMerging")
        << "ProductResolver::mergeTheProduct\n"
        << "Two run/lumi products for the same run/lumi which should be equal are not\n"
        << "Using the first, ignoring the second\n"
        << "className = " << bd.className() << "\n"
        << "moduleLabel = " << bd.moduleLabel() << "\n"
        << "instance = " << bd.productInstanceName() << "\n"
        << "process = " << bd.processName() << "\n";
      }
    } else {
      auto const& bd = branchDescription();
      edm::LogWarning("RunLumiMerging")
      << "ProductResolver::mergeTheProduct\n"
      << "Run/lumi product has neither a mergeProduct nor isProductEqual function\n"
      << "Using the first, ignoring the second in merge\n"
      << "className = " << bd.className() << "\n"
      << "moduleLabel = " << bd.moduleLabel() << "\n"
      << "instance = " << bd.productInstanceName() << "\n"
      << "process = " << bd.processName() << "\n";
    }
  }

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

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 529 of file ProductResolvers.cc.

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

Referenced by resolvedModuleLabel_(), edm::AliasProductResolver::resolvedModuleLabel_(), edm::ParentProcessProductResolver::resolvedModuleLabel_(), edm::NoProcessProductResolver::resolvedModuleLabel_(), and edm::SingleChoiceNoProcessProductResolver::resolvedModuleLabel_().

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

bool edm::DataManagingProductResolver::productResolved_ ( ) const

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 495 of file ProductResolvers.cc.

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

Referenced by getProductData(), and edm::SingleChoiceNoProcessProductResolver::SingleChoiceNoProcessProductResolver().

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

bool edm::DataManagingProductResolver::productUnavailable_ ( ) const

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 486 of file ProductResolvers.cc.

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

Referenced by getProductData(), and edm::SingleChoiceNoProcessProductResolver::SingleChoiceNoProcessProductResolver().

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

bool edm::DataManagingProductResolver::productWasDeleted_ ( ) const

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 503 of file ProductResolvers.cc.

References ProductDeleted, and status().

Referenced by getProductData(), and edm::SingleChoiceNoProcessProductResolver::SingleChoiceNoProcessProductResolver().

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

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

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 508 of file ProductResolvers.cc.

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

Referenced by getProductData(), and edm::SingleChoiceNoProcessProductResolver::SingleChoiceNoProcessProductResolver().

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

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

inlinefinalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 83 of file ProductResolvers.h.

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

Referenced by edm::SingleChoiceNoProcessProductResolver::SingleChoiceNoProcessProductResolver().

{return &productData_.provenance();}

void edm::DataManagingProductResolver::putOrMergeProduct_ ( std::unique_ptr< WrapperBase >  prod ) const

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 446 of file ProductResolvers.cc.

References defaultStatus(), mergeProduct(), eostools::move(), edm::ProductResolverBase::putProduct(), and status().

Referenced by getProductData(), edm::AliasProductResolver::productWasFetchedAndIsValid_(), edm::ParentProcessProductResolver::productWasFetchedAndIsValid_(), and edm::SingleChoiceNoProcessProductResolver::SingleChoiceNoProcessProductResolver().

                                                                                       {
    if(not prod) {return;}
    if(status() == defaultStatus()) {
      //resolveProduct has not been called or it failed
      putProduct(std::move(prod));
    } else {
      mergeProduct(std::move(prod));
    }
  }

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

inlinefinalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 82 of file ProductResolvers.h.

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

Referenced by edm::SingleChoiceNoProcessProductResolver::SingleChoiceNoProcessProductResolver().

{productData_.resetBranchDescription(bd);}

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

overridevirtual

Implements edm::ProductResolverBase.

Reimplemented in edm::UnscheduledProductResolver, edm::PuttableProductResolver, and edm::InputProductResolver.

Definition at line 533 of file ProductResolvers.cc.

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

Referenced by edm::InputProductResolver::resetProductData_(), edm::PuttableProductResolver::resetProductData_(), edm::UnscheduledProductResolver::resetProductData_(), resetStatus(), edm::AliasProductResolver::resolvedModuleLabel_(), edm::ParentProcessProductResolver::resolvedModuleLabel_(), edm::NoProcessProductResolver::resolvedModuleLabel_(), edm::SingleChoiceNoProcessProductResolver::resolvedModuleLabel_(), edm::InputProductResolver::unscheduledWasNotRun_(), edm::PuttableProductResolver::unscheduledWasNotRun_(), and edm::UnscheduledProductResolver::unscheduledWasNotRun_().

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

void edm::DataManagingProductResolver::resetStatus ( )

inline

Definition at line 52 of file ProductResolvers.h.

References defaultStatus_, resetProductData_(), setProduct(), and theStatus_.

Referenced by resetProductData_().

{theStatus_ = defaultStatus_;}

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

inlinefinalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 85 of file ProductResolvers.h.

References edm::ProductResolverBase::moduleLabel(), sysUtil::pid, productProvenancePtr_(), setProcessHistory_(), setProvenance_(), and singleProduct_().

{return moduleLabel();}

template<bool callResolver, typename FUNC >

ProductResolverBase::Resolution edm::DataManagingProductResolver::resolveProductImpl

(

FUNC

resolver

)

const

Definition at line 45 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* presentStatus) {
        if(this->status() == ProductStatus::ResolveNotRun) {
          this->setFailedStatus();
        }
        *presentStatus = 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);
  }

template<bool callResolver, typename FUNC >

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

protected

Referenced by setFailedStatus().

void edm::DataManagingProductResolver::setFailedStatus ( ) const

inlineprotected

Definition at line 61 of file ProductResolvers.h.

References checkType(), parseEventContent::prod, ResolveFailed, resolveProductImpl(), theStatus_, and throwProductDeletedException().

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

{ theStatus_ = ProductStatus::ResolveFailed; }

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

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 525 of file ProductResolvers.cc.

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

Referenced by resolvedModuleLabel_(), edm::AliasProductResolver::resolvedModuleLabel_(), edm::ParentProcessProductResolver::resolvedModuleLabel_(), edm::NoProcessProductResolver::resolvedModuleLabel_(), and edm::SingleChoiceNoProcessProductResolver::resolvedModuleLabel_().

                                                                               {
    productData_.setProcessHistory(ph);
  }

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

protected

Definition at line 473 of file ProductResolvers.cc.

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

Referenced by edm::InputProductResolver::putProduct_(), edm::ProducedProductResolver::putProduct_(), and resetStatus().

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

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

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 521 of file ProductResolvers.cc.

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

Referenced by resolvedModuleLabel_(), edm::AliasProductResolver::resolvedModuleLabel_(), edm::ParentProcessProductResolver::resolvedModuleLabel_(), edm::NoProcessProductResolver::resolvedModuleLabel_(), and edm::SingleChoiceNoProcessProductResolver::resolvedModuleLabel_().

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

bool edm::DataManagingProductResolver::singleProduct_ ( ) const

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 544 of file ProductResolvers.cc.

Referenced by resolvedModuleLabel_(), edm::AliasProductResolver::resolvedModuleLabel_(), edm::ParentProcessProductResolver::resolvedModuleLabel_(), edm::NoProcessProductResolver::resolvedModuleLabel_(), and edm::SingleChoiceNoProcessProductResolver::resolvedModuleLabel_().

                                                         {
    return true;
  }

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

inlineprotected

Definition at line 59 of file ProductResolvers.h.

References theStatus_.

Referenced by mergeProduct(), productResolved_(), productUnavailable_(), productWasDeleted_(), productWasFetchedAndIsValid_(), putOrMergeProduct_(), edm::ProducedProductResolver::putProduct_(), resolveProductImpl(), edm::InputProductResolver::retrieveAndMerge_(), and edm::UnscheduledProductResolver::unscheduledWasNotRun_().

{ return theStatus_;}

void edm::DataManagingProductResolver::throwProductDeletedException ( ) const

private

Definition at line 29 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(), and setFailedStatus().

                                                                       {
    ProductDeletedException exception;
    exception << "ProductResolverBase::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

ProductStatus const edm::DataManagingProductResolver::defaultStatus_

private

Definition at line 93 of file ProductResolvers.h.

Referenced by defaultStatus(), and resetStatus().

ProductData edm::DataManagingProductResolver::productData_

private

Definition at line 91 of file ProductResolvers.h.

Referenced by getProductData(), provenance_(), resetBranchDescription_(), resetProductData_(), setProcessHistory_(), setProduct(), and setProvenance_().

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

mutableprivate

Definition at line 92 of file ProductResolvers.h.

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