edm::ProcessBlock Class Reference

#include <ProcessBlock.h>

Public Types
using	CacheIdentifier_t = unsigned long

Public Member Functions
CacheIdentifier_t	cacheIdentifier () const
template<typename PROD , typename... Args>
void	emplace (EDPutTokenT< PROD > token, Args &&... args)
template<typename PROD , typename... Args>
void	emplace (EDPutToken token, Args &&... args)
template<typename PROD >
PROD const &	get (EDGetTokenT< PROD > token) const noexcept(false)
template<typename PROD >
bool	getByToken (EDGetToken token, Handle< PROD > &result) const
template<typename PROD >
bool	getByToken (EDGetTokenT< PROD > token, Handle< PROD > &result) const
template<typename PROD >
Handle< PROD >	getHandle (EDGetTokenT< PROD > token) const
ModuleCallingContext const *	moduleCallingContext () const
	ProcessBlock (ProcessBlockPrincipal const &, ModuleDescription const &, ModuleCallingContext const *, bool isAtEnd)
std::string const &	processName () const
template<typename PROD >
void	put (EDPutTokenT< PROD > token, std::unique_ptr< PROD > product)
template<typename PROD >
void	put (EDPutToken token, std::unique_ptr< PROD > product)
void	setConsumer (EDConsumerBase const *iConsumer)
void	setProducer (ProducerBase const *iProducer)

Private Types
using	ProductPtrVec = std::vector< edm::propagate_const< std::unique_ptr< WrapperBase > >>

Private Member Functions
void	commit_ (std::vector< edm::ProductResolverIndex > const &iShouldPut)
template<typename PROD , typename... Args>
void	emplaceImpl (EDPutToken::value_type token, Args &&... args)
ProcessBlockPrincipal const &	processBlockPrincipal () const
template<typename PROD >
void	putImpl (EDPutToken::value_type token, std::unique_ptr< PROD > product)
ProductPtrVec &	putProducts ()
ProductPtrVec const &	putProducts () const

Private Attributes
ModuleCallingContext const *	moduleCallingContext_
PrincipalGetAdapter	provRecorder_
ProductPtrVec	putProducts_

Friends
class	ProducerBase
template<typename T >
class	stream::ProducingModuleAdaptorBase

Detailed Description

Author

W. David Dagenhart, created 19 March, 2020

Definition at line 36 of file ProcessBlock.h.

Member Typedef Documentation

CacheIdentifier_t

using edm::ProcessBlock::CacheIdentifier_t = unsigned long

If you are caching data from the ProcessBlock, you should also keep this number. If this number changes then you know that the data you have cached is invalid. The value of '0' will never be returned so you can use that to denote that you have not yet checked the value.

Definition at line 63 of file ProcessBlock.h.

ProductPtrVec

using edm::ProcessBlock::ProductPtrVec = std::vector<edm::propagate_const<std::unique_ptr<WrapperBase> >>

private

Definition at line 97 of file ProcessBlock.h.

Constructor & Destructor Documentation

ProcessBlock()

edm::ProcessBlock::ProcessBlock	(	ProcessBlockPrincipal const &	pbp,
		ModuleDescription const &	md,
		ModuleCallingContext const *	moduleCallingContext,
		bool	isAtEnd
	)

Definition at line 7 of file ProcessBlock.cc.

      : provRecorder_(pbp, md, isAtEnd), moduleCallingContext_(moduleCallingContext) {}

Member Function Documentation

cacheIdentifier()

ProcessBlock::CacheIdentifier_t edm::ProcessBlock::cacheIdentifier

(

)

const

Definition at line 19 of file ProcessBlock.cc.

References edm::Principal::cacheIdentifier(), and processBlockPrincipal().

                                                                    {
    return processBlockPrincipal().cacheIdentifier();
  }

commit_()

void edm::ProcessBlock::commit_ ( std::vector< edm::ProductResolverIndex > const &  iShouldPut )

private

Definition at line 29 of file ProcessBlock.cc.

References runTheMatrix::const, edm::get_underlying_safe(), edm::Principal::getProductResolverByIndex(), mps_fire::i, edm::isEndTransition(), eostools::move(), edm::PrincipalGetAdapter::principal(), processBlockPrincipal(), provRecorder_, edm::ProcessBlockPrincipal::put(), putProducts(), edm::PrincipalGetAdapter::putTokenIndexToProductResolverIndex(), and edm::PrincipalGetAdapter::transition().

Referenced by edm::stream::ProducingModuleAdaptorBase< EDProducerBase >::commit().

                                                                                 {
    ProcessBlockPrincipal const& pbp = processBlockPrincipal();
    size_t nPut = 0;
    for (size_t i = 0; i < putProducts().size(); ++i) {
      auto& product = get_underlying_safe(putProducts()[i]);
      if (product) {
        pbp.put(provRecorder_.putTokenIndexToProductResolverIndex()[i], std::move(product));
        ++nPut;
      }
    }

    auto sz = iShouldPut.size();
    if (sz != 0 and sz != nPut) {
      //some were missed
      auto& principal = provRecorder_.principal();
      for (auto index : iShouldPut) {
        auto resolver = principal.getProductResolverByIndex(index);
        if (not resolver->productResolved() and isEndTransition(provRecorder_.transition()) ==
                                                    resolver->branchDescription().availableOnlyAtEndTransition()) {
          dynamic_cast<ProductPutterBase const*>(resolver)->putProduct(std::unique_ptr<WrapperBase>());
        }
      }
    }

    // the cleanup is all or none
    putProducts().clear();
  }

emplace() [1/2]

template<typename PROD , typename... Args>

void edm::ProcessBlock::emplace	(	EDPutTokenT< PROD >	token,
		Args &&...	args
	)

Definition at line 171 of file ProcessBlock.h.

References writedatasetfile::args, PROD, edm::principal_get_adapter_detail::throwOnPutOfUninitializedToken(), unpackBuffers-CaloStage2::token, and UNLIKELY.

Referenced by AlignmentProducerAsAnalyzer::endProcessBlockProduce().

                                                                    {
    if (UNLIKELY(token.isUninitialized())) {
      principal_get_adapter_detail::throwOnPutOfUninitializedToken("ProcessBlock", typeid(PROD));
    }
    emplaceImpl<PROD>(token.index(), std::forward<Args>(args)...);
  }

emplace() [2/2]

template<typename PROD , typename... Args>

void edm::ProcessBlock::emplace	(	EDPutToken	token,
		Args &&...	args
	)

Definition at line 179 of file ProcessBlock.h.

References writedatasetfile::args, edm::PrincipalGetAdapter::getTypeIDForPutTokenIndex(), PROD, provRecorder_, edm::principal_get_adapter_detail::throwOnPutOfUninitializedToken(), edm::principal_get_adapter_detail::throwOnPutOfWrongType(), unpackBuffers-CaloStage2::token, and UNLIKELY.

                                                             {
    if (UNLIKELY(token.isUninitialized())) {
      principal_get_adapter_detail::throwOnPutOfUninitializedToken("ProcessBlock", typeid(PROD));
    }
    if (UNLIKELY(provRecorder_.getTypeIDForPutTokenIndex(token.index()) != TypeID{typeid(PROD)})) {
      principal_get_adapter_detail::throwOnPutOfWrongType(typeid(PROD),
                                                          provRecorder_.getTypeIDForPutTokenIndex(token.index()));
    }
    emplaceImpl<PROD>(token.index(), std::forward<Args>(args)...);
  }

emplaceImpl()

template<typename PROD , typename... Args>

void edm::ProcessBlock::emplaceImpl ( EDPutToken::value_type  token, Args &&...  args  )

private

Definition at line 204 of file ProcessBlock.h.

References writedatasetfile::args, cms::cuda::assert(), eostools::move(), putProducts(), findQualityFiles::size, relativeConstraints::value, and pfClustersFromHGC3DClusters_cfi::wp.

                                                                           {
    assert(index < putProducts().size());

    std::unique_ptr<Wrapper<PROD>> wp(new Wrapper<PROD>(WrapperBase::Emplace{}, std::forward<Args>(args)...));

    // The following will call post_insert if T has such a function,
    // and do nothing if T has no such function.
    std::conditional_t<detail::has_postinsert<PROD>::value, DoPostInsert<PROD>, DoNotPostInsert<PROD>> maybe_inserter;
    maybe_inserter(&(wp->bareProduct()));

    putProducts()[index] = std::move(wp);
  }

get()

template<typename PROD >

PROD const & edm::ProcessBlock::get ( EDGetTokenT< PROD >  token ) const

noexcept

Definition at line 135 of file ProcessBlock.h.

References eostools::move(), PROD, edm::PRODUCT_TYPE, and unpackBuffers-CaloStage2::token.

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), submitPVValidationJobs.BetterConfigParser::__updateDict(), edmtest::TestFindProduct::accessInputProcessBlock(), edmtest::TestFindProduct::beginProcessBlock(), rrapi.RRApi::columns(), rrapi.RRApi::count(), rrapi.RRApi::data(), edmtest::TestFindProduct::endProcessBlock(), betterConfigParser.BetterConfigParser::getCompares(), betterConfigParser.BetterConfigParser::getGeneral(), betterConfigParser.BetterConfigParser::getResultingSection(), submitPVValidationJobs.BetterConfigParser::getResultingSection(), rrapi.RRApi::report(), rrapi.RRApi::reports(), rrapi.RRApi::tables(), rrapi.RRApi::tags(), rrapi.RRApi::templates(), and rrapi.RRApi::workspaces().

                                                                             {
    BasicHandle bh = provRecorder_.getByToken_(TypeID(typeid(PROD)), PRODUCT_TYPE, token, moduleCallingContext_);
    return *convert_handle<PROD>(std::move(bh));
  }

getByToken() [1/2]

template<typename PROD >

bool edm::ProcessBlock::getByToken	(	EDGetToken	token,
		Handle< PROD > &	result
	)		const

Definition at line 107 of file ProcessBlock.h.

References edm::PrincipalGetAdapter::getByToken_(), moduleCallingContext_, eostools::move(), PROD, edm::PRODUCT_TYPE, provRecorder_, mps_fire::result, and unpackBuffers-CaloStage2::token.

Referenced by edmtest::TestFindProduct::endProcessBlock().

                                                                            {
    result.clear();
    BasicHandle bh = provRecorder_.getByToken_(TypeID(typeid(PROD)), PRODUCT_TYPE, token, moduleCallingContext_);
    result = convert_handle<PROD>(std::move(bh));  // throws on conversion error
    if (result.failedToGet()) {
      return false;
    }
    return true;
  }

getByToken() [2/2]

template<typename PROD >

bool edm::ProcessBlock::getByToken	(	EDGetTokenT< PROD >	token,
		Handle< PROD > &	result
	)		const

Definition at line 118 of file ProcessBlock.h.

References edm::PrincipalGetAdapter::getByToken_(), moduleCallingContext_, eostools::move(), PROD, edm::PRODUCT_TYPE, provRecorder_, mps_fire::result, and unpackBuffers-CaloStage2::token.

                                                                                   {
    result.clear();
    BasicHandle bh = provRecorder_.getByToken_(TypeID(typeid(PROD)), PRODUCT_TYPE, token, moduleCallingContext_);
    result = convert_handle<PROD>(std::move(bh));  // throws on conversion error
    if (result.failedToGet()) {
      return false;
    }
    return true;
  }

getHandle()

template<typename PROD >

Handle< PROD > edm::ProcessBlock::getHandle

(

EDGetTokenT< PROD >

token

)

const

Definition at line 129 of file ProcessBlock.h.

References edm::PrincipalGetAdapter::getByToken_(), moduleCallingContext_, eostools::move(), PROD, edm::PRODUCT_TYPE, provRecorder_, and unpackBuffers-CaloStage2::token.

Referenced by edmtest::TestFindProduct::endProcessBlock().

                                                                    {
    BasicHandle bh = provRecorder_.getByToken_(TypeID(typeid(PROD)), PRODUCT_TYPE, token, moduleCallingContext_);
    return convert_handle<PROD>(std::move(bh));
  }

moduleCallingContext()

ModuleCallingContext const* edm::ProcessBlock::moduleCallingContext ( ) const

inline

Definition at line 78 of file ProcessBlock.h.

References moduleCallingContext_.

{ return moduleCallingContext_; }

processBlockPrincipal()

ProcessBlockPrincipal const & edm::ProcessBlock::processBlockPrincipal ( ) const

private

Definition at line 25 of file ProcessBlock.cc.

References runTheMatrix::const, edm::PrincipalGetAdapter::principal(), and provRecorder_.

Referenced by cacheIdentifier(), commit_(), and processName().

                                                                         {
    return dynamic_cast<ProcessBlockPrincipal const&>(provRecorder_.principal());
  }

processName()

std::string const & edm::ProcessBlock::processName

(

)

const

Definition at line 23 of file ProcessBlock.cc.

References processBlockPrincipal(), and edm::ProcessBlockPrincipal::processName().

{ return processBlockPrincipal().processName(); }

put() [1/2]

template<typename PROD >

void edm::ProcessBlock::put	(	EDPutTokenT< PROD >	token,
		std::unique_ptr< PROD >	product
	)

Definition at line 141 of file ProcessBlock.h.

References eostools::move(), PROD, edm::PrincipalGetAdapter::productInstanceLabel(), provRecorder_, putImpl(), edm::principal_get_adapter_detail::throwOnPutOfNullProduct(), edm::principal_get_adapter_detail::throwOnPutOfUninitializedToken(), unpackBuffers-CaloStage2::token, and UNLIKELY.

                                                                             {
    if (UNLIKELY(product.get() == 0)) {  // null pointer is illegal
      TypeID typeID(typeid(PROD));
      principal_get_adapter_detail::throwOnPutOfNullProduct(
          "ProcessBlock", typeID, provRecorder_.productInstanceLabel(token));
    }
    if (UNLIKELY(token.isUninitialized())) {
      principal_get_adapter_detail::throwOnPutOfUninitializedToken("ProcessBlock", typeid(PROD));
    }
    putImpl(token.index(), std::move(product));
  }

put() [2/2]

template<typename PROD >

void edm::ProcessBlock::put	(	EDPutToken	token,
		std::unique_ptr< PROD >	product
	)

Definition at line 154 of file ProcessBlock.h.

References edm::PrincipalGetAdapter::getTypeIDForPutTokenIndex(), eostools::move(), PROD, edm::PrincipalGetAdapter::productInstanceLabel(), provRecorder_, putImpl(), edm::principal_get_adapter_detail::throwOnPutOfNullProduct(), edm::principal_get_adapter_detail::throwOnPutOfUninitializedToken(), edm::principal_get_adapter_detail::throwOnPutOfWrongType(), unpackBuffers-CaloStage2::token, and UNLIKELY.

                                                                      {
    if (UNLIKELY(product.get() == 0)) {  // null pointer is illegal
      TypeID typeID(typeid(PROD));
      principal_get_adapter_detail::throwOnPutOfNullProduct(
          "ProcessBlock", typeID, provRecorder_.productInstanceLabel(token));
    }
    if (UNLIKELY(token.isUninitialized())) {
      principal_get_adapter_detail::throwOnPutOfUninitializedToken("ProcessBlock", typeid(PROD));
    }
    if (UNLIKELY(provRecorder_.getTypeIDForPutTokenIndex(token.index()) != TypeID{typeid(PROD)})) {
      principal_get_adapter_detail::throwOnPutOfWrongType(typeid(PROD),
                                                          provRecorder_.getTypeIDForPutTokenIndex(token.index()));
    }
    putImpl(token.index(), std::move(product));
  }

putImpl()

template<typename PROD >

void edm::ProcessBlock::putImpl ( EDPutToken::value_type  token, std::unique_ptr< PROD >  product  )

private

Definition at line 191 of file ProcessBlock.h.

References cms::cuda::assert(), eostools::move(), putProducts(), findQualityFiles::size, relativeConstraints::value, and pfClustersFromHGC3DClusters_cfi::wp.

Referenced by put().

                                                                                    {
    // The following will call post_insert if T has such a function,
    // and do nothing if T has no such function.
    std::conditional_t<detail::has_postinsert<PROD>::value, DoPostInsert<PROD>, DoNotPostInsert<PROD>> maybe_inserter;
    maybe_inserter(product.get());

    assert(index < putProducts().size());

    std::unique_ptr<Wrapper<PROD>> wp(new Wrapper<PROD>(std::move(product)));
    putProducts()[index] = std::move(wp);
  }

putProducts() [1/2]

ProductPtrVec& edm::ProcessBlock::putProducts ( )

inlineprivate

Definition at line 98 of file ProcessBlock.h.

References putProducts_.

Referenced by commit_(), emplaceImpl(), and putImpl().

{ return putProducts_; }

putProducts() [2/2]

ProductPtrVec const& edm::ProcessBlock::putProducts ( ) const

inlineprivate

Definition at line 99 of file ProcessBlock.h.

References putProducts_.

{ return putProducts_; }

setConsumer()

void edm::ProcessBlock::setConsumer ( EDConsumerBase const *  iConsumer )

inline

Definition at line 53 of file ProcessBlock.h.

References provRecorder_, and edm::PrincipalGetAdapter::setConsumer().

Referenced by edm::one::EDAnalyzerBase::doAccessInputProcessBlock(), edm::global::EDAnalyzerBase::doAccessInputProcessBlock(), edm::one::EDFilterBase::doAccessInputProcessBlock(), edm::one::EDProducerBase::doAccessInputProcessBlock(), edm::limited::EDAnalyzerBase::doAccessInputProcessBlock(), edm::global::EDProducerBase::doAccessInputProcessBlock(), edm::limited::EDProducerBase::doAccessInputProcessBlock(), edm::global::EDFilterBase::doAccessInputProcessBlock(), edm::limited::EDFilterBase::doAccessInputProcessBlock(), edm::stream::EDAnalyzerAdaptor< T >::doAccessInputProcessBlock(), edm::stream::ProducingModuleAdaptor< T, M, B >::doAccessInputProcessBlock(), edm::one::EDAnalyzerBase::doBeginProcessBlock(), edm::global::EDAnalyzerBase::doBeginProcessBlock(), edm::one::EDFilterBase::doBeginProcessBlock(), edm::one::EDProducerBase::doBeginProcessBlock(), edm::limited::EDAnalyzerBase::doBeginProcessBlock(), edm::global::EDProducerBase::doBeginProcessBlock(), edm::limited::EDProducerBase::doBeginProcessBlock(), edm::global::EDFilterBase::doBeginProcessBlock(), edm::limited::EDFilterBase::doBeginProcessBlock(), edm::stream::EDAnalyzerAdaptor< T >::doBeginProcessBlock(), edm::stream::ProducingModuleAdaptor< T, M, B >::doBeginProcessBlock(), edm::one::EDAnalyzerBase::doEndProcessBlock(), edm::global::EDAnalyzerBase::doEndProcessBlock(), edm::one::EDFilterBase::doEndProcessBlock(), edm::one::EDProducerBase::doEndProcessBlock(), edm::limited::EDAnalyzerBase::doEndProcessBlock(), edm::global::EDProducerBase::doEndProcessBlock(), edm::limited::EDProducerBase::doEndProcessBlock(), edm::global::EDFilterBase::doEndProcessBlock(), edm::limited::EDFilterBase::doEndProcessBlock(), edm::stream::EDAnalyzerAdaptor< T >::doEndProcessBlock(), and edm::stream::ProducingModuleAdaptor< T, M, B >::doEndProcessBlock().

{ provRecorder_.setConsumer(iConsumer); }

setProducer()

void edm::ProcessBlock::setProducer

(

ProducerBase const *

iProducer

)

Definition at line 13 of file ProcessBlock.cc.

References provRecorder_, putProducts_, edm::PrincipalGetAdapter::putTokenIndexToProductResolverIndex(), and edm::PrincipalGetAdapter::setProducer().

Referenced by edm::one::EDFilterBase::doBeginProcessBlock(), edm::one::EDProducerBase::doBeginProcessBlock(), edm::global::EDProducerBase::doBeginProcessBlock(), edm::limited::EDProducerBase::doBeginProcessBlock(), edm::global::EDFilterBase::doBeginProcessBlock(), edm::limited::EDFilterBase::doBeginProcessBlock(), edm::stream::ProducingModuleAdaptor< T, M, B >::doBeginProcessBlock(), edm::one::EDFilterBase::doEndProcessBlock(), edm::one::EDProducerBase::doEndProcessBlock(), edm::limited::EDProducerBase::doEndProcessBlock(), edm::global::EDProducerBase::doEndProcessBlock(), edm::global::EDFilterBase::doEndProcessBlock(), edm::limited::EDFilterBase::doEndProcessBlock(), and edm::stream::ProducingModuleAdaptor< T, M, B >::doEndProcessBlock().

                                                              {
    provRecorder_.setProducer(iProducer);
    //set appropriate size
    putProducts_.resize(provRecorder_.putTokenIndexToProductResolverIndex().size());
  }

Friends And Related Function Documentation

ProducerBase

friend class ProducerBase

friend

Definition at line 91 of file ProcessBlock.h.

stream::ProducingModuleAdaptorBase

template<typename T >

friend class stream::ProducingModuleAdaptorBase

friend

Definition at line 93 of file ProcessBlock.h.

Member Data Documentation

moduleCallingContext_

ModuleCallingContext const* edm::ProcessBlock::moduleCallingContext_

private

Definition at line 103 of file ProcessBlock.h.

Referenced by getByToken(), getHandle(), and moduleCallingContext().

provRecorder_

PrincipalGetAdapter edm::ProcessBlock::provRecorder_

private

Definition at line 101 of file ProcessBlock.h.

Referenced by commit_(), emplace(), getByToken(), getHandle(), processBlockPrincipal(), put(), setConsumer(), and setProducer().

putProducts_

ProductPtrVec edm::ProcessBlock::putProducts_

private

Definition at line 102 of file ProcessBlock.h.

Referenced by putProducts(), and setProducer().