A file opened for reading. More...

Inheritance diagram for MAKLogger::DtLoggerInputFile:

Collaboration diagram for MAKLogger::DtLoggerInputFile:

Public Member Functions
virtual	~DtLoggerInputFile ()
	Opens a file for input and reads the version and any meta data.
virtual int	fileDescriptor ()
	Get the file descriptor to access the file.
virtual DtFilePosition	startOfPackets ()
	Get the position for the start of packets.
Public Member Functions inherited from MAKLogger::DtLoggerFile
virtual	~DtLoggerFile ()
	DTOR.
virtual int	fileVersion () const
	Get the file version.
virtual const DtString &	filename () const
	Get the file name.

Protected Member Functions
void	openFileForInput (bool randomAccess)
	Non virtual since called by constructor.
void	close ()
	Non virtual since called by destructor.
int	readFileVersion ()
	Non virtual since called by constructor.
virtual void	setFileDescriptor (int fd)
	Set the file descriptor.
Protected Member Functions inherited from MAKLogger::DtLoggerFile
	DtLoggerFile (const DtString &filename, int fileVersion)
	Create a Logger file from an existing file.
virtual void	setFileVersion (int fileVersion)
	Set the file version.
virtual void	setFilename (const DtString &filename)
	Set the filename.

Protected Attributes
int	myFileDescriptor
Protected Attributes inherited from MAKLogger::DtLoggerFile
DtString	myFilename
int	myFileVersion

Detailed Description

A file opened for reading.

Constructor & Destructor Documentation

virtual MAKLogger::DtLoggerInputFile::~DtLoggerInputFile ( )

virtual

Opens a file for input and reads the version and any meta data.

Under windows, specifying random access causes the OS to cache the file in RAM improving performance of random access.

Exceptions

DtFileOpenError	if unable to open the file.
DtFileReadError	if unable to read from the file. DTOR.

void MAKLogger::DtLoggerInputFile::close ( )

protected

Non virtual since called by destructor.

virtual int MAKLogger::DtLoggerInputFile::fileDescriptor ( )

virtual

Get the file descriptor to access the file.

void MAKLogger::DtLoggerInputFile::openFileForInput ( bool randomAccess )

protected

Non virtual since called by constructor.

int MAKLogger::DtLoggerInputFile::readFileVersion ( )

protected

Non virtual since called by constructor.

virtual void MAKLogger::DtLoggerInputFile::setFileDescriptor ( int fd )

protectedvirtual

Set the file descriptor.

virtual DtFilePosition MAKLogger::DtLoggerInputFile::startOfPackets ( )

virtual

Get the position for the start of packets.

Typically there is the version.

int MAKLogger::DtLoggerInputFile::myFileDescriptor

protected

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