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	getAllProvenance (std::vector< Provenance 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
ModuleCallingContext const *	moduleCallingContext () const
ProcessHistory const &	processHistory () const
ProcessHistoryID const &	processHistoryID () const
template<typename PROD >
void	put (std::auto_ptr< PROD > product)
	Put a new product. More...
template<typename PROD >
void	put (std::auto_ptr< PROD > product, std::string const &productInstanceName)
	Put a new product with a 'product instance name'. More...
	Run (RunPrincipal &rp, ModuleDescription const &md, ModuleCallingContext const *)
RunAuxiliary const &	runAuxiliary () const
void	setConsumer (EDConsumerBase const *iConsumer)
	~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::set< BranchID >	BranchIDSet
typedef std::vector< std::pair < WrapperOwningHolder, BranchDescription const * > >	ProductPtrVec

Private Member Functions
void	addToGotBranchIDs (Provenance const &prov) const
void	commit_ ()
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
RunPrincipal &	runPrincipal ()

Private Attributes
RunAuxiliary const &	aux_
BranchIDSet	gotBranchIDs_
ModuleCallingContext const *	moduleCallingContext_
PrincipalGetAdapter	provRecorder_
ProductPtrVec	putProducts_

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

Member Typedef Documentation

typedef PrincipalGetAdapter edm::Run::Base

Definition at line 53 of file Run.h.

typedef std::set<BranchID> edm::Run::BranchIDSet

private

Definition at line 166 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 72 of file Run.h.

typedef std::vector<std::pair<WrapperOwningHolder, BranchDescription const*> > edm::Run::ProductPtrVec

private

Definition at line 147 of file Run.h.

Constructor & Destructor Documentation

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

Definition at line 10 of file Run.cc.

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

Run::~Run

(

)

Definition at line 17 of file Run.cc.

References edm::for_all(), and putProducts_.

            {
    // anything left here must be the result of a failure
    // let's record them as failed attempts in the event principal
    for_all(putProducts_, principal_get_adapter_detail::deleter());
  }

Member Function Documentation

void Run::addToGotBranchIDs ( Provenance const &  prov ) const

private

Definition at line 113 of file Run.cc.

References edm::Provenance::branchID(), and gotBranchIDs_.

Referenced by getByLabelImpl().

                                                     {
    gotBranchIDs_.insert(prov.branchID());
  }

Run::CacheIdentifier_t Run::cacheIdentifier

(

)

const

Definition at line 24 of file Run.cc.

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

{return runPrincipal().cacheIdentifier();}

void Run::commit_ ( )

private

Definition at line 86 of file Run.cc.

References begin, end, edm::RunPrincipal::put(), putProducts(), and runPrincipal().

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

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

    while(pit != pie) {
        rp.put(*pit->second, pit->first);
        // Ownership has passed, so clear the pointer.
        pit->first.reset();
        ++pit;
    }

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

void Run::getAllProvenance

(

std::vector< Provenance const * > &

provenances

)

const

Definition at line 44 of file Run.cc.

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

Referenced by GlobalHitsProdHistStripper::beginRun(), and L1GtUtils::getL1GtTriggerMenuLiteInputTag().

                                                                       {
    runPrincipal().getAllProvenance(provenances);
  }

template<typename PROD >

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

Definition at line 200 of file Run.h.

References emptyString_.

Referenced by L1GtAnalyzer::analyzeConditionsInRunBlock(), L1GtAnalyzer::analyzeL1GtTriggerMenuLite(), LHEWriter::beginRun(), LHECOMWeightProducer::beginRun(), LHEProducer::beginRun(), LHE2HepMCConverter::beginRun(), FWFFLooper::beginRun(), edm::HadronizerFilter< HAD, DEC >::beginRun(), pat::PATTriggerProducer::beginRun(), RunHistogramManager::beginRun(), LumiCalculator::endLuminosityBlock(), ExternalLHEAsciiDumper::endRun(), AlignmentProducer::endRun(), TkLasBeamFitter::endRunProduce(), L1GtBeamModeFilter::filter(), FWFFService::postBeginRun(), EveService::postBeginRun(), and L1GtUtils::retrieveL1GtTriggerMenuLite().

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

References edm::PrincipalGetAdapter::checkIfComplete(), edm::HandleBase::clear(), edm::convert_handle(), emptyString_, edm::HandleBase::failedToGet(), edm::PrincipalGetAdapter::getByLabel_(), moduleCallingContext_, 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 224 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_, 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 118 of file Run.cc.

References addToGotBranchIDs(), edm::PrincipalGetAdapter::getByLabel_(), h, edm::BasicHandle::isValid(), moduleCallingContext_, edm::BasicHandle::provenance(), and provRecorder_.

                                                                                                       {
    BasicHandle h = provRecorder_.getByLabel_(TypeID(iProductType), iTag, moduleCallingContext_);
    if(h.isValid()) {
      addToGotBranchIDs(*(h.provenance()));
    }
    return h;
  }

template<typename PROD >

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

Definition at line 239 of file Run.h.

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

Referenced by HLTPrescaleRecorder::beginRun(), pat::PATTriggerEventProducer::beginRun(), edm::GetterOfProducts< l1extra::L1EtMissParticleCollection >::fillHandles(), and PrescaleWeightProvider::initRun().

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

References edm::PrincipalGetAdapter::checkIfComplete(), edm::HandleBase::clear(), edm::convert_handle(), edm::HandleBase::failedToGet(), edm::PrincipalGetAdapter::getByToken_(), moduleCallingContext_, 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 269 of file Run.h.

References edm::PrincipalGetAdapter::checkIfComplete(), edm::PrincipalGetAdapter::getManyByType(), moduleCallingContext_, PROD, provRecorder_, python.entryComment::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 39 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 26 of file Run.cc.

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

Referenced by BeautifulSoup.PageElement::_invert().

{ return runPrincipal().index();}

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

inline

Definition at line 135 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 108 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 103 of file Run.cc.

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

                              {
    return runPrincipal().processHistoryID();
  }

template<typename PROD >

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

inline

Put a new product.

Definition at line 107 of file Run.h.

References AlCaHLTBitMon_QueryRunRegistry::string.

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

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

template<typename PROD >

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

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

Definition at line 175 of file Run.h.

References edm::PrincipalGetAdapter::getBranchDescription(), 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.
    typename boost::mpl::if_c<detail::has_postinsert<PROD>::value,
      DoPostInsert<PROD>,
      DoNotPostInsert<PROD> >::type maybe_inserter;
    maybe_inserter(product.get());

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

    WrapperOwningHolder edp(new Wrapper<PROD>(product), Wrapper<PROD>::getInterface());
    putProducts().emplace_back(edp, &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 148 of file Run.h.

References putProducts_.

Referenced by commit_(), and put().

{return putProducts_;}

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

inlineprivate

Definition at line 149 of file Run.h.

References putProducts_.

{return putProducts_;}

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

inlinevirtual

Implements edm::RunBase.

Definition at line 55 of file Run.h.

References aux_.

Referenced by edm::PileUp::beginRun(), L1GtUtils::getL1GtRunCache(), L1GtUtils::getL1GtTriggerMenuLiteInputTag(), and L1GtUtils::retrieveL1GtTriggerMenuLite().

{return aux_;}

RunPrincipal const & Run::runPrincipal ( ) const

private

Definition at line 34 of file Run.cc.

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

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

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

RunPrincipal & Run::runPrincipal ( )

private

Definition at line 29 of file Run.cc.

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

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

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

inline

Definition at line 48 of file Run.h.

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

Referenced by edm::EDAnalyzer::doBeginRun(), edm::EDProducer::doBeginRun(), edm::EDFilter::doBeginRun(), edm::one::EDProducerBase::doBeginRun(), edm::one::EDFilterBase::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::EDProducerBase::doEndRun(), edm::one::EDFilterBase::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);
    }

Friends And Related Function Documentation

friend class InputSource

friend

Definition at line 155 of file Run.h.

friend class ProducerBase

friend

Definition at line 157 of file Run.h.

friend class RawInputSource

friend

Definition at line 156 of file Run.h.

template<typename T >

friend class stream::ProducingModuleAdaptorBase

friend

Definition at line 158 of file Run.h.

Member Data Documentation

RunAuxiliary const& edm::Run::aux_

private

Definition at line 165 of file Run.h.

Referenced by runAuxiliary().

std::string const Run::emptyString_

staticprivate

Definition at line 170 of file Run.h.

Referenced by getByLabel().

BranchIDSet edm::Run::gotBranchIDs_

mutableprivate

Definition at line 167 of file Run.h.

Referenced by addToGotBranchIDs().

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

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

ProductPtrVec edm::Run::putProducts_

private

Definition at line 164 of file Run.h.

Referenced by putProducts(), and ~Run().