edm::RunPrincipal Class Reference

#include <RunPrincipal.h>

Inheritance diagram for edm::RunPrincipal:

Public Types
typedef RunAuxiliary	Auxiliary
typedef Principal	Base
enum	ShouldWriteRun { kUninitialized, kNo, kYes }
Public Types inherited from edm::Principal
typedef std::vector< BasicHandle >	BasicHandleVec
typedef unsigned long	CacheIdentifier_t
typedef boost::filter_iterator< FilledProductPtr, ProductResolverCollection::const_iterator >	const_iterator
typedef ProductResolverBase const *	ConstProductResolverPtr
typedef boost::filter_iterator< FilledProductPtr, ProductResolverCollection::iterator >	iterator
typedef std::string	ProcessName
typedef ProcessHistory::const_iterator	ProcessNameConstIterator
typedef std::vector< propagate_const< std::shared_ptr< ProductResolverBase > > >	ProductResolverCollection
typedef std::shared_ptr< ProductResolverBase >	SharedProductPtr
typedef ProductResolverCollection::size_type	size_type

Public Member Functions
RunAuxiliary const &	aux () const
Timestamp const &	beginTime () const
Timestamp const &	endTime () const
void	fillRunPrincipal (ProcessHistoryRegistry const &processHistoryRegistry, DelayedReader *reader=nullptr)
RunID const &	id () const
RunIndex	index () const
MergeableRunProductMetadata *	mergeableRunProductMetadata ()
void	mergeAuxiliary (RunAuxiliary const &aux)
void	preReadFile ()
void	put (BranchDescription const &bd, std::unique_ptr< WrapperBase > edp) const
void	put (ProductResolverIndex index, std::unique_ptr< WrapperBase > edp) const
void	putOrMerge (BranchDescription const &bd, std::unique_ptr< WrapperBase > edp) const
ProcessHistoryID const &	reducedProcessHistoryID () const
RunNumber_t	run () const
	RunPrincipal (std::shared_ptr< ProductRegistry const > reg, ProcessConfiguration const &pc, HistoryAppender *historyAppender, unsigned int iRunIndex, bool isForPrimaryProcess=true, MergeableRunProductProcesses const *mergeableRunProductProcesses=nullptr)
void	setAux (RunAuxiliary iAux)
void	setEndTime (Timestamp const &time)
void	setShouldWriteRun (ShouldWriteRun value)
ShouldWriteRun	shouldWriteRun () const
	~RunPrincipal () override
Public Member Functions inherited from edm::Principal
void	adjustIndexesAfterProductRegistryAddition ()
bool	adjustToNewProductRegistry (ProductRegistry const &reg)
const_iterator	begin () const
iterator	begin ()
BranchType const &	branchType () const
CacheIdentifier_t	cacheIdentifier () const
void	clearPrincipal ()
void	deleteProduct (BranchID const &id) const
const_iterator	end () const
iterator	end ()
void	fillPrincipal (DelayedReader *reader)
void	fillPrincipal (ProcessHistoryID const &hist, ProcessHistory const *phr, DelayedReader *reader)
void	fillPrincipal (std::string const &processNameOfBlock, DelayedReader *reader)
ProductData const *	findProductByTag (TypeID const &typeID, InputTag const &tag, ModuleCallingContext const *mcc) const
void	getAllProvenance (std::vector< Provenance const *> &provenances) const
void	getAllStableProvenance (std::vector< StableProvenance const *> &provenances) const
BasicHandle	getByLabel (KindOfType kindOfType, TypeID const &typeID, InputTag const &inputTag, EDConsumerBase const *consumes, SharedResourcesAcquirer *sra, ModuleCallingContext const *mcc) const
BasicHandle	getByLabel (KindOfType kindOfType, TypeID const &typeID, std::string const &label, std::string const &instance, std::string const &process, EDConsumerBase const *consumes, SharedResourcesAcquirer *sra, ModuleCallingContext const *mcc) const
BasicHandle	getByToken (KindOfType kindOfType, TypeID const &typeID, ProductResolverIndex index, bool skipCurrentProcess, bool &ambiguous, SharedResourcesAcquirer *sra, ModuleCallingContext const *mcc) const
void	getManyByType (TypeID const &typeID, BasicHandleVec &results, EDConsumerBase const *consumes, SharedResourcesAcquirer *sra, ModuleCallingContext const *mcc) const
ProductResolverBase *	getModifiableProductResolver (BranchID const &oid)
ConstProductResolverPtr	getProductResolver (BranchID const &oid) const
ConstProductResolverPtr	getProductResolverByIndex (ProductResolverIndex const &oid) const
Provenance const &	getProvenance (BranchID const &bid) const
StableProvenance const &	getStableProvenance (BranchID const &bid) const
std::vector< unsigned int > const &	lookupProcessOrder () const
void	prefetchAsync (WaitingTaskHolder waitTask, ProductResolverIndex index, bool skipCurrentProcess, ServiceToken const &token, ModuleCallingContext const *mcc) const
	Principal (std::shared_ptr< ProductRegistry const > reg, std::shared_ptr< ProductResolverIndexHelper const > productLookup, ProcessConfiguration const &pc, BranchType bt, HistoryAppender *historyAppender, bool isForPrimaryProcess=true)
virtual unsigned int	processBlockIndex (std::string const &processName) const
ProcessConfiguration const &	processConfiguration () const
ProcessHistory const &	processHistory () const
ProcessHistoryID const &	processHistoryID () const
EDProductGetter const *	prodGetter () const
ProductResolverIndexHelper const &	productLookup () const
ProductRegistry const &	productRegistry () const
void	readAllFromSourceAndMergeImmediately (MergeableRunProductMetadata const *mergeableRunProductMetadata=nullptr)
DelayedReader *	reader () const
void	recombine (Principal &other, std::vector< BranchID > const &bids)
void	setupUnscheduled (UnscheduledConfigurator const &)
size_t	size () const
	~Principal () override
Public Member Functions inherited from edm::EDProductGetter
	EDProductGetter ()
	EDProductGetter (EDProductGetter const &)=delete
EDProductGetter const &	operator= (EDProductGetter const &)=delete
unsigned int	transitionIndex () const
virtual	~EDProductGetter ()

Private Member Functions
unsigned int	transitionIndex_ () const override

Private Attributes
RunAuxiliary	aux_
RunIndex	index_
ProcessHistoryID	m_reducedHistoryID
edm::propagate_const< std::unique_ptr< MergeableRunProductMetadata > >	mergeableRunProductMetadataPtr_
ShouldWriteRun	shouldWriteRun_ = kUninitialized

Additional Inherited Members
Static Public Member Functions inherited from edm::EDProductGetter
static void	assignEDProductGetter (EDProductGetter const *&)
static EDProductGetter const *	switchProductGetter (EDProductGetter const *)
	These can only be used internally by the framework. More...
Protected Member Functions inherited from edm::Principal
void	addProduct_ (std::unique_ptr< ProductResolverBase > phb)
void	addProductOrThrow (std::unique_ptr< ProductResolverBase > phb)
template<typename F >
void	applyToResolvers (F iFunc)
ProductResolverBase *	getExistingProduct (BranchID const &branchID)
ProductResolverBase const *	getExistingProduct (BranchID const &branchID) const
ProductResolverBase const *	getExistingProduct (ProductResolverBase const &phb) const
void	put_ (BranchDescription const &bd, std::unique_ptr< WrapperBase > edp) const

Detailed Description

Definition at line 34 of file RunPrincipal.h.

Member Typedef Documentation

Auxiliary

typedef RunAuxiliary edm::RunPrincipal::Auxiliary

Definition at line 36 of file RunPrincipal.h.

Base

typedef Principal edm::RunPrincipal::Base

Definition at line 37 of file RunPrincipal.h.

Member Enumeration Documentation

ShouldWriteRun

enum edm::RunPrincipal::ShouldWriteRun

Enumerator
kUninitialized
kNo
kYes

Definition at line 85 of file RunPrincipal.h.

{ kUninitialized, kNo, kYes };

Constructor & Destructor Documentation

RunPrincipal()

edm::RunPrincipal::RunPrincipal	(	std::shared_ptr< ProductRegistry const >	reg,
		ProcessConfiguration const &	pc,
		HistoryAppender *	historyAppender,
		unsigned int	iRunIndex,
		bool	isForPrimaryProcess = true,
		MergeableRunProductProcesses const *	mergeableRunProductProcesses = nullptr
	)

Definition at line 11 of file RunPrincipal.cc.

References mergeableRunProductMetadataPtr_.

      : Base(reg, reg->productLookup(InRun), pc, InRun, historyAppender, isForPrimaryProcess), index_(iRunIndex) {
    if (mergeableRunProductProcesses) {  // primary RunPrincipals of EventProcessor
      mergeableRunProductMetadataPtr_ = (std::make_unique<MergeableRunProductMetadata>(*mergeableRunProductProcesses));
    }
  }

~RunPrincipal()

edm::RunPrincipal::~RunPrincipal ( )

override

Definition at line 23 of file RunPrincipal.cc.

{}

Member Function Documentation

aux()

RunAuxiliary const& edm::RunPrincipal::aux ( ) const

inline

Definition at line 59 of file RunPrincipal.h.

References aux_.

Referenced by beginTime(), edm::SubProcess::doBeginRunAsync(), endTime(), id(), mergeAuxiliary(), edm::PoolSource::readRun_(), and run().

{ return aux_; }

beginTime()

Timestamp const& edm::RunPrincipal::beginTime ( ) const

inline

Definition at line 67 of file RunPrincipal.h.

References aux(), and edm::RunAuxiliary::beginTime().

Referenced by edm::EDLooperBase::doBeginRun(), EcalSignalGenerator< EEDigitizerTraits >::initializeEvent(), edm::OccurrenceTraits< RunPrincipal, BranchActionGlobalBegin >::makeGlobalContext(), and edm::OccurrenceTraits< RunPrincipal, BranchActionStreamBegin >::setStreamContext().

{ return aux().beginTime(); }

endTime()

Timestamp const& edm::RunPrincipal::endTime ( ) const

inline

Definition at line 69 of file RunPrincipal.h.

References aux(), and edm::RunAuxiliary::endTime().

Referenced by edm::EDLooperBase::doEndRun(), edm::EventProcessor::endRunAsync(), edm::OccurrenceTraits< RunPrincipal, BranchActionGlobalEnd >::makeGlobalContext(), edm::OccurrenceTraits< RunPrincipal, BranchActionStreamEnd >::setStreamContext(), edm::OutputModuleCommunicatorT< T >::writeRunAsync(), and edm::Schedule::writeRunAsync().

{ return aux().endTime(); }

fillRunPrincipal()

void edm::RunPrincipal::fillRunPrincipal	(	ProcessHistoryRegistry const &	processHistoryRegistry,
		DelayedReader *	reader = nullptr
	)

Definition at line 25 of file RunPrincipal.cc.

References aux_, edm::Principal::fillPrincipal(), edm::ProcessHistoryRegistry::getMapped(), m_reducedHistoryID, mergeableRunProductMetadataPtr_, edm::RunAuxiliary::processHistoryID(), dumpMFGeometry_cfg::prod, edm::Principal::reader(), and edm::ProcessHistoryRegistry::reducedProcessHistoryID().

Referenced by dqmservices::DQMProtobufReader::readRun_(), edmtest::PutOrMergeTestSource::readRun_(), LH5Source::readRun_(), LHESource::readRun_(), edm::RootFile::readRun_(), DQMRootSource::readRun_(), and edm::InputSource::readRun_().

                                                                                                                 {
    m_reducedHistoryID = processHistoryRegistry.reducedProcessHistoryID(aux_.processHistoryID());
    auto history = processHistoryRegistry.getMapped(aux_.processHistoryID());
    fillPrincipal(aux_.processHistoryID(), history, reader);

    for (auto& prod : *this) {
      prod->setMergeableRunProductMetadata(mergeableRunProductMetadataPtr_.get());
    }
  }

id()

RunID const& edm::RunPrincipal::id ( void  ) const

inline

Definition at line 65 of file RunPrincipal.h.

References aux(), and edm::RunAuxiliary::id().

Referenced by DQMRootSource::readRun_().

{ return aux().id(); }

index()

RunIndex edm::RunPrincipal::index ( ) const

inline

Multiple Runs may be processed simultaneously. The return value can be used to identify a particular Run. The value will range from 0 to one less than the maximum number of allowed simultaneous Runs. A particular value will be reused once the processing of the previous Run using that index has been completed.

Definition at line 56 of file RunPrincipal.h.

References index_.

Referenced by edm::SubProcess::clearRunPrincipal(), edm::EDLooperBase::doBeginLuminosityBlock(), edm::stream::EDAnalyzerAdaptor< T >::doBeginLuminosityBlock(), edm::stream::ProducingModuleAdaptor< T, M, B >::doBeginLuminosityBlock(), edm::SubProcess::doBeginLuminosityBlockAsync(), edm::EDLooperBase::doBeginRun(), edm::stream::EDAnalyzerAdaptor< T >::doBeginRun(), edm::stream::ProducingModuleAdaptor< T, M, B >::doBeginRun(), edm::SubProcess::doBeginRunAsync(), edm::EDLooperBase::doDuringLoop(), edm::EDLooperBase::doEndLuminosityBlock(), edm::stream::EDAnalyzerAdaptor< T >::doEndLuminosityBlock(), edm::stream::ProducingModuleAdaptor< T, M, B >::doEndLuminosityBlock(), edm::EDLooperBase::doEndRun(), edm::stream::EDAnalyzerAdaptor< T >::doEndRun(), edm::stream::ProducingModuleAdaptor< T, M, B >::doEndRun(), edm::SubProcess::doEndRunAsync(), edm::stream::EDAnalyzerAdaptorBase::doStreamBeginRun(), edm::stream::ProducingModuleAdaptorBase< EDProducerBase >::doStreamBeginRun(), edm::SubProcess::doStreamBeginRunAsync(), edm::SubProcess::doStreamEndRunAsync(), edm::RunForOutput::index(), edm::Run::index(), BeautifulSoup.PageElement::insert(), edm::OccurrenceTraits< RunPrincipal, BranchActionGlobalBegin >::makeGlobalContext(), edm::OccurrenceTraits< RunPrincipal, BranchActionGlobalEnd >::makeGlobalContext(), edm::OccurrenceTraits< LuminosityBlockPrincipal, BranchActionGlobalBegin >::makeGlobalContext(), edm::OccurrenceTraits< LuminosityBlockPrincipal, BranchActionGlobalEnd >::makeGlobalContext(), put(), edm::InputSource::readAndMergeRun(), edm::InputSource::readRun(), edm::PoolSource::readRun_(), edm::OccurrenceTraits< RunPrincipal, BranchActionStreamBegin >::setStreamContext(), edm::OccurrenceTraits< RunPrincipal, BranchActionStreamEnd >::setStreamContext(), edm::OccurrenceTraits< LuminosityBlockPrincipal, BranchActionStreamBegin >::setStreamContext(), edm::OccurrenceTraits< LuminosityBlockPrincipal, BranchActionStreamEnd >::setStreamContext(), transitionIndex_(), edm::OutputModuleCommunicatorT< T >::writeLumiAsync(), edm::Schedule::writeLumiAsync(), edm::OutputModuleCommunicatorT< T >::writeRunAsync(), edm::SubProcess::writeRunAsync(), and edm::Schedule::writeRunAsync().

{ return index_; }

mergeableRunProductMetadata()

MergeableRunProductMetadata* edm::RunPrincipal::mergeableRunProductMetadata ( )

inline

Definition at line 81 of file RunPrincipal.h.

References mergeableRunProductMetadataPtr_.

Referenced by edm::RootFile::readRun_(), and edm::EventProcessor::writeLumiAsync().

{ return mergeableRunProductMetadataPtr_.get(); }

mergeAuxiliary()

void edm::RunPrincipal::mergeAuxiliary ( RunAuxiliary const &  aux )

inline

Definition at line 73 of file RunPrincipal.h.

References aux(), aux_, and edm::RunAuxiliary::mergeAuxiliary().

Referenced by edm::EventProcessor::readAndMergeRun().

{ return aux_.mergeAuxiliary(aux); }

preReadFile()

void edm::RunPrincipal::preReadFile

(

)

Definition at line 57 of file RunPrincipal.cc.

References mergeableRunProductMetadataPtr_.

                                 {
    if (mergeableRunProductMetadataPtr_) {
      mergeableRunProductMetadataPtr_->preReadFile();
    }
  }

put() [1/2]

void edm::RunPrincipal::put	(	BranchDescription const &	bd,
		std::unique_ptr< WrapperBase >	edp
	)		const

Definition at line 35 of file RunPrincipal.cc.

References eostools::move(), and edm::Principal::put_().

Referenced by edm::Run::commit_(), and LH5Source::putRunInfoProduct().

                                                                                          {
    put_(bd, std::move(edp));
  }

put() [2/2]

void edm::RunPrincipal::put	(	ProductResolverIndex	index,
		std::unique_ptr< WrapperBase >	edp
	)		const

Definition at line 39 of file RunPrincipal.cc.

References runTheMatrix::const, edm::Principal::getProductResolverByIndex(), index(), and eostools::move().

                                                                                         {
    auto phb = getProductResolverByIndex(index);
    dynamic_cast<ProductPutterBase const*>(phb)->putProduct(std::move(edp));
  }

putOrMerge()

void edm::RunPrincipal::putOrMerge	(	BranchDescription const &	bd,
		std::unique_ptr< WrapperBase >	edp
	)		const

Definition at line 44 of file RunPrincipal.cc.

References cms::cuda::assert(), runTheMatrix::const, Exception, edm::Principal::getExistingProduct(), edm::errors::InsertFailure, eostools::move(), and dumpMFGeometry_cfg::prod.

Referenced by LHESource::putRunInfoProduct(), and edmtest::PutOrMergeTestSource::readRun_().

                                                                                                  {
    if (prod.get() == nullptr) {
      throw edm::Exception(edm::errors::InsertFailure, "Null Pointer")
          << "putOrMerge: Cannot put because unique_ptr to product is null."
          << "\n";
    }
    auto phb = getExistingProduct(bd.branchID());
    assert(phb);
    dynamic_cast<ProductPutOrMergerBase const*>(phb)->putOrMergeProduct(std::move(prod));
  }

reducedProcessHistoryID()

ProcessHistoryID const& edm::RunPrincipal::reducedProcessHistoryID ( ) const

inline

Definition at line 63 of file RunPrincipal.h.

References m_reducedHistoryID.

{ return m_reducedHistoryID; }

run()

RunNumber_t edm::RunPrincipal::run ( ) const

inline

Definition at line 61 of file RunPrincipal.h.

References aux(), and edm::RunAuxiliary::run().

Referenced by Types.EventID::cppID(), Types.LuminosityBlockID::cppID(), edm::EDLooperBase::doBeginRun(), edm::EDLooperBase::doEndRun(), edm::EventProcessor::endRunAsync(), edm::OccurrenceTraits< RunPrincipal, BranchActionGlobalBegin >::makeGlobalContext(), edm::OccurrenceTraits< RunPrincipal, BranchActionGlobalEnd >::makeGlobalContext(), edm::PoolSource::readRun_(), edm::OccurrenceTraits< RunPrincipal, BranchActionStreamBegin >::setStreamContext(), edm::OccurrenceTraits< RunPrincipal, BranchActionStreamEnd >::setStreamContext(), edm::OutputModuleCommunicatorT< T >::writeRunAsync(), and edm::Schedule::writeRunAsync().

{ return aux().run(); }

setAux()

void edm::RunPrincipal::setAux ( RunAuxiliary  iAux )

inline

Definition at line 58 of file RunPrincipal.h.

References aux_.

{ aux_ = iAux; }

setEndTime()

void edm::RunPrincipal::setEndTime ( Timestamp const &  time )

inline

Definition at line 71 of file RunPrincipal.h.

References aux_, edm::RunAuxiliary::setEndTime(), and protons_cff::time.

Referenced by edm::EventProcessor::endRunAsync().

{ aux_.setEndTime(time); }

setShouldWriteRun()

void edm::RunPrincipal::setShouldWriteRun ( ShouldWriteRun  value )

inline

Definition at line 87 of file RunPrincipal.h.

References shouldWriteRun_, and relativeConstraints::value.

Referenced by edm::RootFile::readRun_().

{ shouldWriteRun_ = value; }

shouldWriteRun()

ShouldWriteRun edm::RunPrincipal::shouldWriteRun ( ) const

inline

Definition at line 86 of file RunPrincipal.h.

References shouldWriteRun_.

Referenced by edm::RootFile::readRun_(), and edm::EventProcessor::writeRunAsync().

{ return shouldWriteRun_; }

transitionIndex_()

unsigned int edm::RunPrincipal::transitionIndex_ ( ) const

overrideprivatevirtual

Implements edm::EDProductGetter.

Definition at line 55 of file RunPrincipal.cc.

References index(), and edm::RunIndex::value().

{ return index().value(); }

Member Data Documentation

aux_

RunAuxiliary edm::RunPrincipal::aux_

private

Definition at line 92 of file RunPrincipal.h.

Referenced by aux(), fillRunPrincipal(), mergeAuxiliary(), setAux(), and setEndTime().

index_

RunIndex edm::RunPrincipal::index_

private

Definition at line 94 of file RunPrincipal.h.

Referenced by index().

m_reducedHistoryID

ProcessHistoryID edm::RunPrincipal::m_reducedHistoryID

private

Definition at line 93 of file RunPrincipal.h.

Referenced by fillRunPrincipal(), and reducedProcessHistoryID().

mergeableRunProductMetadataPtr_

edm::propagate_const<std::unique_ptr<MergeableRunProductMetadata> > edm::RunPrincipal::mergeableRunProductMetadataPtr_

private

Definition at line 99 of file RunPrincipal.h.

Referenced by fillRunPrincipal(), mergeableRunProductMetadata(), preReadFile(), and RunPrincipal().

shouldWriteRun_

ShouldWriteRun edm::RunPrincipal::shouldWriteRun_ = kUninitialized

private

Definition at line 101 of file RunPrincipal.h.

Referenced by setShouldWriteRun(), and shouldWriteRun().