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
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	lumiIterationStartingIndex (int index) const
bool	operator!= (IndexIntoFileItr const &right) const
IndexIntoFileItr &	operator++ ()
	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
bool	shouldProcessLumi () const
bool	shouldProcessRun () 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
int	indexedSize () const
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< IndexIntoFileItrImpl >	impl_

Friends
class	::TestIndexIntoFile
class	::TestIndexIntoFile2
class	::TestIndexIntoFile3
class	::TestIndexIntoFile4
class	::TestIndexIntoFile5

Detailed Description

Definition at line 886 of file IndexIntoFile.h.

Constructor & Destructor Documentation

IndexIntoFileItr()

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 2443 of file IndexIntoFile.cc.

References edm::IndexIntoFile::firstAppearanceOrder, impl_, indexIntoFile(), indexToEvent(), indexToEventRange(), indexToLumi(), indexToRun(), nEvents(), edm::IndexIntoFile::numericalOrder, edm::swap(), and groupFilesInBlocks::temp.

      : impl_() {
    if (sortOrder == numericalOrder) {
      value_ptr<IndexIntoFileItrImpl> temp(new IndexIntoFileItrSorted(
          indexIntoFile, entryType, indexToRun, indexToLumi, indexToEventRange, indexToEvent, nEvents));
      swap(temp, impl_);
    } else if (sortOrder == firstAppearanceOrder) {
      value_ptr<IndexIntoFileItrImpl> temp(new IndexIntoFileItrNoSort(
          indexIntoFile, entryType, indexToRun, indexToLumi, indexToEventRange, indexToEvent, nEvents));
      swap(temp, impl_);
    } else {
      value_ptr<IndexIntoFileItrImpl> temp(new IndexIntoFileItrEntryOrder(
          indexIntoFile, entryType, indexToRun, indexToLumi, indexToEventRange, indexToEvent, nEvents));
      swap(temp, impl_);
    }
  }

Member Function Documentation

advanceToEvent()

void edm::IndexIntoFile::IndexIntoFileItr::advanceToEvent

(

)

Definition at line 2467 of file IndexIntoFile.cc.

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

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

                                                     {
    for (EntryType entryType = getEntryType(); entryType != kEnd && entryType != kEvent; entryType = getEntryType()) {
      impl_->next();
    }
  }

advanceToLumi()

void edm::IndexIntoFile::IndexIntoFileItr::advanceToLumi

(

)

Definition at line 2473 of file IndexIntoFile.cc.

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

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

                                                    {
    for (EntryType entryType = getEntryType(); entryType != kEnd && entryType != kLumi; entryType = getEntryType()) {
      impl_->next();
    }
  }

advanceToNextLumiOrRun()

void edm::IndexIntoFile::IndexIntoFileItr::advanceToNextLumiOrRun ( )

inline

Definition at line 983 of file IndexIntoFile.h.

References impl_.

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

{ impl_->advanceToNextLumiOrRun(); }

advanceToNextRun()

void edm::IndexIntoFile::IndexIntoFileItr::advanceToNextRun ( )

inline

Definition at line 982 of file IndexIntoFile.h.

References impl_.

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

{ impl_->advanceToNextRun(); }

copyPosition()

void edm::IndexIntoFile::IndexIntoFileItr::copyPosition

(

IndexIntoFileItr const &

position

)

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

Definition at line 2479 of file IndexIntoFile.cc.

References position.

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

                                                                                   {
    impl_->copyPosition(*position.impl_);
  }

entry()

EntryNumber_t edm::IndexIntoFile::IndexIntoFileItr::entry ( ) const

inline

Definition at line 909 of file IndexIntoFile.h.

References impl_.

Referenced by edm::RootFile::getNextItemType(), edm::RootFile::isDuplicateEvent(), edm::RootFile::readLuminosityBlock_(), edm::RootFile::readLuminosityBlockAuxiliary_(), edm::RootFile::readRunAuxiliary_(), edm::RootFile::setEntryAtEvent(), edm::RootFile::setEntryAtLumi(), edm::RootFile::setEntryAtNextEventInLumi(), edm::RootFile::setEntryAtRun(), and edm::RootFile::skipThisEntry().

{ return impl_->entry(); }

firstEventEntryThisLumi()

EntryNumber_t edm::IndexIntoFile::IndexIntoFileItr::firstEventEntryThisLumi ( )

inline

Definition at line 928 of file IndexIntoFile.h.

References impl_.

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

{ return impl_->firstEventEntryThisLumi(); }

firstEventEntryThisRun()

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 927 of file IndexIntoFile.h.

References impl_.

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

{ return impl_->firstEventEntryThisRun(); }

getEntryType()

EntryType edm::IndexIntoFile::IndexIntoFileItr::getEntryType ( ) const

inline

Definition at line 905 of file IndexIntoFile.h.

References impl_.

Referenced by edm::IndexIntoFile::containsEvent(), edm::IndexIntoFile::containsLumi(), edm::IndexIntoFile::containsRun(), edm::RootFile::getNextItemType(), edm::RootFile::isDuplicateEvent(), edm::RootFile::readEvent(), edm::RootFile::readLuminosityBlock_(), edm::RootFile::readLuminosityBlockAuxiliary_(), edm::RootFile::readRun_(), edm::RootFile::readRunAuxiliary_(), edm::RootFile::setEntryAtNextEventInLumi(), edm::RootFile::setIfFastClonable(), edm::RootFile::skipThisEntry(), and edm::RootFile::wasLastEventJustRead().

{ return impl_->getEntryType(); }

getLumisInRun()

void edm::IndexIntoFile::IndexIntoFileItr::getLumisInRun ( std::vector< LuminosityBlockNumber_t > &  lumis ) const

inline

Definition at line 1001 of file IndexIntoFile.h.

References impl_, and edmLumisInFiles::lumis.

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

{ impl_->getLumisInRun(lumis); }

indexedSize()

int edm::IndexIntoFile::IndexIntoFileItr::indexedSize ( ) const

inlineprivate

Definition at line 1015 of file IndexIntoFile.h.

References impl_.

{ return impl_->indexedSize(); }

indexIntoFile()

IndexIntoFile const* edm::IndexIntoFile::IndexIntoFileItr::indexIntoFile ( ) const

inlineprivate

Definition at line 1013 of file IndexIntoFile.h.

References impl_.

Referenced by IndexIntoFileItr().

{ return impl_->indexIntoFile(); }

indexToEvent()

long long edm::IndexIntoFile::IndexIntoFileItr::indexToEvent ( ) const

inlineprivate

Definition at line 1020 of file IndexIntoFile.h.

References impl_.

Referenced by IndexIntoFileItr().

{ return impl_->indexToEvent(); }

indexToEventRange()

int edm::IndexIntoFile::IndexIntoFileItr::indexToEventRange ( ) const

inlineprivate

Definition at line 1019 of file IndexIntoFile.h.

References impl_.

Referenced by IndexIntoFileItr().

{ return impl_->indexToEventRange(); }

indexToLumi()

int edm::IndexIntoFile::IndexIntoFileItr::indexToLumi ( ) const

inlineprivate

Definition at line 1018 of file IndexIntoFile.h.

References impl_.

Referenced by IndexIntoFileItr().

{ return impl_->indexToLumi(); }

indexToRun()

int edm::IndexIntoFile::IndexIntoFileItr::indexToRun ( ) const

inlineprivate

Definition at line 1017 of file IndexIntoFile.h.

References impl_.

Referenced by IndexIntoFileItr().

{ return impl_->indexToRun(); }

initializeLumi()

void edm::IndexIntoFile::IndexIntoFileItr::initializeLumi ( )

inline

Should only be used internally and for tests.

Definition at line 996 of file IndexIntoFile.h.

References impl_.

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

{ impl_->initializeLumi(); }

initializeRun()

void edm::IndexIntoFile::IndexIntoFileItr::initializeRun ( )

inline

Should only be used internally and for tests.

Definition at line 993 of file IndexIntoFile.h.

References impl_.

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

{ impl_->initializeRun(); }

lumi()

LuminosityBlockNumber_t edm::IndexIntoFile::IndexIntoFileItr::lumi ( ) const

inline

Definition at line 908 of file IndexIntoFile.h.

References impl_.

Referenced by edm::RootFile::getNextItemType(), edm::RootFile::isDuplicateEvent(), edm::RootFile::readEvent(), edm::RootFile::readLuminosityBlockAuxiliary_(), edm::RootFile::setEntryAtNextEventInLumi(), and edm::RootFile::skipThisEntry().

{ return impl_->lumi(); }

lumiIterationStartingIndex()

bool edm::IndexIntoFile::IndexIntoFileItr::lumiIterationStartingIndex ( int  index ) const

inline

Definition at line 912 of file IndexIntoFile.h.

References impl_.

{ return impl_->lumiIterationStartingIndex(index); }

nEvents()

long long edm::IndexIntoFile::IndexIntoFileItr::nEvents ( ) const

inlineprivate

Definition at line 1021 of file IndexIntoFile.h.

References impl_.

Referenced by IndexIntoFileItr().

{ return impl_->nEvents(); }

operator!=()

bool edm::IndexIntoFile::IndexIntoFileItr::operator!= ( IndexIntoFileItr const &  right ) const

inline

Definition at line 990 of file IndexIntoFile.h.

{ return !(*this == right); }

operator++()

IndexIntoFileItr& edm::IndexIntoFile::IndexIntoFileItr::operator++ ( void  )

inline

Move to next event to be processed.

Definition at line 943 of file IndexIntoFile.h.

References impl_.

                                     {
        impl_->next();
        return *this;
      }

operator==()

bool edm::IndexIntoFile::IndexIntoFileItr::operator== ( IndexIntoFileItr const &  right ) const

inline

Definition at line 988 of file IndexIntoFile.h.

References impl_.

{ return *impl_ == *right.impl_; }

peekAheadAtEventEntry()

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 922 of file IndexIntoFile.h.

References impl_.

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

{ return impl_->peekAheadAtEventEntry(); }

peekAheadAtLumi()

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 916 of file IndexIntoFile.h.

References impl_.

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

{ return impl_->peekAheadAtLumi(); }

processHistoryIDIndex()

int edm::IndexIntoFile::IndexIntoFileItr::processHistoryIDIndex ( ) const

inline

Definition at line 906 of file IndexIntoFile.h.

References impl_.

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

{ return impl_->processHistoryIDIndex(); }

run()

RunNumber_t edm::IndexIntoFile::IndexIntoFileItr::run ( ) const

inline

Definition at line 907 of file IndexIntoFile.h.

References impl_.

Referenced by Types.EventID::cppID(), Types.LuminosityBlockID::cppID(), edm::IndexIntoFile::findPosition(), edm::RootFile::getNextItemType(), edm::RootFile::isDuplicateEvent(), edm::RootFile::readEvent(), edm::RootFile::readLuminosityBlockAuxiliary_(), edm::RootFile::readRunAuxiliary_(), edm::RootFile::RootFile(), edm::RootFile::setEntryAtNextEventInLumi(), and edm::RootFile::skipThisEntry().

{ return impl_->run(); }

shouldProcessLumi()

bool edm::IndexIntoFile::IndexIntoFileItr::shouldProcessLumi ( ) const

inline

Definition at line 910 of file IndexIntoFile.h.

References impl_.

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

{ return impl_->shouldProcessLumi(); }

shouldProcessRun()

bool edm::IndexIntoFile::IndexIntoFileItr::shouldProcessRun ( ) const

inline

Definition at line 911 of file IndexIntoFile.h.

References impl_.

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

{ return impl_->shouldProcessRun(); }

size()

int edm::IndexIntoFile::IndexIntoFileItr::size ( void  ) const

inlineprivate

Definition at line 1014 of file IndexIntoFile.h.

References impl_.

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

{ return impl_->size(); }

skipEventBackward()

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 967 of file IndexIntoFile.h.

References impl_.

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

                                                        {
        impl_->skipEventBackward(phIndexOfEvent, runOfEvent, lumiOfEvent, eventEntry);
      }

skipEventForward()

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 953 of file IndexIntoFile.h.

References impl_.

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

                                                              {
        impl_->skipEventForward(phIndexOfSkippedEvent, runOfSkippedEvent, lumiOfSkippedEvent, skippedEventEntry);
      }

skipLumiInRun()

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 976 of file IndexIntoFile.h.

References impl_.

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

{ return impl_->skipLumiInRun(); }

skipToNextEventInLumi()

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 980 of file IndexIntoFile.h.

References impl_.

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

{ return impl_->skipToNextEventInLumi(); }

type()

EntryType edm::IndexIntoFile::IndexIntoFileItr::type ( ) const

inlineprivate

Definition at line 1016 of file IndexIntoFile.h.

References impl_.

{ return impl_->type(); }

Friends And Related Function Documentation

::TestIndexIntoFile

friend class ::TestIndexIntoFile

friend

Definition at line 1005 of file IndexIntoFile.h.

::TestIndexIntoFile2

friend class ::TestIndexIntoFile2

friend

Definition at line 1006 of file IndexIntoFile.h.

::TestIndexIntoFile3

friend class ::TestIndexIntoFile3

friend

Definition at line 1007 of file IndexIntoFile.h.

::TestIndexIntoFile4

friend class ::TestIndexIntoFile4

friend

Definition at line 1008 of file IndexIntoFile.h.

::TestIndexIntoFile5

friend class ::TestIndexIntoFile5

friend

Definition at line 1009 of file IndexIntoFile.h.

Member Data Documentation

impl_

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

private

Definition at line 1023 of file IndexIntoFile.h.

Referenced by advanceToNextLumiOrRun(), advanceToNextRun(), entry(), firstEventEntryThisLumi(), firstEventEntryThisRun(), getEntryType(), getLumisInRun(), indexedSize(), indexIntoFile(), IndexIntoFileItr(), indexToEvent(), indexToEventRange(), indexToLumi(), indexToRun(), initializeLumi(), initializeRun(), lumi(), lumiIterationStartingIndex(), nEvents(), operator++(), operator==(), peekAheadAtEventEntry(), peekAheadAtLumi(), processHistoryIDIndex(), run(), shouldProcessLumi(), shouldProcessRun(), size(), skipEventBackward(), skipEventForward(), skipLumiInRun(), skipToNextEventInLumi(), and type().