Public Types
typedef std::vector< IndexRecord >	IndexRecordContainer
typedef std::vector < IndexRecord >::iterator	IndexRecordIter
typedef std::vector < IndexRecord > ::const_iterator	ConstIndexRecordIter
Public Member Functions
	~CIndexReader ()
void	close () const
int	getFilePosByTime (UINT64 time, UINT64 &pos) const
IndexHeader const &	header () const
IndexTrailer const &	trailer () const
ConstIndexRecordIter	indexRecordsBegin () const
ConstIndexRecordIter	indexRecordsEnd () const
UINT32	numRecords () const
void	dumpHeader (std::ostream &out)
void	dumpTrailer (std::ostream &out)
void	dumpAll (std::ostream &out)
Friends
class	CIndexer< CIndexReader >
std::ostream &	operator<< (std::ostream &out, CIndexReader const &r)

Constructor & Destructor Documentation

x3c::indexer::CIndexReader::~CIndexReader ( )

Destructor

Member Function Documentation

void x3c::indexer::CIndexReader::close ( ) const

Closes the index file that was opened for either reading.

void x3c::indexer::CIndexReader::dumpAll ( std::ostream & out )

Writes out the index file

Parameters:

stream to write out to

void x3c::indexer::CIndexReader::dumpHeader ( std::ostream & out )

Writes out the index file header

Parameters:

stream to write out to

void x3c::indexer::CIndexReader::dumpTrailer ( std::ostream & out )

Writes out the index file trailer

Parameters:

stream to write out to

int x3c::indexer::CIndexReader::getFilePosByTime	(	UINT64	time,
		UINT64 &	pos
	)		const

Returns the file offset for the closest index that is less than or equal to time

Parameters:

time	the timestamp to search for
the	offset from the start of the stream file

IndexHeader const & x3c::indexer::CIndexReader::header ( ) const [inline]

Return the IndexHeader for this index file

CIndexReader::ConstIndexRecordIter x3c::indexer::CIndexReader::indexRecordsBegin ( ) const [inline]

Return the IndexRecord iterator for this index file

UINT32 x3c::indexer::CIndexReader::numRecords ( ) const [inline]

Returns the number of records read

IndexTrailer const & x3c::indexer::CIndexReader::trailer ( ) const [inline]

Return the IndexTrailer for this index file

friend class CIndexer< CIndexReader > [friend]

Allow construction and destruction only from CIndexer<CIndexReader>

The documentation for this class was generated from the following file: