CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Private Member Functions | Private Attributes | Friends
edm::IndexIntoFile::IndexIntoFileItr Class Reference

#include <IndexIntoFile.h>

Public Member Functions

void advanceToEvent ()
 
void advanceToLumi ()
 
void advanceToNextLumiOrRun ()
 
void advanceToNextRun ()
 
void copyPosition (IndexIntoFileItr const &position)
 Copy the position without modifying the pointer to the IndexIntoFile or size. More...
 
EntryNumber_t entry () const
 
bool entryContinues () const
 
EntryNumber_t firstEventEntryThisLumi ()
 
EntryNumber_t firstEventEntryThisRun ()
 
EntryType getEntryType () const
 
void getLumisInRun (std::vector< LuminosityBlockNumber_t > &lumis) const
 
 IndexIntoFileItr (IndexIntoFile const *indexIntoFile, SortOrder sortOrder, EntryType entryType, int indexToRun, int indexToLumi, int indexToEventRange, long long indexToEvent, long long nEvents)
 
void initializeLumi ()
 Should only be used internally and for tests. More...
 
void initializeRun ()
 Should only be used internally and for tests. More...
 
LuminosityBlockNumber_t lumi () const
 
bool operator!= (IndexIntoFileItr const &right) const
 
IndexIntoFileItroperator++ ()
 Move to next event to be processed. More...
 
bool operator== (IndexIntoFileItr const &right) const
 
EntryNumber_t peekAheadAtEventEntry () const
 
LuminosityBlockNumber_t peekAheadAtLumi () const
 
int processHistoryIDIndex () const
 
RunNumber_t run () const
 
void skipEventBackward (int &phIndexOfEvent, RunNumber_t &runOfEvent, LuminosityBlockNumber_t &lumiOfEvent, EntryNumber_t &eventEntry)
 
void skipEventForward (int &phIndexOfSkippedEvent, RunNumber_t &runOfSkippedEvent, LuminosityBlockNumber_t &lumiOfSkippedEvent, EntryNumber_t &skippedEventEntry)
 
bool skipLumiInRun ()
 
bool skipToNextEventInLumi ()
 

Private Member Functions

IndexIntoFile const * indexIntoFile () const
 
long long indexToEvent () const
 
int indexToEventRange () const
 
int indexToLumi () const
 
int indexToRun () const
 
long long nEvents () const
 
int size () const
 
EntryType type () const
 

Private Attributes

value_ptr< IndexIntoFileItrImplimpl_
 

Friends

class ::TestIndexIntoFile
 
class ::TestIndexIntoFile3
 
class ::TestIndexIntoFile4
 
class ::TestIndexIntoFile5
 

Detailed Description

Definition at line 724 of file IndexIntoFile.h.

Constructor & Destructor Documentation

edm::IndexIntoFile::IndexIntoFileItr::IndexIntoFileItr ( IndexIntoFile const *  indexIntoFile,
SortOrder  sortOrder,
EntryType  entryType,
int  indexToRun,
int  indexToLumi,
int  indexToEventRange,
long long  indexToEvent,
long long  nEvents 
)

This itended to be used only internally and by IndexIntoFile. One thing that is needed for the future, is to add some checks to make sure the iterator is in a valid state inside this constructor. It is currently possible to create an iterator with this constructor in an invalid state and the behavior would then be undefined. In the existing internal usages the iterator will always be valid. (for example IndexIntoFile::begin and IndexIntoFile::findPosition will always return a valid iterator).

Definition at line 2006 of file IndexIntoFile.cc.

References edm::IndexIntoFile::firstAppearanceOrder, impl_, edm::IndexIntoFile::numericalOrder, edm::swap(), and groupFilesInBlocks::temp.

2014  : impl_() {
2015  if (sortOrder == numericalOrder) {
2016  value_ptr<IndexIntoFileItrImpl> temp(new IndexIntoFileItrSorted(
2018  swap(temp, impl_);
2019  } else if (sortOrder == firstAppearanceOrder) {
2020  value_ptr<IndexIntoFileItrImpl> temp(new IndexIntoFileItrNoSort(
2022  swap(temp, impl_);
2023  } else {
2024  value_ptr<IndexIntoFileItrImpl> temp(new IndexIntoFileItrEntryOrder(
2026  swap(temp, impl_);
2027  }
2028  }
void swap(Association< C > &lhs, Association< C > &rhs)
Definition: Association.h:117
IndexIntoFile const * indexIntoFile() const
value_ptr< IndexIntoFileItrImpl > impl_

Member Function Documentation

void edm::IndexIntoFile::IndexIntoFileItr::advanceToEvent ( )

Definition at line 2030 of file IndexIntoFile.cc.

References edm::IndexIntoFile::kEnd, and edm::IndexIntoFile::kEvent.

Referenced by edm::IndexIntoFile::findEventPosition(), edm::RootFile::setEntryAtNextEventInLumi(), and edm::RootFile::wasLastEventJustRead().

2030  {
2031  for (EntryType entryType = getEntryType(); entryType != kEnd && entryType != kEvent; entryType = getEntryType()) {
2032  impl_->next();
2033  }
2034  }
value_ptr< IndexIntoFileItrImpl > impl_
void edm::IndexIntoFile::IndexIntoFileItr::advanceToLumi ( )

Definition at line 2036 of file IndexIntoFile.cc.

References edm::IndexIntoFile::kEnd, and edm::IndexIntoFile::kLumi.

Referenced by edm::IndexIntoFile::findLumiPosition().

2036  {
2037  for (EntryType entryType = getEntryType(); entryType != kEnd && entryType != kLumi; entryType = getEntryType()) {
2038  impl_->next();
2039  }
2040  }
value_ptr< IndexIntoFileItrImpl > impl_
void edm::IndexIntoFile::IndexIntoFileItr::advanceToNextLumiOrRun ( )
inline

Definition at line 819 of file IndexIntoFile.h.

References impl_.

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

819 { impl_->advanceToNextLumiOrRun(); }
value_ptr< IndexIntoFileItrImpl > impl_
void edm::IndexIntoFile::IndexIntoFileItr::advanceToNextRun ( )
inline

Definition at line 818 of file IndexIntoFile.h.

References impl_.

Referenced by edm::IndexIntoFile::findPosition(), and edm::RootFile::getNextItemType().

818 { impl_->advanceToNextRun(); }
value_ptr< IndexIntoFileItrImpl > impl_
void edm::IndexIntoFile::IndexIntoFileItr::copyPosition ( IndexIntoFileItr const &  position)

Copy the position without modifying the pointer to the IndexIntoFile or size.

Definition at line 2042 of file IndexIntoFile.cc.

References impl_.

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

2042  {
2043  impl_->copyPosition(*position.impl_);
2044  }
static int position[264][3]
Definition: ReadPGInfo.cc:289
value_ptr< IndexIntoFileItrImpl > impl_
EntryNumber_t edm::IndexIntoFile::IndexIntoFileItr::entry ( ) const
inline
bool edm::IndexIntoFile::IndexIntoFileItr::entryContinues ( ) const
inline

Definition at line 748 of file IndexIntoFile.h.

References impl_.

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

748 { return impl_->entryContinues(); }
value_ptr< IndexIntoFileItrImpl > impl_
EntryNumber_t edm::IndexIntoFile::IndexIntoFileItr::firstEventEntryThisLumi ( )
inline

Definition at line 764 of file IndexIntoFile.h.

References impl_.

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

764 { return impl_->firstEventEntryThisLumi(); }
value_ptr< IndexIntoFileItrImpl > impl_
EntryNumber_t edm::IndexIntoFile::IndexIntoFileItr::firstEventEntryThisRun ( )
inline

Returns the TTree entry of the first event which would be processed in the current run/lumi if all the events in the run/lumi were processed in the current processing order. If there are none it returns -1 (invalid).

Definition at line 763 of file IndexIntoFile.h.

References impl_.

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

763 { return impl_->firstEventEntryThisRun(); }
value_ptr< IndexIntoFileItrImpl > impl_
EntryType edm::IndexIntoFile::IndexIntoFileItr::getEntryType ( ) const
inline
void edm::IndexIntoFile::IndexIntoFileItr::getLumisInRun ( std::vector< LuminosityBlockNumber_t > &  lumis) const
inline

Definition at line 837 of file IndexIntoFile.h.

References impl_.

Referenced by edm::IndexIntoFileItrHolder::getLumisInRun().

837 { impl_->getLumisInRun(lumis); }
value_ptr< IndexIntoFileItrImpl > impl_
IndexIntoFile const* edm::IndexIntoFile::IndexIntoFileItr::indexIntoFile ( ) const
inlineprivate

Definition at line 848 of file IndexIntoFile.h.

References impl_.

848 { return impl_->indexIntoFile(); }
value_ptr< IndexIntoFileItrImpl > impl_
long long edm::IndexIntoFile::IndexIntoFileItr::indexToEvent ( ) const
inlineprivate

Definition at line 854 of file IndexIntoFile.h.

References impl_.

854 { return impl_->indexToEvent(); }
value_ptr< IndexIntoFileItrImpl > impl_
int edm::IndexIntoFile::IndexIntoFileItr::indexToEventRange ( ) const
inlineprivate

Definition at line 853 of file IndexIntoFile.h.

References impl_.

853 { return impl_->indexToEventRange(); }
value_ptr< IndexIntoFileItrImpl > impl_
int edm::IndexIntoFile::IndexIntoFileItr::indexToLumi ( ) const
inlineprivate

Definition at line 852 of file IndexIntoFile.h.

References impl_.

852 { return impl_->indexToLumi(); }
value_ptr< IndexIntoFileItrImpl > impl_
int edm::IndexIntoFile::IndexIntoFileItr::indexToRun ( ) const
inlineprivate

Definition at line 851 of file IndexIntoFile.h.

References impl_.

851 { return impl_->indexToRun(); }
value_ptr< IndexIntoFileItrImpl > impl_
void edm::IndexIntoFile::IndexIntoFileItr::initializeLumi ( )
inline

Should only be used internally and for tests.

Definition at line 832 of file IndexIntoFile.h.

References impl_.

Referenced by edm::IndexIntoFile::findPosition().

832 { impl_->initializeLumi(); }
value_ptr< IndexIntoFileItrImpl > impl_
void edm::IndexIntoFile::IndexIntoFileItr::initializeRun ( )
inline

Should only be used internally and for tests.

Definition at line 829 of file IndexIntoFile.h.

References impl_.

Referenced by edm::IndexIntoFile::begin(), and edm::IndexIntoFile::findPosition().

829 { impl_->initializeRun(); }
value_ptr< IndexIntoFileItrImpl > impl_
LuminosityBlockNumber_t edm::IndexIntoFile::IndexIntoFileItr::lumi ( ) const
inline
long long edm::IndexIntoFile::IndexIntoFileItr::nEvents ( ) const
inlineprivate

Definition at line 855 of file IndexIntoFile.h.

References impl_.

855 { return impl_->nEvents(); }
value_ptr< IndexIntoFileItrImpl > impl_
bool edm::IndexIntoFile::IndexIntoFileItr::operator!= ( IndexIntoFileItr const &  right) const
inline

Definition at line 826 of file IndexIntoFile.h.

826 { return !(*this == right); }
IndexIntoFileItr& edm::IndexIntoFile::IndexIntoFileItr::operator++ ( void  )
inline

Move to next event to be processed.

Definition at line 779 of file IndexIntoFile.h.

References impl_.

779  {
780  impl_->next();
781  return *this;
782  }
value_ptr< IndexIntoFileItrImpl > impl_
bool edm::IndexIntoFile::IndexIntoFileItr::operator== ( IndexIntoFileItr const &  right) const
inline

Definition at line 824 of file IndexIntoFile.h.

References impl_.

824 { return *impl_ == *right.impl_; }
value_ptr< IndexIntoFileItrImpl > impl_
EntryNumber_t edm::IndexIntoFile::IndexIntoFileItr::peekAheadAtEventEntry ( ) const
inline

Same as entry() except when the the current type is kRun or kLumi. In that case instead of always returning -1 (invalid), it will return the event entry that will be processed next and which is in the current run and lumi. If there is none it still returns -1 (invalid).

Definition at line 758 of file IndexIntoFile.h.

References impl_.

Referenced by edm::IndexIntoFile::findPosition().

758 { return impl_->peekAheadAtEventEntry(); }
value_ptr< IndexIntoFileItrImpl > impl_
LuminosityBlockNumber_t edm::IndexIntoFile::IndexIntoFileItr::peekAheadAtLumi ( ) const
inline

Same as lumi() except when the the current type is kRun. In that case instead of always returning 0 (invalid), it will return the lumi that will be processed next

Definition at line 752 of file IndexIntoFile.h.

References impl_.

Referenced by edm::IndexIntoFile::findPosition(), edm::RootFile::getNextItemType(), and edm::RootFile::skipThisEntry().

752 { return impl_->peekAheadAtLumi(); }
value_ptr< IndexIntoFileItrImpl > impl_
int edm::IndexIntoFile::IndexIntoFileItr::processHistoryIDIndex ( ) const
inline

Definition at line 744 of file IndexIntoFile.h.

References impl_.

Referenced by edm::RootFile::isDuplicateEvent(), and edm::RootFile::readCurrentEvent().

744 { return impl_->processHistoryIDIndex(); }
value_ptr< IndexIntoFileItrImpl > impl_
RunNumber_t edm::IndexIntoFile::IndexIntoFileItr::run ( ) const
inline
int edm::IndexIntoFile::IndexIntoFileItr::size ( void  ) const
inlineprivate

Definition at line 849 of file IndexIntoFile.h.

References impl_.

Referenced by ntupleDataFormat._Collection::__iter__(), and ntupleDataFormat._Collection::__len__().

849 { return impl_->size(); }
value_ptr< IndexIntoFileItrImpl > impl_
void edm::IndexIntoFile::IndexIntoFileItr::skipEventBackward ( int &  phIndexOfEvent,
RunNumber_t runOfEvent,
LuminosityBlockNumber_t lumiOfEvent,
EntryNumber_t eventEntry 
)
inline

Move so that the event immediately preceding the the current position is the next event processed. If the type is kEvent or kLumi, then change the type to kRun if and only if the preceding event is in a different run. If the type is kEvent, change the type to kLumi if the lumi is different but the run is the same. Otherwise leave the type unchanged.

Definition at line 803 of file IndexIntoFile.h.

References impl_.

Referenced by edm::RootFile::skipEvents(), and edm::RootFile::wasFirstEventJustRead().

806  {
807  impl_->skipEventBackward(phIndexOfEvent, runOfEvent, lumiOfEvent, eventEntry);
808  }
value_ptr< IndexIntoFileItrImpl > impl_
void edm::IndexIntoFile::IndexIntoFileItr::skipEventForward ( int &  phIndexOfSkippedEvent,
RunNumber_t runOfSkippedEvent,
LuminosityBlockNumber_t lumiOfSkippedEvent,
EntryNumber_t skippedEventEntry 
)
inline

Move to whatever is immediately after the current event or after the next event if there is not a current event, but do not modify the type or run/lumi indexes unless it is necessary because there are no more events in the current run or lumi.

Definition at line 789 of file IndexIntoFile.h.

References impl_.

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

792  {
793  impl_->skipEventForward(phIndexOfSkippedEvent, runOfSkippedEvent, lumiOfSkippedEvent, skippedEventEntry);
794  }
value_ptr< IndexIntoFileItrImpl > impl_
bool edm::IndexIntoFile::IndexIntoFileItr::skipLumiInRun ( )
inline

Move to the next lumi in the current run. Returns false if there is not one.

Definition at line 812 of file IndexIntoFile.h.

References impl_.

Referenced by edm::IndexIntoFile::findPosition(), and edm::RootFile::skipThisEntry().

812 { return impl_->skipLumiInRun(); }
value_ptr< IndexIntoFileItrImpl > impl_
bool edm::IndexIntoFile::IndexIntoFileItr::skipToNextEventInLumi ( )
inline

Move to the next event in the current lumi. Returns false if there is not one.

Definition at line 816 of file IndexIntoFile.h.

References impl_.

Referenced by edm::IndexIntoFile::findPosition().

816 { return impl_->skipToNextEventInLumi(); }
value_ptr< IndexIntoFileItrImpl > impl_
EntryType edm::IndexIntoFile::IndexIntoFileItr::type ( ) const
inlineprivate

Definition at line 850 of file IndexIntoFile.h.

References impl_.

850 { return impl_->type(); }
value_ptr< IndexIntoFileItrImpl > impl_

Friends And Related Function Documentation

friend class ::TestIndexIntoFile
friend

Definition at line 841 of file IndexIntoFile.h.

friend class ::TestIndexIntoFile3
friend

Definition at line 842 of file IndexIntoFile.h.

friend class ::TestIndexIntoFile4
friend

Definition at line 843 of file IndexIntoFile.h.

friend class ::TestIndexIntoFile5
friend

Definition at line 844 of file IndexIntoFile.h.

Member Data Documentation

value_ptr<IndexIntoFileItrImpl> edm::IndexIntoFile::IndexIntoFileItr::impl_
private