edm::IndexIntoFile Class Reference

#include <IndexIntoFile.h>

Classes
class	EventEntry
class	EventFinder
class	IndexIntoFileItr
class	IndexIntoFileItrImpl
class	IndexIntoFileItrNoSort
class	IndexIntoFileItrSorted
class	IndexRunKey
class	IndexRunLumiEventKey
class	IndexRunLumiKey
class	RunOrLumiEntry
class	RunOrLumiIndexes
class	SortedRunOrLumiItr
struct	Transients

Public Types
typedef long long	EntryNumber_t
enum	EntryType { kRun, kLumi, kEvent, kEnd }
enum	SortOrder { numericalOrder, firstAppearanceOrder }

Public Member Functions
void	addEntry (ProcessHistoryID const &processHistoryID, RunNumber_t run, LuminosityBlockNumber_t lumi, EventNumber_t event, EntryNumber_t entry)
IndexIntoFileItr	begin (SortOrder sortOrder) const
SortedRunOrLumiItr	beginRunOrLumi () const
bool	containsDuplicateEvents () const
	Returns true if the IndexIntoFile contains 2 events with the same ProcessHistoryID index, run number, lumi number and event number. More...
bool	containsEvent (RunNumber_t run, LuminosityBlockNumber_t lumi, EventNumber_t event) const
bool	containsItem (RunNumber_t run, LuminosityBlockNumber_t lumi, EventNumber_t event) const
bool	containsLumi (RunNumber_t run, LuminosityBlockNumber_t lumi) const
bool	containsRun (RunNumber_t run) const
void	doneFileInitialization () const
	Clears the temporary vector of event numbers to reduce memory usage. More...
bool	empty () const
	True if no runs, lumis, or events are in the file. More...
IndexIntoFileItr	end (SortOrder sortOrder) const
	Used to end an iteration over the Runs, Lumis, and Events in a file. More...
SortedRunOrLumiItr	endRunOrLumi () const
void	fillEventEntries () const
void	fillEventNumbers () const
void	fillEventNumbersOrEntries (bool needEventNumbers, bool needEventEntries) const
IndexIntoFileItr	findEventPosition (RunNumber_t run, LuminosityBlockNumber_t lumi, EventNumber_t event) const
IndexIntoFileItr	findLumiPosition (RunNumber_t run, LuminosityBlockNumber_t lumi) const
IndexIntoFileItr	findPosition (RunNumber_t run, LuminosityBlockNumber_t lumi=0U, EventNumber_t event=0U) const
IndexIntoFileItr	findPosition (SortOrder sortOrder, RunNumber_t run, LuminosityBlockNumber_t lumi=0U, EventNumber_t event=0U) const
IndexIntoFileItr	findRunPosition (RunNumber_t run) const
	Same as findPosition. More...
void	fixIndexes (std::vector< ProcessHistoryID > &processHistoryIDs)
	IndexIntoFile ()
void	initializeTransients () const
void	inputFileClosed () const
bool	iterationWillBeInEntryOrder (SortOrder sortOrder) const
	Used to determine whether or not to disable fast cloning. More...
ProcessHistoryID const &	processHistoryID (int i) const
std::vector< ProcessHistoryID > const &	processHistoryIDs () const
void	reduceProcessHistoryIDs (ProcessHistoryRegistry const &processHistoryRegistry)
std::vector< RunOrLumiEntry > const &	runOrLumiEntries () const
	Used internally and for test purposes. More...
void	set_intersection (IndexIntoFile const &indexIntoFile, std::set< IndexRunLumiEventKey > &intersection) const
void	setEventFinder (std::shared_ptr< EventFinder > ptr) const
void	setNumberOfEvents (EntryNumber_t nevents) const
std::vector< ProcessHistoryID > &	setProcessHistoryIDs ()
std::vector< RunOrLumiEntry > &	setRunOrLumiEntries ()
void	sortVector_Run_Or_Lumi_Entries ()
std::vector< EventNumber_t > &	unsortedEventNumbers () const
	~IndexIntoFile ()

Static Public Attributes
static EntryNumber_t const	invalidEntry = -1LL
static EventNumber_t const	invalidEvent = 0U
static int const	invalidIndex = -1
static LuminosityBlockNumber_t const	invalidLumi = 0U
static RunNumber_t const	invalidRun = 0U

Private Member Functions
EntryNumber_t &	beginEvents () const
int &	currentIndex () const
LuminosityBlockNumber_t &	currentLumi () const
RunNumber_t &	currentRun () const
EntryNumber_t &	endEvents () const
std::vector< EventEntry > &	eventEntries () const
std::vector< EventNumber_t > &	eventNumbers () const
void	fillRunOrLumiIndexes () const
void	fillUnsortedEventNumbers () const
EventNumber_t	getEventNumberOfEntry (EntryNumber_t entry) const
std::map< IndexRunLumiKey, EntryNumber_t > &	lumiToFirstEntry () const
size_t	numberOfEvents () const
int &	previousAddedIndex () const
void	resetEventFinder () const
std::vector< RunOrLumiIndexes > &	runOrLumiIndexes () const
std::map< IndexRunKey, EntryNumber_t > &	runToFirstEntry () const
void	sortEventEntries () const
void	sortEvents () const

Private Attributes
std::vector< ProcessHistoryID >	processHistoryIDs_
std::vector< RunOrLumiEntry >	runOrLumiEntries_
Transients	transient_

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

Detailed Description

Used to quickly find the Events, Lumis, and Runs in a single ROOT format data file and step through them in the desired order.

A list of the most important functions that a client would use directly follows. There are detailed comments below with the declaration of each function.

The begin and end functions are used to start and stop an iteration loop. An argument to the iterator constructor determines the order of iteration.

The functions findPosition, findEventPosition, findRunPosition, and findLumiPosition are used to navigate directly to specific runs, lumis, and events.

The functions mentioned above return an object of type IndexIntoFileItr. The IndexIntoFileItr class has member functions which allow one to navigate forward and backward through the runs, lumis, and events in alternative ways. See more comments with the declaration of each public member function in IndexIntoFileItr.

The iterator will know what the current item is (as one would expect). This could be a run, lumi, or event. It knows more than that though, it knows all three as is explained below.

In the run state, IndexIntoFileItr knows which lumi will be processed next after the run and also which event will be processed after the lumi. These may not be the first ones in the run if the skip functions were used.

In the lumi state, the IndexIntoFileItr will always point at the last associated run and the next event to be processed after the lumi. This may not be the first event if the skip function was used.

In the event state, the IndexIntoFileItr will always point at the last corresponding run and also the last corresponding lumi.

There can be multiple run entries in a TTree associated with the same run number and ProcessHistoryID in a file. There can also be multiple lumi entries associated with the same lumi number, run number, and ProcessHistoryID. Both sorting orders will make these subgroups contiguous, but beyond that is up to the client (normally PoolSource, which passes them up to the EventProcessor and EPStates) to deal with merging the multiple run (or lumi) entries together.

One final comment with regards to IndexIntoFileItr. This is not an STL iterator and it cannot be used with std:: algorithms. The data structures are complex and designed to optimize memory usage. It would be difficult or impossible implement an iterator that is STL compliant.

Here is a summary of the data structures in IndexIntoFile. The persistent data consists of two vectors.

processHistoryIDs_ is a std::vector<ProcessHistoryID> that contains the ProcessHistoryIDs with one element in the vector for each unique ProcessHistoryID. On output they are ordered as they first written out for each output file. On input they are ordered as they are first seen in each process. Note that each ProcessHistoryID is stored once in this separate vector. Everywhere else it is needed it stored as an index into this vector because the ProcessHistoryID itself is large and it would take more memory to store them repeatedly in the other vectors. Note that the ProcessHistoryID's referenced in this class are always the "reduced" ProcessHistoryID's, not the ProcessHistoryID of the full ProcessHistory. You cannot use them to directly access the ProcessHistory from the ProcessHistoryRegistry.

runOrLumiEntries_ is a std::vector<RunOrLumiEntry>. This vector holds one element per entry in the run TTree and one element per entry in the lumi TTree. When sorted, everything associated with a given run and ProcessHistoryID will be contiguous in the vector. These groups of entries will be put in the order they first appear in the input file. Within each of these groups the run entries come first in entry order, followed by the entries associated with the lumis. The lumis are also contiguous and sorted by first appearance in the input file. Within a lumi they are sorted by entry order.

There are a number of transient data members also. The 3 most important of these are vectors. To save memory, these are only filled when needed.

runOrLumiIndexes_ is a std::vector<RunOrLumiIndexes>. There is a one to one correspondence between the elements of this vector and the elements of runOrLumiEntries_. The elements of this vector are sorted in numerical order using the ProcessHistoryID index, the run number, and the lumi number. This ordering allows iteration in numerical order and also fast lookup based on run number and lumi number. Each element also has indexes into the eventNumbers_ and eventEntries_ vectors which hold the information giving the event numbers and event entry numbers.

eventNumbers_ is a std::vector containing EventNumber_t's. eventEntries_ is a std::vector containing EventEntry's. If filled, both vectors contain the same number of entries with identical event numbers sorted in the same order. The only difference is that one includes the entry numbers and thus takes more memory. Each element of runOrLumiIndexes_ has the indexes necessary to find the range inside eventNumbers_ or eventEntries_ corresponding to its lumi. Within that range the elements are sorted by event number, which is used for the numerical order iteration and to find an event by the event number.

The details of the data structure are a little different when reading files written before release 3_8_0 (backward compatibility, see RootFile::fillIndexIntoFile for the details).

This data structure is optimized for low memory usage when there are large numbers of events. The optimal case would occur when there was was one run in a file, one luminosity block in that run and everything had the same ProcessHistoryID. If duplicate checking were off and the process simply iterated through the file in the default order, then only the persistent vectors would be filled. One vector would contain 2 elements, one for the run and the other for the lumi. The other vector would contain one element, the ProcessHistoryID. Even if there were a billion events, that would be all that would exist and take up memory. The data structure is not the optimal structure for a very sparse skim, but the overheads should be tolerable given the number of runs and luminosity blocks that should occur in CMS data.

Normally the only the persistent part of the data structure is filled in the output module using two functions designed specifically for that purpose. The functions are addEntry and sortVector_Run_Or_Lumi_Entries.

There are some complexities associated with filling the data structure, mostly revolving around optimizations to minimize the per event memory usage. The client needs to know which parts of the data structure to fill. See the functions below named fixIndexes, setNumberOfEvents, setEventFinder, fillEventNumbers, fillEventEntries, and inputFileClosed.

Note that this class is not intended to be used directly by the average CMS user. PoolSource and PoolOutputModule are the main clients. Other executables that read ROOT format data files, but do not use PoolSource may also need to use it directly (FWLite, Fireworks, edmFileUtil ...). The interface is too complex for general use.

Author

W. David Dagenhart, created 19 May, 2010

Definition at line 192 of file IndexIntoFile.h.

Member Typedef Documentation

typedef long long edm::IndexIntoFile::EntryNumber_t

Definition at line 196 of file IndexIntoFile.h.

Member Enumeration Documentation

enum edm::IndexIntoFile::EntryType

Enumerator
kRun
kLumi
kEvent
kEnd

Definition at line 205 of file IndexIntoFile.h.

enum edm::IndexIntoFile::SortOrder

This enum is used to specify the order of iteration. In firstAppearanceOrder there are 3 sort criteria, in order of precedence these are:

1. firstAppearance of the ProcessHistoryID and run number in the file
2. firstAppearance of the ProcessHistoryID, run number and lumi number in the file
3. entry number

In numerical order the criteria are in order of precedence are:

1. processHistoryID index (which are normally in order of appearance in the process)
2. run number
3. lumi number
4. event number
5. entry number

Enumerator
numericalOrder
firstAppearanceOrder

Definition at line 233 of file IndexIntoFile.h.

Constructor & Destructor Documentation

edm::IndexIntoFile::IndexIntoFile

(

)

Definition at line 52 of file IndexIntoFile.cc.

edm::IndexIntoFile::~IndexIntoFile

(

)

Definition at line 57 of file IndexIntoFile.cc.

Member Function Documentation

void edm::IndexIntoFile::addEntry	(	ProcessHistoryID const &	processHistoryID,
		RunNumber_t	run,
		LuminosityBlockNumber_t	lumi,
		EventNumber_t	event,
		EntryNumber_t	entry
	)

Used by RootOutputModule to fill the persistent data. This will not work properly if entries are not added in the same order as in RootOutputModule

Definition at line 69 of file IndexIntoFile.cc.

IndexIntoFile::IndexIntoFileItr edm::IndexIntoFile::begin

(

SortOrder

sortOrder

)

const

Used to start an iteration over the Runs, Lumis, and Events in a file. Note the argument specifies the order

Definition at line 483 of file IndexIntoFile.cc.

EntryNumber_t& edm::IndexIntoFile::beginEvents ( ) const

inlineprivate

Definition at line 1054 of file IndexIntoFile.h.

IndexIntoFile::SortedRunOrLumiItr edm::IndexIntoFile::beginRunOrLumi

(

)

const

Definition at line 754 of file IndexIntoFile.cc.

bool edm::IndexIntoFile::containsDuplicateEvents

(

)

const

Returns true if the IndexIntoFile contains 2 events with the same ProcessHistoryID index, run number, lumi number and event number.

Definition at line 863 of file IndexIntoFile.cc.

Referenced by edm::DuplicateChecker::inputFileOpened().

bool edm::IndexIntoFile::containsEvent	(	RunNumber_t	run,
		LuminosityBlockNumber_t	lumi,
		EventNumber_t	event
	)		const

Definition at line 740 of file IndexIntoFile.cc.

bool edm::IndexIntoFile::containsItem	(	RunNumber_t	run,
		LuminosityBlockNumber_t	lumi,
		EventNumber_t	event
	)		const

Definition at line 735 of file IndexIntoFile.cc.

bool edm::IndexIntoFile::containsLumi	(	RunNumber_t	run,
		LuminosityBlockNumber_t	lumi
	)		const

Definition at line 745 of file IndexIntoFile.cc.

bool edm::IndexIntoFile::containsRun

(

RunNumber_t

run

)

const

Definition at line 750 of file IndexIntoFile.cc.

int& edm::IndexIntoFile::currentIndex ( ) const

inlineprivate

Definition at line 1056 of file IndexIntoFile.h.

LuminosityBlockNumber_t& edm::IndexIntoFile::currentLumi ( ) const

inlineprivate

Definition at line 1058 of file IndexIntoFile.h.

RunNumber_t& edm::IndexIntoFile::currentRun ( ) const

inlineprivate

Definition at line 1057 of file IndexIntoFile.h.

void edm::IndexIntoFile::doneFileInitialization

(

)

const

Clears the temporary vector of event numbers to reduce memory usage.

Definition at line 318 of file IndexIntoFile.cc.

bool edm::IndexIntoFile::empty

(

)

const

True if no runs, lumis, or events are in the file.

Definition at line 523 of file IndexIntoFile.cc.

Referenced by fwlite::EntryFinder::empty(), fwlite::EntryFinder::findEvent(), fwlite::EntryFinder::findLumi(), and fwlite::EntryFinder::findRun().

IndexIntoFile::IndexIntoFileItr edm::IndexIntoFile::end

(

SortOrder

sortOrder

)

const

Used to end an iteration over the Runs, Lumis, and Events in a file.

Definition at line 499 of file IndexIntoFile.cc.

Referenced by fwlite::EntryFinder::findEvent(), fwlite::EntryFinder::findLumi(), and fwlite::EntryFinder::findRun().

EntryNumber_t& edm::IndexIntoFile::endEvents ( ) const

inlineprivate

Definition at line 1055 of file IndexIntoFile.h.

IndexIntoFile::SortedRunOrLumiItr edm::IndexIntoFile::endRunOrLumi

(

)

const

Definition at line 758 of file IndexIntoFile.cc.

std::vector<EventEntry>& edm::IndexIntoFile::eventEntries ( ) const

inlineprivate

Definition at line 1047 of file IndexIntoFile.h.

std::vector<EventNumber_t>& edm::IndexIntoFile::eventNumbers ( ) const

inlineprivate

Definition at line 1048 of file IndexIntoFile.h.

void edm::IndexIntoFile::fillEventEntries

(

)

const

Fills a vector of objects that contain an event number and the corresponding TTree entry number for the event. Not filling it reduces the memory used by IndexIntoFile. As long as the event finder is still pointing at an open file this will automatically be called on demand (when the event numbers and entries are are needed). It makes sense for the client to fill this explicitly in advance if it is known that it will be needed, because in some cases this will prevent the event numbers vector from being unnecessarily filled (wasting memory). This vector will be needed when iterating over events in numerical order or looking up specific events. The entry numbers are needed if the events are actually read from the input file.

Definition at line 207 of file IndexIntoFile.cc.

void edm::IndexIntoFile::fillEventNumbers

(

)

const

Fills a vector of event numbers. Not filling it reduces the memory used by IndexIntoFile. As long as the event finder is still pointing at an open file this will automatically be called on demand (when the event numbers are are needed). In cases, where the input file may be closed when the need arises, the client code must call this explicitly and fill the vector before the file is closed. In PoolSource, this is necessary when duplicate checking across all files and when doing lookups to see if an event is in a previously opened file. Either this vector or the one that also contains event entry numbers can be used when looking for duplicate events within the same file or looking up events in in the current file without reading them.

Definition at line 202 of file IndexIntoFile.cc.

void edm::IndexIntoFile::fillEventNumbersOrEntries	(	bool	needEventNumbers,
		bool	needEventEntries
	)		const

If needEventNumbers is true then this function does the same thing as fillEventNumbers. If NeedEventEntries is true, then this function does the same thing as fillEventEntries. If both are true, it fills both within the same loop and it uses less CPU than calling those two functions separately.

Definition at line 212 of file IndexIntoFile.cc.

void edm::IndexIntoFile::fillRunOrLumiIndexes ( ) const

private

This function will automatically get called when needed. It depends only on the fact that the persistent data has been filled already.

Definition at line 146 of file IndexIntoFile.cc.

void edm::IndexIntoFile::fillUnsortedEventNumbers ( ) const

private

Definition at line 289 of file IndexIntoFile.cc.

IndexIntoFile::IndexIntoFileItr edm::IndexIntoFile::findEventPosition	(	RunNumber_t	run,
		LuminosityBlockNumber_t	lumi,
		EventNumber_t	event
	)		const

Same as findPosition,except the entry type of the returned iterator will be kEvent or kEnd and the event argument must be nonzero. This means the next thing to be processed will be the event if it is found.

Definition at line 714 of file IndexIntoFile.cc.

Referenced by fwlite::EntryFinder::findEvent().

IndexIntoFile::IndexIntoFileItr edm::IndexIntoFile::findLumiPosition	(	RunNumber_t	run,
		LuminosityBlockNumber_t	lumi
	)		const

Same as findPosition,except the entry type of the returned iterator will be kLumi or kEnd and the lumi argument must be nonzero. This means the next thing to be processed will be the lumi if it is found.

Definition at line 722 of file IndexIntoFile.cc.

Referenced by fwlite::EntryFinder::findLumi().

IndexIntoFile::IndexIntoFileItr edm::IndexIntoFile::findPosition	(	RunNumber_t	run,
		LuminosityBlockNumber_t	lumi = 0U,
		EventNumber_t	event = 0U
	)		const

Find a run, lumi, or event. Returns an iterator pointing at it. The iterator will always be in numericalOrder mode. If it is not found the entry type of the iterator will be kEnd. If it is found the entry type of the iterator will always be kRun so the next thing to be processed is the run containing the desired lumi or event or if looking for a run, the run itself. If the lumi and event arguments are 0 (invalid), then it will find a run. If only the event argument is 0 (invalid), then it will find a lumi. If will look for an event if all three arguments are nonzero or if only the lumi argument is 0 (invalid). Note that it will find the first match only so if there is more than one match then the others cannot be found with this method. The order of the search is by processHistoryID index, then run number, then lumi number, then event entry. If searching for a lumi the iterator will advance directly to the desired lumi after the run even if it is not the first lumi in the run. If searching for an event, the iterator will advance to the lumi containing the run and then the requested event after run even if there are other lumis earlier in that run and other events earlier in that lumi.

Definition at line 528 of file IndexIntoFile.cc.

IndexIntoFile::IndexIntoFileItr edm::IndexIntoFile::findPosition	(	SortOrder	sortOrder,
		RunNumber_t	run,
		LuminosityBlockNumber_t	lumi = 0U,
		EventNumber_t	event = 0U
	)		const

Definition at line 675 of file IndexIntoFile.cc.

IndexIntoFile::IndexIntoFileItr edm::IndexIntoFile::findRunPosition

(

RunNumber_t

run

)

const

Same as findPosition.

Definition at line 730 of file IndexIntoFile.cc.

Referenced by fwlite::EntryFinder::findRun().

void edm::IndexIntoFile::fixIndexes

(

std::vector< ProcessHistoryID > &

processHistoryIDs

)

Used by PoolSource to force the ProcessHistoryID indexes to be consistent across all input files. Currently this consistency is important when duplicate checking across all input files. It may be important for other reasons in the future. It is important this be called immediately after reading in the object from the input file, before filling the transient data members or using the indexes in any way.

Definition at line 389 of file IndexIntoFile.cc.

EventNumber_t edm::IndexIntoFile::getEventNumberOfEntry ( EntryNumber_t  entry ) const

inlineprivate

Definition at line 1061 of file IndexIntoFile.h.

void edm::IndexIntoFile::initializeTransients ( ) const

inline

Definition at line 1010 of file IndexIntoFile.h.

void edm::IndexIntoFile::inputFileClosed

(

)

const

Clear some vectors and eventFinder when an input file is closed. This reduces the memory used by IndexIntoFile

Definition at line 310 of file IndexIntoFile.cc.

bool edm::IndexIntoFile::iterationWillBeInEntryOrder

(

SortOrder

sortOrder

)

const

Used to determine whether or not to disable fast cloning.

Definition at line 510 of file IndexIntoFile.cc.

std::map<IndexRunLumiKey, EntryNumber_t>& edm::IndexIntoFile::lumiToFirstEntry ( ) const

inlineprivate

Definition at line 1053 of file IndexIntoFile.h.

size_t edm::IndexIntoFile::numberOfEvents ( ) const

inlineprivate

Definition at line 1060 of file IndexIntoFile.h.

int& edm::IndexIntoFile::previousAddedIndex ( ) const

inlineprivate

Definition at line 1051 of file IndexIntoFile.h.

ProcessHistoryID const & edm::IndexIntoFile::processHistoryID

(

int

i

)

const

Definition at line 60 of file IndexIntoFile.cc.

std::vector< ProcessHistoryID > const & edm::IndexIntoFile::processHistoryIDs

(

)

const

Definition at line 64 of file IndexIntoFile.cc.

void edm::IndexIntoFile::reduceProcessHistoryIDs

(

ProcessHistoryRegistry const &

processHistoryRegistry

)

Used for backward compatibility to convert objects created with releases that used the full ProcessHistoryID in IndexIntoFile to use the reduced ProcessHistoryID.

Definition at line 323 of file IndexIntoFile.cc.

void edm::IndexIntoFile::resetEventFinder ( ) const

inlineprivate

Definition at line 1046 of file IndexIntoFile.h.

std::vector<RunOrLumiEntry> const& edm::IndexIntoFile::runOrLumiEntries ( ) const

inline

Used internally and for test purposes.

Definition at line 1005 of file IndexIntoFile.h.

std::vector<RunOrLumiIndexes>& edm::IndexIntoFile::runOrLumiIndexes ( ) const

inlineprivate

Definition at line 1059 of file IndexIntoFile.h.

std::map<IndexRunKey, EntryNumber_t>& edm::IndexIntoFile::runToFirstEntry ( ) const

inlineprivate

Definition at line 1052 of file IndexIntoFile.h.

void edm::IndexIntoFile::set_intersection	(	IndexIntoFile const &	indexIntoFile,
		std::set< IndexRunLumiEventKey > &	intersection
	)		const

The intersection argument will be filled with an entry for each event in both IndexIntoFile objects. To be added the event must have the same ProcessHistoryID index, run number, lumi number and event number.

Definition at line 762 of file IndexIntoFile.cc.

Referenced by edm::DuplicateChecker::inputFileOpened().

void edm::IndexIntoFile::setEventFinder ( std::shared_ptr< EventFinder >  ptr ) const

inline

Calling this enables the functions that fill the event vectors to get the event numbers. It needs to be called before filling the events vectors This implies the client needs to define a class that inherits from EventFinder and then create one. This function is used to pass in a pointer to its base class.

Definition at line 935 of file IndexIntoFile.h.

Referenced by fwlite::EntryFinder::fillIndex().

void edm::IndexIntoFile::setNumberOfEvents ( EntryNumber_t  nevents ) const

inline

The number of events needs to be set before filling the transient event vectors. It is used to resize them.

Definition at line 926 of file IndexIntoFile.h.

Referenced by fwlite::EntryFinder::fillIndex().

std::vector<ProcessHistoryID>& edm::IndexIntoFile::setProcessHistoryIDs ( )

inline

Used for backward compatibility and tests. RootFile::fillIndexIntoFile uses this to deal with input files created with releases before 3_8_0 which do not contain an IndexIntoFile.

Definition at line 994 of file IndexIntoFile.h.

std::vector<RunOrLumiEntry>& edm::IndexIntoFile::setRunOrLumiEntries ( )

inline

Used for backward compatibility and tests. RootFile::fillIndexIntoFile uses this to deal with input files created with releases before 3_8_0 which do not contain an IndexIntoFile.

Definition at line 989 of file IndexIntoFile.h.

void edm::IndexIntoFile::sortEventEntries ( ) const

private

Definition at line 457 of file IndexIntoFile.cc.

void edm::IndexIntoFile::sortEvents ( ) const

private

Definition at line 431 of file IndexIntoFile.cc.

void edm::IndexIntoFile::sortVector_Run_Or_Lumi_Entries

(

)

Used by RootOutputModule after all entries have been added. This only works after the correct sequence of addEntry calls, because it makes some corrections before sorting. A std::stable_sort works in cases where those corrections are not needed.

Definition at line 412 of file IndexIntoFile.cc.

std::vector<EventNumber_t>& edm::IndexIntoFile::unsortedEventNumbers ( ) const

inline

If something external to IndexIntoFile is reading through the EventAuxiliary then it could use this to fill in the event numbers so that IndexIntoFile will not read through it again.

Definition at line 977 of file IndexIntoFile.h.

Friends And Related Function Documentation

friend class ::TestIndexIntoFile

friend

Definition at line 1034 of file IndexIntoFile.h.

friend class ::TestIndexIntoFile1

friend

Definition at line 1035 of file IndexIntoFile.h.

friend class ::TestIndexIntoFile2

friend

Definition at line 1036 of file IndexIntoFile.h.

friend class ::TestIndexIntoFile3

friend

Definition at line 1037 of file IndexIntoFile.h.

friend class ::TestIndexIntoFile4

friend

Definition at line 1038 of file IndexIntoFile.h.

friend class ::TestIndexIntoFile5

friend

Definition at line 1039 of file IndexIntoFile.h.

Member Data Documentation

IndexIntoFile::EntryNumber_t const edm::IndexIntoFile::invalidEntry = -1LL

static

Definition at line 203 of file IndexIntoFile.h.

EventNumber_t const edm::IndexIntoFile::invalidEvent = 0U

static

Definition at line 202 of file IndexIntoFile.h.

int const edm::IndexIntoFile::invalidIndex = -1

static

Definition at line 199 of file IndexIntoFile.h.

LuminosityBlockNumber_t const edm::IndexIntoFile::invalidLumi = 0U

static

Definition at line 201 of file IndexIntoFile.h.

RunNumber_t const edm::IndexIntoFile::invalidRun = 0U

static

Definition at line 200 of file IndexIntoFile.h.

std::vector<ProcessHistoryID> edm::IndexIntoFile::processHistoryIDs_

private

Definition at line 1067 of file IndexIntoFile.h.

std::vector<RunOrLumiEntry> edm::IndexIntoFile::runOrLumiEntries_

private

Definition at line 1068 of file IndexIntoFile.h.

Transients edm::IndexIntoFile::transient_

mutableprivate

Definition at line 1065 of file IndexIntoFile.h.