CMS 3D CMS Logo

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
 
EntryNumber_t firstEventEntryThisLumi ()
 
EntryNumber_t firstEventEntryThisRun ()
 
EntryType getEntryType () 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 650 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 1738 of file IndexIntoFile.cc.

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

1745  :
1746  impl_() {
1747  if(sortOrder == numericalOrder) {
1748  value_ptr<IndexIntoFileItrImpl> temp(new IndexIntoFileItrSorted(indexIntoFile,
1749  entryType,
1750  indexToRun,
1751  indexToLumi,
1753  indexToEvent,
1754  nEvents
1755  ));
1756  swap(temp, impl_);
1757  } else {
1758  value_ptr<IndexIntoFileItrImpl> temp(new IndexIntoFileItrNoSort(indexIntoFile,
1759  entryType,
1760  indexToRun,
1761  indexToLumi,
1763  indexToEvent,
1764  nEvents));
1765  swap(temp, impl_);
1766  }
1767  }
void swap(Association< C > &lhs, Association< C > &rhs)
Definition: Association.h:116
IndexIntoFile const * indexIntoFile() const
value_ptr< IndexIntoFileItrImpl > impl_

Member Function Documentation

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

Definition at line 1769 of file IndexIntoFile.cc.

References getEntryType(), impl_, edm::IndexIntoFile::kEnd, and edm::IndexIntoFile::kEvent.

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

1769  {
1770  for(EntryType entryType = getEntryType();
1771  entryType != kEnd && entryType != kEvent;
1772  entryType = getEntryType()) {
1773  impl_->next();
1774  }
1775  }
value_ptr< IndexIntoFileItrImpl > impl_
void edm::IndexIntoFile::IndexIntoFileItr::advanceToLumi ( )

Definition at line 1777 of file IndexIntoFile.cc.

References getEntryType(), impl_, edm::IndexIntoFile::kEnd, and edm::IndexIntoFile::kLumi.

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

1777  {
1778  for(EntryType entryType = getEntryType();
1779  entryType != kEnd && entryType != kLumi;
1780  entryType = getEntryType()) {
1781  impl_->next();
1782  }
1783  }
value_ptr< IndexIntoFileItrImpl > impl_
void edm::IndexIntoFile::IndexIntoFileItr::advanceToNextLumiOrRun ( )
inline

Definition at line 746 of file IndexIntoFile.h.

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

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

Definition at line 745 of file IndexIntoFile.h.

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

745 {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 1786 of file IndexIntoFile.cc.

References impl_.

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

1786  {
1787  impl_->copyPosition(*position.impl_);
1788  }
static int position[264][3]
Definition: ReadPGInfo.cc:509
value_ptr< IndexIntoFileItrImpl > impl_
EntryNumber_t edm::IndexIntoFile::IndexIntoFileItr::entry ( ) const
inline
EntryNumber_t edm::IndexIntoFile::IndexIntoFileItr::firstEventEntryThisLumi ( )
inline

Definition at line 690 of file IndexIntoFile.h.

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

690 { 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 689 of file IndexIntoFile.h.

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

689 { return impl_->firstEventEntryThisRun(); }
value_ptr< IndexIntoFileItrImpl > impl_
EntryType edm::IndexIntoFile::IndexIntoFileItr::getEntryType ( ) const
inline
IndexIntoFile const* edm::IndexIntoFile::IndexIntoFileItr::indexIntoFile ( ) const
inlineprivate

Definition at line 777 of file IndexIntoFile.h.

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

Definition at line 783 of file IndexIntoFile.h.

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

Definition at line 782 of file IndexIntoFile.h.

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

Definition at line 781 of file IndexIntoFile.h.

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

Definition at line 780 of file IndexIntoFile.h.

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

Should only be used internally and for tests.

Definition at line 763 of file IndexIntoFile.h.

References position.

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

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

Should only be used internally and for tests.

Definition at line 760 of file IndexIntoFile.h.

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

760 {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 784 of file IndexIntoFile.h.

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

Definition at line 755 of file IndexIntoFile.h.

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

Move to next event to be processed.

Definition at line 706 of file IndexIntoFile.h.

706  {
707  impl_->next();
708  return *this;
709  }
value_ptr< IndexIntoFileItrImpl > impl_
bool edm::IndexIntoFile::IndexIntoFileItr::operator== ( IndexIntoFileItr const &  right) const
inline

Definition at line 751 of file IndexIntoFile.h.

References impl_.

751  {
752  return *impl_ == *right.impl_;
753  }
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 684 of file IndexIntoFile.h.

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

684 { 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 678 of file IndexIntoFile.h.

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

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

Definition at line 671 of file IndexIntoFile.h.

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

671 {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 778 of file IndexIntoFile.h.

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

778 { 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 730 of file IndexIntoFile.h.

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

733  {
734  impl_->skipEventBackward(phIndexOfEvent, runOfEvent, lumiOfEvent, eventEntry);
735  }
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 716 of file IndexIntoFile.h.

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

719  {
720  impl_->skipEventForward(phIndexOfSkippedEvent, runOfSkippedEvent, lumiOfSkippedEvent, skippedEventEntry);
721  }
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 739 of file IndexIntoFile.h.

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

739 { 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 743 of file IndexIntoFile.h.

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

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

Friends And Related Function Documentation

friend class ::TestIndexIntoFile
friend

Definition at line 770 of file IndexIntoFile.h.

friend class ::TestIndexIntoFile3
friend

Definition at line 771 of file IndexIntoFile.h.

friend class ::TestIndexIntoFile4
friend

Definition at line 772 of file IndexIntoFile.h.

friend class ::TestIndexIntoFile5
friend

Definition at line 773 of file IndexIntoFile.h.

Member Data Documentation

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