MAKLogger::DtLoggerFileReader Class Reference

The class responsible for reading a playback file to the pipeline. More...

Inheritance diagram for MAKLogger::DtLoggerFileReader:

Collaboration diagram for MAKLogger::DtLoggerFileReader:

Public Member Functions
virtual	~DtLoggerFileReader ()
	Virtual CTOR. More...
virtual const DtLoggerPlaybackFile *	playbackFile () const
	Get the attached file for reading. More...
virtual void	setReadBufferSize (size_t)
	Set the read buffer size. More...
virtual size_t	getReadBufferSize () const
	Get the read buffer size. More...
DtMessageInput interface implementation.
virtual void	activate ()
	Called when the input is activated. More...
virtual void	deactivate ()
	Called when the input is deactivated. More...
virtual void	getNextMessages (DtMessageBuffer &)
	Called when the pipeline needs to get messages. More...
virtual void	dropNextMessages ()
	Called to drop messages from the current read operation. More...
virtual const DtMessageIOInfo *	info () const
	The the message info for the input. More...
DtLgrFileInput interface implementation.
virtual double	peekCurrentPacketTime ()
	Get the current packet time. More...
virtual int	peekCurrentPacketType ()
	Get the current packet type. More...
virtual size_t	peekCurrentPacketSize ()
	Get the current packet size. More...
virtual bool	recoverLastPacket ()
	Recover the last packet. More...
virtual bool	isCheckpointNecessary (DtAbsoluteTime currentTime, DtAbsoluteTime newTime)
	Get the current packet time. More...
virtual void	seekToPreviousCheckpoint (DtAbsoluteTime timeToJumpBefore)
	Get the current packet time. More...
virtual void	seekToNextCheckpoint (DtAbsoluteTime currentTime)
	Get the current packet time. More...
virtual const DtString &	filename () const
	Get the filename. More...
virtual DtFilePosition	fileSize () const
	Get the size of the file. More...
virtual DtFilePosition	currentPosition () const
	Get the current position in the file. More...
virtual DtAbsoluteTime	firstMessageTime () const
	Get the time of the first message in the file. More...
virtual DtAbsoluteTime	lastMessageTime () const
	Get the time of the last message in the file. More...
virtual DtRelativeTime	duration () const
	Get the duration of the file. More...
virtual DtString	description () const
	Get the description of the file. More...
virtual DtAbsoluteTime	lastReadTime () const
	Get the time of the last message read in the file. More...
virtual DtLgrEntityTracker *	entityTracker () const
	Get the current entity tracker, or null if none. More...
virtual bool	testFileExpanding (bool updateLastTime=true)
	Test if file is expanding (e.g., file is being simultaneously recorded). More...
Public Member Functions inherited from MAKLogger::DtLgrFileInput
virtual	~DtLgrFileInput ()
Public Member Functions inherited from MAKLogger::DtMessageInput
virtual	~DtMessageInput ()
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	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 Attributes
DtLoggerPlaybackFile *	myCurrentFile
DtAbsoluteTime	myLastTimeRead
DtAbsoluteTime	myLastTime
DtAbsoluteTime	myFirstTime
size_t	myBufferSize
DtMessageIOInfo *	myMessageInfo
DtMemoryBufferSP	myMemory
Protected Attributes inherited from MAKLogger::DtMessageInput
DtAbsoluteTime	myCurrentTime
bool	myStopReadingBoundary
double	myTimeLimit
double	myNextPacketTime
DtMessageBuffer	myInsertBuffer

Private Member Functions
	DtLoggerFileReader (const DtLoggerFileReader &)
	Not Implemented. More...
DtLoggerFileReader &	operator= (const DtLoggerFileReader &)
	Not Implemented. More...

Additional Inherited Members
Protected Member Functions inherited from MAKLogger::DtLgrFileInput
	DtLgrFileInput ()
Protected Member Functions inherited from MAKLogger::DtMessageInput
	DtMessageInput ()

Detailed Description

The class responsible for reading a playback file to the pipeline.

Constructor & Destructor Documentation

virtual MAKLogger::DtLoggerFileReader::~DtLoggerFileReader ( )

virtual

Virtual CTOR.

DTOR

MAKLogger::DtLoggerFileReader::DtLoggerFileReader ( const DtLoggerFileReader &  )

private

Not Implemented.

Member Function Documentation

virtual void MAKLogger::DtLoggerFileReader::activate ( )

virtual

Called when the input is activated.

Implements MAKLogger::DtMessageInput.

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

virtual

Get the current position in the file.

Implements MAKLogger::DtLgrFileInput.

virtual void MAKLogger::DtLoggerFileReader::deactivate ( )

virtual

Called when the input is deactivated.

Implements MAKLogger::DtMessageInput.

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

virtual

Get the description of the file.

Implements MAKLogger::DtLgrFileInput.

virtual void MAKLogger::DtLoggerFileReader::dropNextMessages ( )

virtual

Called to drop messages from the current read operation.

Implements MAKLogger::DtMessageInput.

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

virtual

Get the duration of the file.

Implements MAKLogger::DtLgrFileInput.

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

virtual

Get the current entity tracker, or null if none.

Implements MAKLogger::DtLgrFileInput.

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

virtual

Get the filename.

Implements MAKLogger::DtLgrFileInput.

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

virtual

Get the size of the file.

Implements MAKLogger::DtLgrFileInput.

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

virtual

Get the time of the first message in the file.

Implements MAKLogger::DtLgrFileInput.

virtual void MAKLogger::DtLoggerFileReader::getNextMessages ( DtMessageBuffer &  )

virtual

Called when the pipeline needs to get messages.

Implements MAKLogger::DtMessageInput.

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

virtual

Get the read buffer size.

Implements MAKLogger::DtLgrFileInput.

virtual const DtMessageIOInfo* MAKLogger::DtLoggerFileReader::info ( ) const

virtual

The the message info for the input.

Implements MAKLogger::DtMessageInput.

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

virtual

Get the current packet time.

Exceptions

DtFileReadError

file read error.

Implements MAKLogger::DtLgrFileInput.

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

virtual

Get the time of the last message in the file.

Implements MAKLogger::DtLgrFileInput.

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

virtual

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

Implements MAKLogger::DtLgrFileInput.

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

private

Not Implemented.

virtual size_t MAKLogger::DtLoggerFileReader::peekCurrentPacketSize ( )

virtual

Get the current packet size.

Exceptions

DtFileReadError

file read error.

Implements MAKLogger::DtLgrFileInput.

virtual double MAKLogger::DtLoggerFileReader::peekCurrentPacketTime ( )

virtual

Get the current packet time.

Exceptions

DtFileReadError

file read error.

Implements MAKLogger::DtLgrFileInput.

virtual int MAKLogger::DtLoggerFileReader::peekCurrentPacketType ( )

virtual

Get the current packet type.

Exceptions

DtFileReadError

file read error.

Implements MAKLogger::DtLgrFileInput.

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

virtual

Get the attached file for reading.

Implements MAKLogger::DtLgrFileInput.

virtual bool MAKLogger::DtLoggerFileReader::recoverLastPacket ( )

virtual

Recover the last packet.

Implements MAKLogger::DtLgrFileInput.

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

virtual

Get the current packet time.

Exceptions

DtFileReadError

file read error.

Implements MAKLogger::DtLgrFileInput.

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

virtual

Get the current packet time.

Exceptions

DtFileReadError

file read error.

Implements MAKLogger::DtLgrFileInput.

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

virtual

Set the read buffer size.

Implements MAKLogger::DtLgrFileInput.

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

virtual

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

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

Implements MAKLogger::DtLgrFileInput.

Member Data Documentation

size_t MAKLogger::DtLoggerFileReader::myBufferSize

protected

DtLoggerPlaybackFile* MAKLogger::DtLoggerFileReader::myCurrentFile

protected

DtAbsoluteTime MAKLogger::DtLoggerFileReader::myFirstTime

protected

DtAbsoluteTime MAKLogger::DtLoggerFileReader::myLastTime

protected

DtAbsoluteTime MAKLogger::DtLoggerFileReader::myLastTimeRead

protected

DtMemoryBufferSP MAKLogger::DtLoggerFileReader::myMemory

protected

DtMessageIOInfo* MAKLogger::DtLoggerFileReader::myMessageInfo

protected

---

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

• loggerFileReader.h