edm::SwitchProducerProductResolver Class Reference

#include <ProductResolvers.h>

Inheritance diagram for edm::SwitchProducerProductResolver:

Public Member Functions
	SwitchProducerProductResolver (std::shared_ptr< BranchDescription const > bd, DataManagingOrAliasProductResolver &realProduct)
Public Member Functions inherited from edm::SwitchBaseProductResolver
void	connectTo (ProductResolverBase const &iOther, Principal const *iParentPrincipal) final
void	setupUnscheduled (UnscheduledConfigurator const &iConfigure) final
	SwitchBaseProductResolver (std::shared_ptr< BranchDescription const > bd, DataManagingOrAliasProductResolver &realProduct)
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)
bool	singleProduct () const
StableProvenance const *	stableProvenance () const
void	unsafe_deleteProduct () const
bool	unscheduledWasNotRun () const
void	write (std::ostream &os) const
virtual	~ProductResolverBase ()
Public Member Functions inherited from edm::ProductPutterBase
	ProductPutterBase ()=default
virtual	~ProductPutterBase ()=default

Private Member Functions
void	prefetchAsync_ (WaitingTaskHolder waitTask, Principal const &principal, bool skipCurrentProcess, ServiceToken const &token, SharedResourcesAcquirer *sra, ModuleCallingContext const *mcc) const final
bool	productUnavailable_ () const final
void	putProduct (std::unique_ptr< WrapperBase > edp) const final
void	resetProductData_ (bool deleteEarly) final
Resolution	resolveProduct_ (Principal const &principal, bool skipCurrentProcess, SharedResourcesAcquirer *sra, ModuleCallingContext const *mcc) const final
bool	unscheduledWasNotRun_ () const final

Private Attributes
ProductStatus	status_

Static Private Attributes
static constexpr const ProductStatus	defaultStatus_ = ProductStatus::NotPut

Additional Inherited Members
Public Types inherited from edm::SwitchBaseProductResolver
using	ProductStatus = DataManagingProductResolver::ProductStatus
Protected Member Functions inherited from edm::SwitchBaseProductResolver
std::atomic< bool > &	prefetchRequested () const
DataManagingOrAliasProductResolver const &	realProduct () const
Resolution	resolveProductImpl (Resolution) const
void	unsafe_setWrapperAndProvenance () const
WaitingTaskList &	waitingTasks () const
Worker *	worker () const

Detailed Description

Definition at line 359 of file ProductResolvers.h.

Constructor & Destructor Documentation

edm::SwitchProducerProductResolver::SwitchProducerProductResolver	(	std::shared_ptr< BranchDescription const >	bd,
		DataManagingOrAliasProductResolver &	realProduct
	)

Definition at line 701 of file ProductResolvers.cc.

      : SwitchBaseProductResolver(std::move(bd), realProduct), status_(defaultStatus_) {}

Member Function Documentation

void edm::SwitchProducerProductResolver::prefetchAsync_ ( WaitingTaskHolder  waitTask, Principal const &  principal, bool  skipCurrentProcess, ServiceToken const &  token, SharedResourcesAcquirer *  sra, ModuleCallingContext const *  mcc  ) const

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 715 of file ProductResolvers.cc.

References edm::WaitingTaskList::add(), edm::ProductResolverBase::branchDescription(), edm::Worker::callWhenDoneAsync(), edm::WaitingTaskList::doneWaiting(), edm::WaitingTaskHolder::group(), edm::ParentContext::isAtEndTransition(), edm::make_waiting_task(), edm::ModuleCallingContext::parent(), edm::SwitchBaseProductResolver::prefetchRequested(), edm::SwitchBaseProductResolver::unsafe_setWrapperAndProvenance(), edm::SwitchBaseProductResolver::waitingTasks(), and edm::SwitchBaseProductResolver::worker().

                                                                                            {
    if (skipCurrentProcess) {
      return;
    }
    if (branchDescription().availableOnlyAtEndTransition() and mcc and not mcc->parent().isAtEndTransition()) {
      return;
    }

    //need to try changing prefetchRequested before adding to waitingTasks
    bool expected = false;
    bool doPrefetchRequested = prefetchRequested().compare_exchange_strong(expected, true);
    waitingTasks().add(waitTask);

    if (doPrefetchRequested) {
      //using a waiting task to do a callback guarantees that
      // the waitingTasks() list will be released from waiting even
      // if the module does not put this data product or the
      // module has an exception while running
      auto waiting = make_waiting_task([this](std::exception_ptr const* iException) {
        if (nullptr != iException) {
          waitingTasks().doneWaiting(*iException);
        } else {
          unsafe_setWrapperAndProvenance();
          waitingTasks().doneWaiting(std::exception_ptr());
        }
      });
      worker()->callWhenDoneAsync(WaitingTaskHolder(*waitTask.group(), waiting));
    }
  }

bool edm::SwitchProducerProductResolver::productUnavailable_ ( ) const

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 766 of file ProductResolvers.cc.

References edm::ProductResolverBase::productUnavailable(), edm::SwitchBaseProductResolver::realProduct(), edm::DataManagingProductResolver::ResolveFailed, and status_.

                                                                {
    // if produce() was run (ResolveFailed), ask from the real resolver
    if (status_ == ProductStatus::ResolveFailed) {
      return realProduct().productUnavailable();
    }
    return true;
  }

void edm::SwitchProducerProductResolver::putProduct ( std::unique_ptr< WrapperBase >  edp ) const

finalprivatevirtual

Implements edm::ProductPutterBase.

Definition at line 750 of file ProductResolvers.cc.

References edm::ProductResolverBase::branchDescription(), edm::BranchDescription::branchName(), defaultStatus_, edm::WaitingTaskList::doneWaiting(), Exception, edm::errors::InsertFailure, edm::SwitchBaseProductResolver::prefetchRequested(), edm::DataManagingProductResolver::ResolveFailed, status_, edm::SwitchBaseProductResolver::unsafe_setWrapperAndProvenance(), and edm::SwitchBaseProductResolver::waitingTasks().

                                                                                     {
    if (status_ != defaultStatus_) {
      throw Exception(errors::InsertFailure)
          << "Attempt to insert more than one product for a branch " << branchDescription().branchName()
          << "This makes no sense for SwitchProducerProductResolver.\nContact a Framework developer";
    }
    // Let's use ResolveFailed to signal that produce() was called, as
    // there is no real product in this resolver
    status_ = ProductStatus::ResolveFailed;
    bool expected = false;
    if (prefetchRequested().compare_exchange_strong(expected, true)) {
      unsafe_setWrapperAndProvenance();
      waitingTasks().doneWaiting(std::exception_ptr());
    }
  }

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

finalprivatevirtual

Reimplemented from edm::SwitchBaseProductResolver.

Definition at line 774 of file ProductResolvers.cc.

References defaultStatus_, edm::SwitchBaseProductResolver::resetProductData_(), and status_.

                                                                        {
    SwitchBaseProductResolver::resetProductData_(deleteEarly);
    if (not deleteEarly) {
      status_ = defaultStatus_;
    }
  }

ProductResolverBase::Resolution edm::SwitchProducerProductResolver::resolveProduct_ ( Principal const &  principal, bool  skipCurrentProcess, SharedResourcesAcquirer *  sra, ModuleCallingContext const *  mcc  ) const

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 705 of file ProductResolvers.cc.

References edm::SwitchBaseProductResolver::realProduct(), Resolution, edm::DataManagingProductResolver::ResolveFailed, edm::ProductResolverBase::resolveProduct(), edm::SwitchBaseProductResolver::resolveProductImpl(), and status_.

                                                                                                                        {
    if (status_ == ProductStatus::ResolveFailed) {
      return resolveProductImpl(realProduct().resolveProduct(principal, skipCurrentProcess, sra, mcc));
    }
    return Resolution(nullptr);
  }

bool edm::SwitchProducerProductResolver::unscheduledWasNotRun_ ( ) const

inlinefinalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 376 of file ProductResolvers.h.

{ return false; }

Member Data Documentation

constexpr const ProductStatus edm::SwitchProducerProductResolver::defaultStatus_ = ProductStatus::NotPut

staticprivate

Definition at line 380 of file ProductResolvers.h.

Referenced by putProduct(), and resetProductData_().

ProductStatus edm::SwitchProducerProductResolver::status_

mutableprivate

Definition at line 385 of file ProductResolvers.h.

Referenced by productUnavailable_(), putProduct(), resetProductData_(), and resolveProduct_().