CMS 3D CMS Logo

List of all members | Public Types | Public Member Functions | Private Member Functions | Private Attributes
edm::RunPrincipal Class Reference

#include <RunPrincipal.h>

Inheritance diagram for edm::RunPrincipal:
edm::Principal edm::EDProductGetter

Public Types

typedef RunAuxiliary Auxiliary
 
typedef Principal Base
 
- Public Types inherited from edm::Principal
typedef std::vector< BasicHandleBasicHandleVec
 
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< ProductResolverBaseSharedProductPtr
 
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
 
MergeableRunProductMetadatamergeableRunProductMetadata ()
 
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< RunAuxiliary > aux, std::shared_ptr< ProductRegistry const > reg, ProcessConfiguration const &pc, HistoryAppender *historyAppender, unsigned int iRunIndex, bool isForPrimaryProcess=true, MergeableRunProductProcesses const *mergeableRunProductProcesses=nullptr)
 
void setEndTime (Timestamp const &time)
 
 ~RunPrincipal () override
 
- Public Member Functions inherited from edm::Principal
void adjustIndexesAfterProductRegistryAddition ()
 
bool adjustToNewProductRegistry (ProductRegistry const &reg)
 
iterator begin ()
 
const_iterator begin () const
 
BranchType const & branchType () const
 
CacheIdentifier_t cacheIdentifier () const
 
void clearPrincipal ()
 
void deleteProduct (BranchID const &id) const
 
iterator end ()
 
const_iterator end () const
 
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
 
ProductResolverBasegetModifiableProductResolver (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)
 
DelayedReaderreader () 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

edm::propagate_const< std::shared_ptr< RunAuxiliary > > aux_
 
RunIndex index_
 
ProcessHistoryID m_reducedHistoryID
 
edm::propagate_const< std::unique_ptr< MergeableRunProductMetadata > > mergeableRunProductMetadataPtr_
 

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)
 
ProductResolverBasegetExistingProduct (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

Definition at line 36 of file RunPrincipal.h.

◆ Base

Definition at line 37 of file RunPrincipal.h.

Constructor & Destructor Documentation

◆ RunPrincipal()

edm::RunPrincipal::RunPrincipal ( std::shared_ptr< RunAuxiliary aux,
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.

18  : Base(reg, reg->productLookup(InRun), pc, InRun, historyAppender, isForPrimaryProcess),
19  aux_(aux),
20  index_(iRunIndex) {
21  if (mergeableRunProductProcesses) { // primary RunPrincipals of EventProcessor
22  mergeableRunProductMetadataPtr_ = (std::make_unique<MergeableRunProductMetadata>(*mergeableRunProductProcesses));
23  }
24  }

References mergeableRunProductMetadataPtr_.

◆ ~RunPrincipal()

edm::RunPrincipal::~RunPrincipal ( )
override

Definition at line 26 of file RunPrincipal.cc.

26 {}

Member Function Documentation

◆ aux()

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

Definition at line 59 of file RunPrincipal.h.

59 { return *aux_; }

References aux_.

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

◆ beginTime()

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

◆ endTime()

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

◆ fillRunPrincipal()

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

Definition at line 28 of file RunPrincipal.cc.

28  {
29  m_reducedHistoryID = processHistoryRegistry.reducedProcessHistoryID(aux_->processHistoryID());
30  auto history = processHistoryRegistry.getMapped(aux_->processHistoryID());
31  fillPrincipal(aux_->processHistoryID(), history, reader);
32 
33  for (auto& prod : *this) {
34  prod->setMergeableRunProductMetadata(mergeableRunProductMetadataPtr_.get());
35  }
36  }

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

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

◆ id()

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

Definition at line 65 of file RunPrincipal.h.

65 { return aux().id(); }

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

Referenced by DQMRootSource::readRun_().

◆ 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 57 of file RunPrincipal.h.

57 { return index_; }

References index_.

Referenced by edm::EDLooperBase::doBeginLuminosityBlock(), edm::stream::EDAnalyzerAdaptor< T >::doBeginLuminosityBlock(), edm::stream::ProducingModuleAdaptor< T, M, B >::doBeginLuminosityBlock(), 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::stream::EDAnalyzerAdaptorBase::doStreamBeginRun(), edm::stream::ProducingModuleAdaptorBase< EDProducerBase >::doStreamBeginRun(), 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(), and edm::Schedule::writeRunAsync().

◆ mergeableRunProductMetadata()

MergeableRunProductMetadata* edm::RunPrincipal::mergeableRunProductMetadata ( )
inline

◆ mergeAuxiliary()

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

Definition at line 73 of file RunPrincipal.h.

73 { return aux_->mergeAuxiliary(aux); }

References aux(), and aux_.

◆ preReadFile()

void edm::RunPrincipal::preReadFile ( )

Definition at line 60 of file RunPrincipal.cc.

60  {
62  mergeableRunProductMetadataPtr_->preReadFile();
63  }
64  }

References mergeableRunProductMetadataPtr_.

◆ put() [1/2]

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

Definition at line 38 of file RunPrincipal.cc.

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

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

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

◆ put() [2/2]

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

Definition at line 42 of file RunPrincipal.cc.

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

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

◆ putOrMerge()

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

Definition at line 47 of file RunPrincipal.cc.

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

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

Referenced by LHESource::putRunInfoProduct().

◆ reducedProcessHistoryID()

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

Definition at line 63 of file RunPrincipal.h.

63 { return m_reducedHistoryID; }

References m_reducedHistoryID.

Referenced by edm::SubProcess::doBeginRunAsync().

◆ run()

RunNumber_t edm::RunPrincipal::run ( ) const
inline

◆ setEndTime()

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

Definition at line 71 of file RunPrincipal.h.

71 { aux_->setEndTime(time); }

References aux_, and protons_cff::time.

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

◆ transitionIndex_()

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

Implements edm::EDProductGetter.

Definition at line 58 of file RunPrincipal.cc.

58 { return index().value(); }

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

Member Data Documentation

◆ aux_

edm::propagate_const<std::shared_ptr<RunAuxiliary> > edm::RunPrincipal::aux_
private

Definition at line 88 of file RunPrincipal.h.

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

◆ index_

RunIndex edm::RunPrincipal::index_
private

Definition at line 90 of file RunPrincipal.h.

Referenced by index().

◆ m_reducedHistoryID

ProcessHistoryID edm::RunPrincipal::m_reducedHistoryID
private

Definition at line 89 of file RunPrincipal.h.

Referenced by fillRunPrincipal(), and reducedProcessHistoryID().

◆ mergeableRunProductMetadataPtr_

edm::propagate_const<std::unique_ptr<MergeableRunProductMetadata> > edm::RunPrincipal::mergeableRunProductMetadataPtr_
private
edm::RunPrincipal::mergeableRunProductMetadataPtr_
edm::propagate_const< std::unique_ptr< MergeableRunProductMetadata > > mergeableRunProductMetadataPtr_
Definition: RunPrincipal.h:95
edm::RunPrincipal::Base
Principal Base
Definition: RunPrincipal.h:37
edm::Principal::put_
void put_(BranchDescription const &bd, std::unique_ptr< WrapperBase > edp) const
Definition: Principal.cc:927
deep_tau::DeepTauBase::BasicDiscriminator
BasicDiscriminator
Definition: DeepTauBase.h:115
cms::cuda::assert
assert(be >=bs)
protons_cff.time
time
Definition: protons_cff.py:35
edm::RunPrincipal::aux
RunAuxiliary const & aux() const
Definition: RunPrincipal.h:59
edm::InRun
Definition: BranchType.h:11
edm::Principal::getProductResolverByIndex
ConstProductResolverPtr getProductResolverByIndex(ProductResolverIndex const &oid) const
Definition: Principal.cc:562
edm::RunPrincipal::aux_
edm::propagate_const< std::shared_ptr< RunAuxiliary > > aux_
Definition: RunPrincipal.h:88
edm::Principal::reader
DelayedReader * reader() const
Definition: Principal.h:187
dumpMFGeometry_cfg.prod
prod
Definition: dumpMFGeometry_cfg.py:24
edm::errors::InsertFailure
Definition: EDMException.h:35
edm::RunPrincipal::m_reducedHistoryID
ProcessHistoryID m_reducedHistoryID
Definition: RunPrincipal.h:89
edm::RunPrincipal::index
RunIndex index() const
Definition: RunPrincipal.h:57
edm::Principal::fillPrincipal
void fillPrincipal(DelayedReader *reader)
Definition: Principal.cc:402
edm::RunAuxiliary::beginTime
Timestamp const & beginTime() const
Definition: RunAuxiliary.h:29
edm::RunAuxiliary::endTime
Timestamp const & endTime() const
Definition: RunAuxiliary.h:30
edm::Principal::getExistingProduct
ProductResolverBase * getExistingProduct(BranchID const &branchID)
Definition: Principal.cc:501
eostools.move
def move(src, dest)
Definition: eostools.py:511
Exception
Definition: hltDiff.cc:245
edm::RunAuxiliary::run
RunNumber_t run() const
Definition: RunAuxiliary.h:31
edm::RunPrincipal::index_
RunIndex index_
Definition: RunPrincipal.h:90
edm::RunAuxiliary::id
RunID const & id() const
Definition: RunAuxiliary.h:27
edm::RunIndex::value
unsigned int value() const
Definition: RunIndex.h:45