MAKLogger::DtMessageInput Class Reference

The message input is the interface for objects that provide messages into the pipeline. More...

Inheritance diagram for MAKLogger::DtMessageInput:

Collaboration diagram for MAKLogger::DtMessageInput:

Public Member Functions
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
	DtMessageInput ()

Protected Attributes
DtAbsoluteTime	myCurrentTime
bool	myStopReadingBoundary
double	myTimeLimit
double	myNextPacketTime
DtMessageBuffer	myInsertBuffer

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

Detailed Description

The message input is the interface for objects that provide messages into the pipeline.

Constructor & Destructor Documentation

MAKLogger::DtMessageInput::DtMessageInput ( )

protected

MAKLogger::DtMessageInput::DtMessageInput ( const DtMessageInput &  )

private

Not Implemented.

virtual MAKLogger::DtMessageInput::~DtMessageInput ( )

virtual

Member Function Documentation

virtual void MAKLogger::DtMessageInput::activate ( )

pure virtual

Called when the input is activated.

Implemented in MAKLogger::DtLoggerFileReader, and MAKLogger::DtLgrSimInput.

virtual void MAKLogger::DtMessageInput::deactivate ( )

pure virtual

Called when the input is deactivated.

Implemented in MAKLogger::DtLoggerFileReader, and MAKLogger::DtLgrSimInput.

virtual void MAKLogger::DtMessageInput::dropNextMessages ( )

pure virtual

Called to drop messages from the current read operation.

Implemented in MAKLogger::DtLgrSimInput, and MAKLogger::DtLoggerFileReader.

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

pure virtual

Called when the pipeline needs to get messages.

Implemented in MAKLogger::DtLgrSimInput, MAKLogger::DtLoggerFileReader, and MAKLogger::DtMultiMessageInput.

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

pure virtual

The the message info for the input.

Implemented in MAKLogger::DtLoggerFileReader, and MAKLogger::DtLgrDisSimInput.

virtual DtAbsoluteTime MAKLogger::DtMessageInput::inputTime ( ) const

virtual

Get the current input time.

Reimplemented in MAKLogger::DtLgrSimInput, and MAKLogger::DtMultiMessageInput.

virtual void MAKLogger::DtMessageInput::insertPacket ( DtPacket *  packet )

virtual

Insert a packet into the input stream.

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

private

Not Implemented.

virtual void MAKLogger::DtMessageInput::setStopReadingTimeBoundary ( bool  inclusive )

virtual

The stop reading time (set by startReadMessages may be inclusive or exclusive.

By default it is inclusive. For example, reading up to 10 seconds contains all messages with timestamps <= 10. Setting boundary to be false (exclusive) will result to a read up to 10s but not including packets with a time of 10s.

virtual void MAKLogger::DtMessageInput::setTimeLimit ( double  limit )

virtual

Set the time limit on reads during playback.

Units are seconds. A value less than zero indicates no limit.

virtual void MAKLogger::DtMessageInput::startReadMessages ( DtAbsoluteTime  timeToRead )

virtual

Called at the beginning of a read operation.

Reimplemented in MAKLogger::DtMultiMessageInput.

virtual bool MAKLogger::DtMessageInput::stopReadingBoundary ( ) const

virtual

Get the current stop reading boundary setting.

Return values

true	Time is Inclusive
false	Time is Exclusive.

virtual void MAKLogger::DtMessageInput::stopReadMessages ( )

virtual

Called at the end of a read operation.

Reimplemented in MAKLogger::DtMultiMessageInput.

virtual void MAKLogger::DtMessageInput::tick ( )

virtual

Tick the message input – for repeating tasks, such as timeout checks.

Member Data Documentation

DtAbsoluteTime MAKLogger::DtMessageInput::myCurrentTime

protected

DtMessageBuffer MAKLogger::DtMessageInput::myInsertBuffer

protected

double MAKLogger::DtMessageInput::myNextPacketTime

protected

bool MAKLogger::DtMessageInput::myStopReadingBoundary

protected

double MAKLogger::DtMessageInput::myTimeLimit

protected

---

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

• messageInput.h