edm::Run Class Reference

#include <Run.h>

Inheritance diagram for edm::Run:

Public Types
typedef PrincipalGetAdapter	Base
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
RunIndex	index () const
void	labelsForToken (EDGetToken const &iToken, ProductLabels &oLabels) 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...
	Run (RunPrincipal const &rp, ModuleDescription const &md, ModuleCallingContext const *)
RunAuxiliary const &	runAuxiliary () const
void	setConsumer (EDConsumerBase const *iConsumer)
void	setSharedResourcesAcquirer (SharedResourcesAcquirer *iResourceAcquirer)
	~Run ()
Public Member Functions inherited from edm::RunBase
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<typename T >
bool	getByLabel (InputTag const &tag, Handle< T > &result) const
RunID const &	id () const
RunNumber_t	run () const
	RunBase ()
virtual	~RunBase ()

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
ProductPtrVec &	putProducts ()
ProductPtrVec const &	putProducts () const
RunPrincipal const &	runPrincipal () const

Private Attributes
RunAuxiliary const &	aux_
ModuleCallingContext const *	moduleCallingContext_
PrincipalGetAdapter	provRecorder_
ProductPtrVec	putProducts_
SharedResourcesAcquirer *	sharedResourcesAcquirer_

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 42 of file Run.h.

Member Typedef Documentation

typedef PrincipalGetAdapter edm::Run::Base

Definition at line 57 of file Run.h.

typedef unsigned long edm::Run::CacheIdentifier_t

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

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

private

Definition at line 150 of file Run.h.

Constructor & Destructor Documentation

Run::Run	(	RunPrincipal const &	rp,
		ModuleDescription const &	md,
		ModuleCallingContext const *	moduleCallingContext
	)

Definition at line 11 of file Run.cc.

                                                             :
        provRecorder_(rp, md),
        aux_(rp.aux()),
        moduleCallingContext_(moduleCallingContext)  {
  }

Run::~Run

(

)

Definition at line 18 of file Run.cc.

            {
  }

Member Function Documentation

Run::CacheIdentifier_t Run::cacheIdentifier

(

)

const

Definition at line 22 of file Run.cc.

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

{return runPrincipal().cacheIdentifier();}

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

private

Definition at line 79 of file Run.cc.

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

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

                                                                   {
    RunPrincipal const& rp = runPrincipal();
    ProductPtrVec::iterator pit(putProducts().begin());
    ProductPtrVec::iterator pie(putProducts().end());

    while(pit != pie) {
        rp.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 Run::getAllStableProvenance

(

std::vector< StableProvenance const * > &

provenances

)

const

Definition at line 37 of file Run.cc.

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

Referenced by GlobalHitsProdHistStripper::beginRun().

                                                                                   {
    runPrincipal().getAllStableProvenance(provenances);
  }

template<typename PROD >

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

Definition at line 201 of file Run.h.

References emptyString_.

Referenced by LHECOMWeightProducer::beginRun(), LHE2HepMCConverter::beginRun(), FWFFLooper::beginRun(), pat::PATTriggerProducer::beginRun(), edm::HadronizerFilter< HAD, DEC >::beginRun(), LumiCalculator::endLuminosityBlock(), ExternalLHEAsciiDumper::endRun(), AlignmentProducer::endRun(), TkLasBeamFitter::endRunProduce(), AdHocNTupler::fill(), L1GtBeamModeFilter::filter(), and FWFFService::postBeginRun().

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

template<typename PROD >

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

Definition at line 207 of file Run.h.

References edm::PrincipalGetAdapter::checkIfComplete(), edm::HandleBase::clear(), edm::convert_handle(), emptyString_, edm::HandleBase::failedToGet(), edm::PrincipalGetAdapter::getByLabel_(), moduleCallingContext_, eostools::move(), PROD, provRecorder_, and edm::principal_get_adapter_detail::throwOnPrematureRead().

                                              {
    if(!provRecorder_.checkIfComplete<PROD>()) {
      principal_get_adapter_detail::throwOnPrematureRead("Run", 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 Run::getByLabel	(	InputTag const &	tag,
		Handle< PROD > &	result
	)		const

same as above, but using the InputTag class

Definition at line 225 of file Run.h.

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

                                                                 {
    if(!provRecorder_.checkIfComplete<PROD>()) {
      principal_get_adapter_detail::throwOnPrematureRead("Run", 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 Run::getByLabelImpl ( std::type_info const &  iWrapperType, std::type_info const &  iProductType, InputTag const &  iTag  ) const

privatevirtual

Implements edm::RunBase.

Definition at line 116 of file Run.cc.

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

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

template<typename PROD >

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

Definition at line 240 of file Run.h.

References edm::PrincipalGetAdapter::checkIfComplete(), edm::HandleBase::clear(), edm::convert_handle(), edm::HandleBase::failedToGet(), edm::PrincipalGetAdapter::getByToken_(), moduleCallingContext_, eostools::move(), PROD, edm::PRODUCT_TYPE, provRecorder_, and edm::principal_get_adapter_detail::throwOnPrematureRead().

Referenced by L1GtAnalyzer::analyzeConditionsInRunBlock(), L1GtAnalyzer::analyzeL1GtTriggerMenuLite(), HLTPrescaleRecorder::beginRun(), pat::PATTriggerEventProducer::beginRun(), RunHistogramManager::beginRun(), LHEWriter::endRun(), GenXSecAnalyzer::endRun(), PCLTrackerAlProducer::endRun(), edm::GetterOfProducts< trigger::HLTPrescaleTable >::fillHandles(), EDMtoMEConverter::Tokens< T >::getData(), PrescaleWeightProvider::initRun(), and L1GtUtils::retrieveL1GtTriggerMenuLite().

                                                              {
    if(!provRecorder_.checkIfComplete<PROD>()) {
      principal_get_adapter_detail::throwOnPrematureRead("Run", 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 Run::getByToken	(	EDGetTokenT< PROD >	token,
		Handle< PROD > &	result
	)		const

Definition at line 255 of file Run.h.

References edm::PrincipalGetAdapter::checkIfComplete(), edm::HandleBase::clear(), edm::convert_handle(), edm::HandleBase::failedToGet(), edm::PrincipalGetAdapter::getByToken_(), moduleCallingContext_, eostools::move(), PROD, edm::PRODUCT_TYPE, provRecorder_, and edm::principal_get_adapter_detail::throwOnPrematureRead().

                                                                     {
    if(!provRecorder_.checkIfComplete<PROD>()) {
      principal_get_adapter_detail::throwOnPrematureRead("Run", 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 Run::getManyByType

(

std::vector< Handle< PROD > > &

results

)

const

Definition at line 270 of file Run.h.

References edm::PrincipalGetAdapter::checkIfComplete(), edm::PrincipalGetAdapter::getManyByType(), moduleCallingContext_, PROD, provRecorder_, mps_update::results, and edm::principal_get_adapter_detail::throwOnPrematureRead().

Referenced by GlobalHitsProdHistStripper::endRun().

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

Provenance Run::getProvenance

(

BranchID const &

theID

)

const

Definition at line 32 of file Run.cc.

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

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

RunIndex Run::index

(

)

const

Returns

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

Definition at line 24 of file Run.cc.

References edm::RunPrincipal::index(), and runPrincipal().

Referenced by BeautifulSoup.PageElement::_invert(), and commit_().

{ return runPrincipal().index();}

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

inline

Definition at line 141 of file Run.h.

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

{ provRecorder_.labelsForToken(iToken, oLabels); }

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

inline

Definition at line 139 of file Run.h.

References moduleCallingContext_.

Referenced by DQMEDAnalyzer::beginRun(), edm::PileUp::beginRun(), edm::PileUp::endRun(), and DQMEDAnalyzer::endRunSummary().

{ return moduleCallingContext_; }

ProcessHistory const & Run::processHistory

(

)

const

Definition at line 111 of file Run.cc.

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

Referenced by EcalTrigPrimProducer::beginRun(), pat::PATTriggerEventProducer::beginRun(), MEtoMEComparitor::beginRun(), pat::PATTriggerProducer::beginRun(), and HLTConfigProvider::init().

                            {
    return provRecorder_.processHistory();
  }

ProcessHistoryID const & Run::processHistoryID

(

)

const

Definition at line 106 of file Run.cc.

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

                              {
    return runPrincipal().processHistoryID();
  }

template<typename PROD >

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

inline

Put a new product.

Definition at line 111 of file Run.h.

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

Referenced by AlpgenSource::beginRun(), MCatNLOSource::beginRun(), L1GtTriggerMenuLiteProducer::beginRunProduce(), ExternalLHEProducer::beginRunProduce(), edm::FlatBaseThetaGunProducer::endRunProduce(), edm::CosMuoGenProducer::endRunProduce(), edm::BaseFlatGunProducer::endRunProduce(), edm::BaseRandomtXiGunProducer::endRunProduce(), edm::BeamHaloProducer::endRunProduce(), HLTPrescaleRecorder::endRunProduce(), ConditionDumperInEdm::endRunProduce(), edm::GeneratorFilter< HAD, DEC >::endRunProduce(), TkLasBeamFitter::endRunProduce(), edm::HadronizerFilter< HAD, DEC >::endRunProduce(), ExternalLHEProducer::endRunProduce(), GlobalHitsProdHist::endRunProduce(), LaserAlignment::endRunProduce(), and LumiProducer::endRunProduce().

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

template<typename PROD >

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

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

Definition at line 176 of file Run.h.

References edm::PrincipalGetAdapter::getBranchDescription(), eostools::move(), PROD, provRecorder_, putProducts(), edm::principal_get_adapter_detail::throwOnPutOfNullProduct(), and relativeConstraints::value.

                                                                            {
    if (product.get() == 0) {                // null pointer is illegal
      TypeID typeID(typeid(PROD));
      principal_get_adapter_detail::throwOnPutOfNullProduct("Run", 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::Run::putProducts ( )

inlineprivate

Definition at line 151 of file Run.h.

References putProducts_.

Referenced by commit_(), and put().

{return putProducts_;}

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

inlineprivate

Definition at line 152 of file Run.h.

References putProducts_.

{return putProducts_;}

RunAuxiliary const& edm::Run::runAuxiliary ( ) const

inlinevirtual

Implements edm::RunBase.

Definition at line 59 of file Run.h.

References aux_.

Referenced by hcaldqm::DQHarvester::beginRun(), edm::PileUp::beginRun(), LaserTask::bookHistograms(), LEDTask::bookHistograms(), QIE10Task::bookHistograms(), QIE11Task::bookHistograms(), PedestalTask::bookHistograms(), UMNioTask::bookHistograms(), LaserTask::endRun(), LEDTask::endRun(), UMNioTask::endRun(), PedestalTask::endRun(), L1GtUtils::getL1GtRunCache(), and L1GtUtils::retrieveL1GtTriggerMenuLite().

{return aux_;}

RunPrincipal const & Run::runPrincipal ( ) const

private

Definition at line 27 of file Run.cc.

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

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

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

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

inline

Definition at line 49 of file Run.h.

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

Referenced by edm::EDAnalyzer::doBeginRun(), edm::EDProducer::doBeginRun(), edm::EDFilter::doBeginRun(), edm::one::EDFilterBase::doBeginRun(), edm::one::EDProducerBase::doBeginRun(), edm::one::EDAnalyzerBase::doBeginRun(), edm::global::EDAnalyzerBase::doBeginRun(), edm::global::EDFilterBase::doBeginRun(), edm::global::EDProducerBase::doBeginRun(), edm::stream::ProducingModuleAdaptor< T, M, B >::doBeginRun(), edm::stream::EDAnalyzerAdaptor< T >::doBeginRun(), edm::EDAnalyzer::doEndRun(), edm::EDProducer::doEndRun(), edm::EDFilter::doEndRun(), edm::one::EDFilterBase::doEndRun(), edm::one::EDProducerBase::doEndRun(), edm::one::EDAnalyzerBase::doEndRun(), edm::global::EDAnalyzerBase::doEndRun(), edm::global::EDFilterBase::doEndRun(), edm::global::EDProducerBase::doEndRun(), edm::stream::ProducingModuleAdaptor< T, M, B >::doEndRun(), edm::stream::EDAnalyzerAdaptor< T >::doEndRun(), edm::global::EDAnalyzerBase::doStreamBeginRun(), edm::global::EDFilterBase::doStreamBeginRun(), edm::global::EDProducerBase::doStreamBeginRun(), edm::global::EDAnalyzerBase::doStreamEndRun(), edm::global::EDFilterBase::doStreamEndRun(), edm::global::EDProducerBase::doStreamEndRun(), edm::stream::EDAnalyzerAdaptorBase::doStreamEndRun(), and edm::stream::ProducingModuleAdaptorBase< T >::doStreamEndRun().

                                                      {
      provRecorder_.setConsumer(iConsumer);
    }

void edm::Run::setSharedResourcesAcquirer ( SharedResourcesAcquirer *  iResourceAcquirer )

inline

Definition at line 53 of file Run.h.

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

                                                                                 {
      provRecorder_.setSharedResourcesAcquirer(iResourceAcquirer);
    }

Friends And Related Function Documentation

friend class InputSource

friend

Definition at line 158 of file Run.h.

friend class ProducerBase

friend

Definition at line 160 of file Run.h.

friend class RawInputSource

friend

Definition at line 159 of file Run.h.

template<typename T >

friend class stream::ProducingModuleAdaptorBase

friend

Definition at line 161 of file Run.h.

Member Data Documentation

RunAuxiliary const& edm::Run::aux_

private

Definition at line 167 of file Run.h.

Referenced by runAuxiliary().

std::string const Run::emptyString_

staticprivate

Definition at line 171 of file Run.h.

Referenced by getByLabel().

ModuleCallingContext const* edm::Run::moduleCallingContext_

private

Definition at line 168 of file Run.h.

Referenced by getByLabel(), getByLabelImpl(), getByToken(), getManyByType(), getProvenance(), and moduleCallingContext().

PrincipalGetAdapter edm::Run::provRecorder_

private

Definition at line 165 of file Run.h.

Referenced by commit_(), getByLabel(), getByLabelImpl(), getByToken(), getManyByType(), labelsForToken(), processHistory(), put(), runPrincipal(), setConsumer(), and setSharedResourcesAcquirer().

ProductPtrVec edm::Run::putProducts_

private

Definition at line 166 of file Run.h.

Referenced by putProducts().

SharedResourcesAcquirer* edm::Run::sharedResourcesAcquirer_

private

Definition at line 169 of file Run.h.