edm::LuminosityBlock Class Reference

#include <LuminosityBlock.h>

Inheritance diagram for edm::LuminosityBlock:

Public Types
typedef unsigned long	CacheIdentifier_t

Public Member Functions
CacheIdentifier_t	cacheIdentifier () const
void	getAllStableProvenance (std::vector< StableProvenance const * > &provenances) const
template<typename PROD >
bool	getByLabel (std::string const &label, Handle< PROD > &result) const
template<typename PROD >
bool	getByLabel (std::string const &label, std::string const &productInstanceName, Handle< PROD > &result) const
template<typename PROD >
bool	getByLabel (InputTag const &tag, Handle< PROD > &result) const
	same as above, but using the InputTag class More...
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 >
void	getManyByType (std::vector< Handle< PROD > > &results) const
Provenance	getProvenance (BranchID const &theID) const
Run const &	getRun () const
LuminosityBlockIndex	index () const
void	labelsForToken (EDGetToken const &iToken, ProductLabels &oLabels) const
	LuminosityBlock (LuminosityBlockPrincipal const &lbp, ModuleDescription const &md, ModuleCallingContext const *)
LuminosityBlockAuxiliary const &	luminosityBlockAuxiliary () const
ModuleCallingContext const *	moduleCallingContext () const
ProcessHistory const &	processHistory () const
ProcessHistoryID const &	processHistoryID () const
template<typename PROD >
void	put (std::unique_ptr< PROD > product)
	Put a new product. More...
template<typename PROD >
void	put (std::unique_ptr< PROD > product, std::string const &productInstanceName)
	Put a new product with a 'product instance name'. More...
void	setConsumer (EDConsumerBase const *iConsumer)
void	setSharedResourcesAcquirer (SharedResourcesAcquirer *iResourceAcquirer)
	~LuminosityBlock ()
Public Member Functions inherited from edm::LuminosityBlockBase
Timestamp const &	beginTime () const
Timestamp const &	endTime () const
template<typename PROD >
bool	getByLabel (InputTag const &tag, Handle< PROD > &result) const
	same as above, but using the InputTag class More...
template<class T >
bool	getByLabel (const InputTag &tag, Handle< T > &result) const
LuminosityBlockID	id () const
LuminosityBlockNumber_t	luminosityBlock () const
	LuminosityBlockBase ()
RunNumber_t	run () const
virtual	~LuminosityBlockBase ()

Private Types
typedef std::vector< std::pair< edm::propagate_const< std::unique_ptr< WrapperBase > >, BranchDescription const * > >	ProductPtrVec

Private Member Functions
void	commit_ (std::vector< edm::ProductResolverIndex > const &iShouldPut)
virtual BasicHandle	getByLabelImpl (std::type_info const &iWrapperType, std::type_info const &iProductType, InputTag const &iTag) const
LuminosityBlockPrincipal const &	luminosityBlockPrincipal () const
ProductPtrVec &	putProducts ()
ProductPtrVec const &	putProducts () const

Private Attributes
LuminosityBlockAuxiliary const &	aux_
ModuleCallingContext const *	moduleCallingContext_
PrincipalGetAdapter	provRecorder_
ProductPtrVec	putProducts_
std::shared_ptr< Run const > const	run_

Static Private Attributes
static const std::string	emptyString_

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

Detailed Description

Definition at line 45 of file LuminosityBlock.h.

Member Typedef Documentation

typedef unsigned long edm::LuminosityBlock::CacheIdentifier_t

If you are caching data from the LuminosityBlock, 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 64 of file LuminosityBlock.h.

typedef std::vector<std::pair<edm::propagate_const<std::unique_ptr<WrapperBase> >, BranchDescription const*> > edm::LuminosityBlock::ProductPtrVec

private

Definition at line 138 of file LuminosityBlock.h.

Constructor & Destructor Documentation

LuminosityBlock::LuminosityBlock	(	LuminosityBlockPrincipal const &	lbp,
		ModuleDescription const &	md,
		ModuleCallingContext const *	moduleCallingContext
	)

Definition at line 12 of file LuminosityBlock.cc.

                                                                                     :
        provRecorder_(lbp, md),
        aux_(lbp.aux()),
        run_(new Run(lbp.runPrincipal(), md, moduleCallingContext)),
        moduleCallingContext_(moduleCallingContext) {
  }

LuminosityBlock::~LuminosityBlock

(

)

Definition at line 20 of file LuminosityBlock.cc.

                                    {
  }

Member Function Documentation

LuminosityBlock::CacheIdentifier_t LuminosityBlock::cacheIdentifier

(

)

const

Definition at line 29 of file LuminosityBlock.cc.

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

{return luminosityBlockPrincipal().cacheIdentifier();}

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

private

Definition at line 63 of file LuminosityBlock.cc.

References begin, end, edm::get_underlying_safe(), index(), luminosityBlockPrincipal(), eostools::move(), AlCaHLTBitMon_ParallelJobs::p, edm::PrincipalGetAdapter::principal(), provRecorder_, edm::LuminosityBlockPrincipal::put(), putProducts(), and findQualityFiles::size.

Referenced by edm::stream::ProducingModuleAdaptorBase< EDProducerBase >::commit(), edm::InputSource::doBeginLumi(), and edm::InputSource::doEndLumi().

                                                                               {
    LuminosityBlockPrincipal const& lbp = luminosityBlockPrincipal();
    ProductPtrVec::iterator pit(putProducts().begin());
    ProductPtrVec::iterator pie(putProducts().end());

    while(pit != pie) {
        lbp.put(*pit->second, std::move(get_underlying_safe(pit->first)));
        ++pit;
    }
    
    auto sz = iShouldPut.size();
    if(sz !=0 and sz != putProducts().size()) {
      //some were missed
      auto& p = provRecorder_.principal();
      for(auto index: iShouldPut){
        auto resolver = p.getProductResolverByIndex(index);
        if(not resolver->productResolved()) {
          resolver->putProduct(std::unique_ptr<WrapperBase>());
        }
      }
    }

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

void LuminosityBlock::getAllStableProvenance

(

std::vector< StableProvenance const * > &

provenances

)

const

Definition at line 58 of file LuminosityBlock.cc.

References edm::Principal::getAllStableProvenance(), and luminosityBlockPrincipal().

                                                                                               {
    luminosityBlockPrincipal().getAllStableProvenance(provenances);
  }

template<typename PROD >

bool LuminosityBlock::getByLabel	(	std::string const &	label,
		Handle< PROD > &	result
	)		const

Definition at line 190 of file LuminosityBlock.h.

Referenced by LogErrorEventFilter::beginLuminosityBlock(), pat::PATTriggerProducer::beginLuminosityBlock(), LumiCalculator::endLuminosityBlock(), and edm::service::RandomNumberGeneratorService::readFromLuminosityBlock().

                                                                                {
    return getByLabel(label, emptyString_, result);
  }

template<typename PROD >

bool LuminosityBlock::getByLabel	(	std::string const &	label,
		std::string const &	productInstanceName,
		Handle< PROD > &	result
	)		const

Definition at line 196 of file LuminosityBlock.h.

References edm::HandleBase::clear(), edm::convert_handle(), edm::HandleBase::failedToGet(), eostools::move(), PROD, and edm::principal_get_adapter_detail::throwOnPrematureRead().

                                              {
    if(!provRecorder_.checkIfComplete<PROD>()) {
      principal_get_adapter_detail::throwOnPrematureRead("Lumi", TypeID(typeid(PROD)), label, productInstanceName);
    }
    result.clear();
    BasicHandle bh = provRecorder_.getByLabel_(TypeID(typeid(PROD)), label, productInstanceName, emptyString_, moduleCallingContext_);
    convert_handle(std::move(bh), result);  // throws on conversion error
    if (result.failedToGet()) {
      return false;
    }
    return true;
  }

template<typename PROD >

bool LuminosityBlock::getByLabel	(	InputTag const &	tag,
		Handle< PROD > &	result
	)		const

same as above, but using the InputTag class

Definition at line 214 of file LuminosityBlock.h.

References edm::HandleBase::clear(), edm::convert_handle(), edm::HandleBase::failedToGet(), edm::InputTag::instance(), edm::InputTag::label(), eostools::move(), PROD, and edm::principal_get_adapter_detail::throwOnPrematureRead().

                                                                             {
    if(!provRecorder_.checkIfComplete<PROD>()) {
      principal_get_adapter_detail::throwOnPrematureRead("Lumi", TypeID(typeid(PROD)), tag.label(), tag.instance());
    }
    result.clear();
    BasicHandle bh = provRecorder_.getByLabel_(TypeID(typeid(PROD)), tag, moduleCallingContext_);
    convert_handle(std::move(bh), result);  // throws on conversion error
    if (result.failedToGet()) {
      return false;
    }
    return true;
  }

BasicHandle LuminosityBlock::getByLabelImpl ( std::type_info const &  iWrapperType, std::type_info const &  iProductType, InputTag const &  iTag  ) const

privatevirtual

Definition at line 100 of file LuminosityBlock.cc.

References edm::PrincipalGetAdapter::getByLabel_(), h, moduleCallingContext_, and provRecorder_.

                                                                                                                   {
    BasicHandle h = provRecorder_.getByLabel_(TypeID(iProductType), iTag, moduleCallingContext_);
    return h;
  }

template<typename PROD >

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

Definition at line 229 of file LuminosityBlock.h.

References edm::HandleBase::clear(), edm::convert_handle(), edm::HandleBase::failedToGet(), eostools::move(), PROD, edm::PRODUCT_TYPE, and edm::principal_get_adapter_detail::throwOnPrematureRead().

Referenced by EventHeader::analyze(), TrackCount::analyze(), IsoTrig::analyze(), L1GtAnalyzer::analyzeConditionsInLumiBlock(), HLTPrescaleRecorder::beginLuminosityBlock(), pat::PATTriggerEventProducer::beginLuminosityBlock(), BrilClient::dqmEndLuminosityBlock(), GenFilterEfficiencyAnalyzer::endLuminosityBlock(), DQMLumiMonitor::endLuminosityBlock(), MillePedeFileExtractor::endLuminosityBlock(), GenXSecAnalyzer::endLuminosityBlock(), VertexHistogramMaker::fill(), DigiLumiCorrHistogramMaker::fill(), edm::GetterOfProducts< trigger::HLTPrescaleTable >::fillHandles(), EDMtoMEConverter::Tokens< T >::getData(), GetLumi::getRawValue(), and AlcaBeamSpotManager::readLumi().

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

template<typename PROD >

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

Definition at line 244 of file LuminosityBlock.h.

References edm::HandleBase::clear(), edm::convert_handle(), edm::HandleBase::failedToGet(), eostools::move(), PROD, edm::PRODUCT_TYPE, and edm::principal_get_adapter_detail::throwOnPrematureRead().

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

template<typename PROD >

void LuminosityBlock::getManyByType

(

std::vector< Handle< PROD > > &

results

)

const

Definition at line 260 of file LuminosityBlock.h.

References PROD, mps_update::results, and edm::principal_get_adapter_detail::throwOnPrematureRead().

                                                                        {
    if(!provRecorder_.checkIfComplete<PROD>()) {
      principal_get_adapter_detail::throwOnPrematureRead("Lumi", TypeID(typeid(PROD)));
    }
    return provRecorder_.getManyByType(results, moduleCallingContext_);
  }

Provenance LuminosityBlock::getProvenance

(

BranchID const &

theID

)

const

Definition at line 53 of file LuminosityBlock.cc.

References edm::Principal::getProvenance(), luminosityBlockPrincipal(), and moduleCallingContext_.

                                                          {
    return luminosityBlockPrincipal().getProvenance(bid, moduleCallingContext_);
  }

Run const& edm::LuminosityBlock::getRun ( ) const

inline

Definition at line 102 of file LuminosityBlock.h.

Referenced by LumiCalculator::endLuminosityBlock(), and edm::Event::getRun().

                   {
      return *run_;
    }

LuminosityBlockIndex LuminosityBlock::index

(

)

const

Returns

Reusable index which can be used to separate data for different simultaneous LuminosityBlocks.

Definition at line 24 of file LuminosityBlock.cc.

References edm::LuminosityBlockPrincipal::index(), and luminosityBlockPrincipal().

Referenced by edm::CosMuoGenProducer::beginLuminosityBlock(), edm::BeamHaloProducer::beginLuminosityBlock(), gen::Pythia6Gun::beginLuminosityBlock(), cms::Phase2TrackerDigitizer::beginLuminosityBlock(), EcalDigiProducer::beginLuminosityBlock(), edm::GeneratorFilter< HAD, DEC >::beginLuminosityBlockProduce(), edm::HadronizerFilter< HAD, DEC >::beginLuminosityBlockProduce(), commit_(), RandomEngineStateProducer::globalBeginLuminosityBlockProduce(), GenFilterEfficiencyProducer::globalEndLuminosityBlockProduce(), BeautifulSoup.PageElement::insert(), edm::service::RandomNumberGeneratorService::preBeginLumi(), GenFilterEfficiencyProducer::produce(), and edm::service::RandomNumberGeneratorService::readFromLuminosityBlock().

                               {
    return luminosityBlockPrincipal().index();
  }

void edm::LuminosityBlock::labelsForToken ( EDGetToken const &  iToken, ProductLabels &  oLabels  ) const

inline

Definition at line 129 of file LuminosityBlock.h.

{ provRecorder_.labelsForToken(iToken, oLabels); }

LuminosityBlockAuxiliary const& edm::LuminosityBlock::luminosityBlockAuxiliary ( ) const

inlinevirtual

Implements edm::LuminosityBlockBase.

Definition at line 52 of file LuminosityBlock.h.

References diffTreeTool::index.

Referenced by PixelLumiDQM::beginLuminosityBlock(), edm::PileUp::beginLuminosityBlock(), and PixelLumiDQM::endLuminosityBlock().

{return aux_;}

LuminosityBlockPrincipal const & LuminosityBlock::luminosityBlockPrincipal ( ) const

private

Definition at line 48 of file LuminosityBlock.cc.

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

Referenced by cacheIdentifier(), commit_(), getAllStableProvenance(), getProvenance(), index(), and processHistoryID().

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

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

inline

Definition at line 127 of file LuminosityBlock.h.

Referenced by edm::PileUp::beginLuminosityBlock(), edm::PileUp::endLuminosityBlock(), and DQMEDAnalyzer::endLuminosityBlockSummary().

{ return moduleCallingContext_; }

ProcessHistory const & LuminosityBlock::processHistory

(

)

const

Definition at line 95 of file LuminosityBlock.cc.

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

Referenced by gen::BaseHadronizer::generateLHE().

                                        {
    return provRecorder_.processHistory();
  }

ProcessHistoryID const & LuminosityBlock::processHistoryID

(

)

const

Definition at line 90 of file LuminosityBlock.cc.

References luminosityBlockPrincipal(), and edm::Principal::processHistoryID().

                                          {
    return luminosityBlockPrincipal().processHistoryID();
  }

template<typename PROD >

void edm::LuminosityBlock::put ( std::unique_ptr< PROD >  product )

inline

Put a new product.

Definition at line 109 of file LuminosityBlock.h.

References eostools::move(), put(), and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by dqmservices::DQMProtobufReader::beginLuminosityBlock(), edm::GeneratorFilter< HAD, DEC >::beginLuminosityBlockProduce(), edm::HadronizerFilter< HAD, DEC >::beginLuminosityBlockProduce(), LumiProducer::beginLuminosityBlockProduce(), AlcaBeamSpotFromDB::endLuminosityBlockProduce(), AlcaBeamSpotProducer::endLuminosityBlockProduce(), MillePedeFileConverter::endLuminosityBlockProduce(), EventCountProducer::endLuminosityBlockProduce(), LogErrorEventFilter::endLuminosityBlockProduce(), ConditionDumperInEdm::endLuminosityBlockProduce(), HLTPrescaleRecorder::endLuminosityBlockProduce(), edm::GeneratorFilter< HAD, DEC >::endLuminosityBlockProduce(), edm::HadronizerFilter< HAD, DEC >::endLuminosityBlockProduce(), RandomEngineStateProducer::globalBeginLuminosityBlockProduce(), GenFilterEfficiencyProducer::globalEndLuminosityBlockProduce(), ExpressLumiProducer::writeEmptyProductForEntry(), ExpressLumiProducer::writeProductsForEntry(), and LumiProducer::writeProductsForEntry().

{put<PROD>(std::move(product), std::string());}

template<typename PROD >

void LuminosityBlock::put	(	std::unique_ptr< PROD >	product,
		std::string const &	productInstanceName
	)

Put a new product with a 'product instance name'.

Definition at line 165 of file LuminosityBlock.h.

References eostools::move(), PROD, edm::principal_get_adapter_detail::throwOnPutOfNullProduct(), and relativeConstraints::value.

                                                                                        {
    if(product.get() == nullptr) {                // null pointer is illegal
      TypeID typeID(typeid(PROD));
      principal_get_adapter_detail::throwOnPutOfNullProduct("LuminosityBlock", typeID, productInstanceName);
    }

    // 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());

    BranchDescription const& desc =
      provRecorder_.getBranchDescription(TypeID(*product), productInstanceName);

    std::unique_ptr<Wrapper<PROD> > wp(new Wrapper<PROD>(std::move(product)));
    putProducts().emplace_back(std::move(wp), &desc);

    // product.release(); // The object has been copied into the Wrapper.
    // The old copy must be deleted, so we cannot release ownership.
  }

ProductPtrVec& edm::LuminosityBlock::putProducts ( )

inlineprivate

Definition at line 139 of file LuminosityBlock.h.

Referenced by commit_().

{return putProducts_;}

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

inlineprivate

Definition at line 140 of file LuminosityBlock.h.

{return putProducts_;}

void LuminosityBlock::setConsumer

(

EDConsumerBase const *

iConsumer

)

Definition at line 33 of file LuminosityBlock.cc.

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

Referenced by edm::EDAnalyzer::doBeginLuminosityBlock(), edm::EDProducer::doBeginLuminosityBlock(), edm::EDFilter::doBeginLuminosityBlock(), edm::one::EDFilterBase::doBeginLuminosityBlock(), edm::one::EDProducerBase::doBeginLuminosityBlock(), edm::one::EDAnalyzerBase::doBeginLuminosityBlock(), edm::global::EDAnalyzerBase::doBeginLuminosityBlock(), edm::global::EDFilterBase::doBeginLuminosityBlock(), edm::global::EDProducerBase::doBeginLuminosityBlock(), edm::stream::EDAnalyzerAdaptor< T >::doBeginLuminosityBlock(), edm::stream::ProducingModuleAdaptor< T, M, B >::doBeginLuminosityBlock(), edm::EDAnalyzer::doEndLuminosityBlock(), edm::EDProducer::doEndLuminosityBlock(), edm::EDFilter::doEndLuminosityBlock(), edm::one::EDFilterBase::doEndLuminosityBlock(), edm::one::EDProducerBase::doEndLuminosityBlock(), edm::one::EDAnalyzerBase::doEndLuminosityBlock(), edm::global::EDAnalyzerBase::doEndLuminosityBlock(), edm::global::EDFilterBase::doEndLuminosityBlock(), edm::global::EDProducerBase::doEndLuminosityBlock(), edm::stream::EDAnalyzerAdaptor< T >::doEndLuminosityBlock(), edm::stream::ProducingModuleAdaptor< T, M, B >::doEndLuminosityBlock(), edm::global::EDAnalyzerBase::doStreamBeginLuminosityBlock(), edm::global::EDProducerBase::doStreamBeginLuminosityBlock(), edm::global::EDFilterBase::doStreamBeginLuminosityBlock(), edm::global::EDAnalyzerBase::doStreamEndLuminosityBlock(), edm::global::EDProducerBase::doStreamEndLuminosityBlock(), edm::global::EDFilterBase::doStreamEndLuminosityBlock(), edm::stream::EDAnalyzerAdaptorBase::doStreamEndLuminosityBlock(), and edm::stream::ProducingModuleAdaptorBase< T >::doStreamEndLuminosityBlock().

                                                              {
    provRecorder_.setConsumer(iConsumer);
    if(run_) {
      const_cast<Run*>(run_.get())->setConsumer(iConsumer);
    }
  }

void LuminosityBlock::setSharedResourcesAcquirer

(

SharedResourcesAcquirer *

iResourceAcquirer

)

Definition at line 41 of file LuminosityBlock.cc.

References provRecorder_, run_, and edm::PrincipalGetAdapter::setSharedResourcesAcquirer().

                                                                                         {
    provRecorder_.setSharedResourcesAcquirer(iResourceAcquirer);
    const_cast<Run*>(run_.get())->setSharedResourcesAcquirer(iResourceAcquirer);
  }

Friends And Related Function Documentation

friend class InputSource

friend

Definition at line 146 of file LuminosityBlock.h.

friend class ProducerBase

friend

Definition at line 148 of file LuminosityBlock.h.

friend class RawInputSource

friend

Definition at line 147 of file LuminosityBlock.h.

template<typename T >

friend class stream::ProducingModuleAdaptorBase

friend

Definition at line 149 of file LuminosityBlock.h.

Member Data Documentation

LuminosityBlockAuxiliary const& edm::LuminosityBlock::aux_

private

Definition at line 156 of file LuminosityBlock.h.

std::string const LuminosityBlock::emptyString_

staticprivate

Definition at line 160 of file LuminosityBlock.h.

ModuleCallingContext const* edm::LuminosityBlock::moduleCallingContext_

private

Definition at line 158 of file LuminosityBlock.h.

Referenced by getByLabelImpl(), and getProvenance().

PrincipalGetAdapter edm::LuminosityBlock::provRecorder_

private

Definition at line 154 of file LuminosityBlock.h.

Referenced by commit_(), getByLabelImpl(), luminosityBlockPrincipal(), processHistory(), setConsumer(), and setSharedResourcesAcquirer().

ProductPtrVec edm::LuminosityBlock::putProducts_

private

Definition at line 155 of file LuminosityBlock.h.

std::shared_ptr<Run const> const edm::LuminosityBlock::run_

private

Definition at line 157 of file LuminosityBlock.h.

Referenced by setConsumer(), and setSharedResourcesAcquirer().