An abstract interface for message input from a file. More...

Inheritance diagram for MAKLogger::DtLgrFileInput:

Collaboration diagram for MAKLogger::DtLgrFileInput:

Public Member Functions
virtual	~DtLgrFileInput ()

virtual const DtLoggerPlaybackFile *	playbackFile () const =0
	Get the attached file for reading. More...

virtual void	setReadBufferSize (size_t)=0
	Set the read buffer size. More...

virtual size_t	getReadBufferSize () const =0
	Get the read buffer size. More...

virtual bool	isCheckpointNecessary (DtAbsoluteTime currentTime, DtAbsoluteTime newTime)=0
	Check to see if checkpoint is necessary. More...

virtual void	seekToPreviousCheckpoint (DtAbsoluteTime timeToJumpBefore)=0
	Seek to fist checkpoint before time. More...

virtual void	seekToNextCheckpoint (DtAbsoluteTime currentTime)=0
	Seek to fist checkpoint before time. More...

virtual double	peekCurrentPacketTime ()=0
	Get the current packet time. More...

virtual int	peekCurrentPacketType ()=0
	Get the current packet type. More...

virtual size_t	peekCurrentPacketSize ()=0
	Get the current packet size. More...

virtual bool	recoverLastPacket ()=0
	Recover the last packet Return - last packet recoverd? More...

virtual const DtString &	filename () const =0
	Get the filename. More...

virtual DtFilePosition	fileSize () const =0
	Get the size of the file. More...

virtual DtFilePosition	currentPosition () const =0
	Get the current position in the file. More...

virtual DtAbsoluteTime	firstMessageTime () const =0
	Get the time of the first message in the file. More...

virtual DtAbsoluteTime	lastMessageTime () const =0
	Get the time of the last message in the file. More...

virtual DtRelativeTime	duration () const =0
	Get the duration of the file. More...

virtual DtString	description () const =0
	Get the description of the file. More...

virtual DtAbsoluteTime	lastReadTime () const =0
	Get the time of the last message read in the file. More...

virtual DtLgrEntityTracker *	entityTracker () const =0
	Get the file's entity tracker, or null if it has none. More...

virtual bool	testFileExpanding (bool updateLastTime=true)=0
	Test if file is expanding (e.g., file is being simultaneously recorded). More...

Public Member Functions inherited from MAKLogger::DtMessageInput
virtual	~DtMessageInput ()

virtual void	activate ()=0
	Called when the input is activated. More...

virtual void	deactivate ()=0
	Called when the input is deactivated. More...

virtual void	startReadMessages (DtAbsoluteTime timeToRead)
	Called at the beginning of a read operation. More...

virtual void	stopReadMessages ()
	Called at the end of a read operation. More...

virtual DtAbsoluteTime	inputTime () const
	Get the current input time. More...

virtual void	setStopReadingTimeBoundary (bool inclusive)
	The stop reading time (set by startReadMessages may be inclusive or exclusive. More...

virtual bool	stopReadingBoundary () const
	Get the current stop reading boundary setting. More...

virtual void	getNextMessages (DtMessageBuffer &)=0
	Called when the pipeline needs to get messages. More...

virtual void	dropNextMessages ()=0
	Called to drop messages from the current read operation. More...

virtual const DtMessageIOInfo *	info () const =0
	The the message info for the input. More...

virtual void	tick ()
	Tick the message input – for repeating tasks, such as timeout checks. More...

virtual void	setTimeLimit (double limit)
	Set the time limit on reads during playback. More...

virtual void	insertPacket (DtPacket *packet)
	Insert a packet into the input stream. More...

Protected Member Functions
	DtLgrFileInput ()

Protected Member Functions inherited from MAKLogger::DtMessageInput
	DtMessageInput ()

Private Member Functions
	DtLgrFileInput (const DtLgrFileInput &)
	Not Implemented. More...

DtLgrFileInput &	operator= (const DtLgrFileInput &)
	Not Implemented. More...

Additional Inherited Members
Protected Attributes inherited from MAKLogger::DtMessageInput
DtAbsoluteTime	myCurrentTime

bool	myStopReadingBoundary

double	myTimeLimit

double	myNextPacketTime

DtMessageBuffer	myInsertBuffer

Detailed Description

An abstract interface for message input from a file.

Constructor & Destructor Documentation

MAKLogger::DtLgrFileInput::DtLgrFileInput ( )

protected

virtual MAKLogger::DtLgrFileInput::~DtLgrFileInput ( )

virtual

MAKLogger::DtLgrFileInput::DtLgrFileInput ( const DtLgrFileInput & )

private

Not Implemented.

Member Function Documentation

virtual DtFilePosition MAKLogger::DtLgrFileInput::currentPosition ( ) const

pure virtual

Get the current position in the file.

Implemented in MAKLogger::DtLoggerFileReader.

virtual DtString MAKLogger::DtLgrFileInput::description ( ) const

pure virtual

Get the description of the file.

Implemented in MAKLogger::DtLoggerFileReader.

virtual DtRelativeTime MAKLogger::DtLgrFileInput::duration ( ) const

pure virtual

Get the duration of the file.

Implemented in MAKLogger::DtLoggerFileReader.

virtual DtLgrEntityTracker* MAKLogger::DtLgrFileInput::entityTracker ( ) const

pure virtual

Get the file's entity tracker, or null if it has none.

Implemented in MAKLogger::DtLoggerFileReader.

virtual const DtString& MAKLogger::DtLgrFileInput::filename ( ) const

pure virtual

Get the filename.

Implemented in MAKLogger::DtLoggerFileReader.

virtual DtFilePosition MAKLogger::DtLgrFileInput::fileSize ( ) const

pure virtual

Get the size of the file.

Implemented in MAKLogger::DtLoggerFileReader.

virtual DtAbsoluteTime MAKLogger::DtLgrFileInput::firstMessageTime ( ) const

pure virtual

Get the time of the first message in the file.

Implemented in MAKLogger::DtLoggerFileReader.

virtual size_t MAKLogger::DtLgrFileInput::getReadBufferSize ( ) const

pure virtual

Get the read buffer size.

Implemented in MAKLogger::DtLoggerFileReader.

virtual bool MAKLogger::DtLgrFileInput::isCheckpointNecessary	(	DtAbsoluteTime	currentTime,
		DtAbsoluteTime	newTime
	)

pure virtual

Check to see if checkpoint is necessary.

Implemented in MAKLogger::DtLoggerFileReader.

virtual DtAbsoluteTime MAKLogger::DtLgrFileInput::lastMessageTime ( ) const

pure virtual

Get the time of the last message in the file.

Implemented in MAKLogger::DtLoggerFileReader.

virtual DtAbsoluteTime MAKLogger::DtLgrFileInput::lastReadTime ( ) const

pure virtual

Get the time of the last message read in the file.

Implemented in MAKLogger::DtLoggerFileReader.

DtLgrFileInput& MAKLogger::DtLgrFileInput::operator= ( const DtLgrFileInput & )

private

Not Implemented.

virtual size_t MAKLogger::DtLgrFileInput::peekCurrentPacketSize ( )

pure virtual

Get the current packet size.

Exceptions

DtFileReadError file read error.

Implemented in MAKLogger::DtLoggerFileReader.

virtual double MAKLogger::DtLgrFileInput::peekCurrentPacketTime ( )

pure virtual

Get the current packet time.

Exceptions

DtFileReadError file read error.

Implemented in MAKLogger::DtLoggerFileReader.

virtual int MAKLogger::DtLgrFileInput::peekCurrentPacketType ( )

pure virtual

Get the current packet type.

Exceptions

DtFileReadError file read error.

Implemented in MAKLogger::DtLoggerFileReader.

virtual const DtLoggerPlaybackFile* MAKLogger::DtLgrFileInput::playbackFile ( ) const

pure virtual

Get the attached file for reading.

Implemented in MAKLogger::DtLoggerFileReader.

virtual bool MAKLogger::DtLgrFileInput::recoverLastPacket ( )

pure virtual

Recover the last packet Return - last packet recoverd?

Implemented in MAKLogger::DtLoggerFileReader.

virtual void MAKLogger::DtLgrFileInput::seekToNextCheckpoint ( DtAbsoluteTime currentTime )

pure virtual

Seek to fist checkpoint before time.

Implemented in MAKLogger::DtLoggerFileReader.

virtual void MAKLogger::DtLgrFileInput::seekToPreviousCheckpoint ( DtAbsoluteTime timeToJumpBefore )

pure virtual

Seek to fist checkpoint before time.

Implemented in MAKLogger::DtLoggerFileReader.

virtual void MAKLogger::DtLgrFileInput::setReadBufferSize ( size_t )

pure virtual

Set the read buffer size.

Implemented in MAKLogger::DtLoggerFileReader.

virtual bool MAKLogger::DtLgrFileInput::testFileExpanding ( bool updateLastTime = true )

pure virtual

Test if file is expanding (e.g., file is being simultaneously recorded).

If so, reset last time Return bool: Is file expanding?

Implemented in MAKLogger::DtLoggerFileReader.

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

lgrFileInput.h

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation