MAKLogger::DtLgrSimInput Class Reference

The base class to help simulation input. More...

Inheritance diagram for MAKLogger::DtLgrSimInput:

Collaboration diagram for MAKLogger::DtLgrSimInput:

Public Member Functions
virtual	~DtLgrSimInput ()
	DTOR to clean up any resources.
virtual void	activate ()
	Activate the input.
virtual void	activateImplementation ()=0
	Perform protocol-specific activation.
virtual bool	isActivated () const
	Get whether the output is active.
virtual void	deactivate ()
	Activate the input.
virtual void	deactivateImplementation ()=0
	Perform protocol-specific activation.
virtual void	startReadMessages ()
	Called at the beginning of a read operation.
virtual void	setClock (DtLgrClock *clockToUse)
	Set the clock to use for time.
virtual DtAbsoluteTime	inputTime () const
	Get the current input time.
virtual void	getNextMessages (DtMessageBuffer &)
	Get the next messages received.
virtual void	dropNextMessages ()
	Called to drop messages from the current read operation.
virtual bool	receivedPackets ()
	Have you received packets since last call.
virtual void	connecting ()=0
	Called when simulation is connecting.
virtual void	disconnecting ()=0
	Called when simulation is disconnecting.
virtual DtLgrEntityTracker *	entityTracker ()
virtual void	initializeTracker (DtLgrBaseSimManager *manager)
virtual DtLgrClock *	clock ()
	Get the clock used for time.
virtual const DtLgrClock *	clock () const
	Get the clock used for time.
Public Member Functions inherited from MAKLogger::DtMessageInput
virtual	~DtMessageInput ()
virtual void	startReadMessages (DtAbsoluteTime timeToRead)
	Called at the beginning of a read operation.
virtual void	stopReadMessages ()
	Called at the end of a read operation.
virtual void	setStopReadingTimeBoundary (bool inclusive)
	The stop reading time (set by startReadMessages may be inclusive or exclusive.
virtual bool	stopReadingBoundary () const
	Get the current stop reading boundary setting.
virtual const DtMessageIOInfo *	info () const =0
	The the message info for the input.
virtual void	tick ()
	Tick the message input – for repeating tasks, such as timeout checks.
virtual void	setTimeLimit (double limit)
	Set the time limit on reads during playback.
virtual void	insertPacket (DtPacket *packet)
	Insert a packet into the input stream.

Protected Member Functions
	DtLgrSimInput (DtLgrSimManager &manager)
	CTOR is protected since sub class will be the final object.
virtual DtPacket *	createPacket (size_t size, DtPacket::DtPacketType type)
	Creates an empty packet suitable for writing data into. The packet also is added to an internal buffer.
virtual void	receivePacket (DtPacket *packet)
	Called internally to add a packet to a receive buffer.
virtual void	filterPacket (DtPacket *packet)
	Filter.
Protected Member Functions inherited from MAKLogger::DtMessageInput
	DtMessageInput ()

Protected Attributes
bool	myReceivePacketsFlag
DtMessageBuffer *	myReceiveBuffer
DtSmartBuffer *	mySmartBuffer
DtLgrSimManager &	myManager
bool	myActivateFlag
DtLgrClock *	myClock
Protected Attributes inherited from MAKLogger::DtMessageInput
DtAbsoluteTime	myCurrentTime
bool	myStopReadingBoundary
double	myTimeLimit
double	myNextPacketTime
DtMessageBuffer	myInsertBuffer

Static Protected Attributes
static const int	theSmartBufferSize = 65536

Detailed Description

The base class to help simulation input.

Constructor & Destructor Documentation

virtual MAKLogger::DtLgrSimInput::~DtLgrSimInput ( )

virtual

DTOR to clean up any resources.

MAKLogger::DtLgrSimInput::DtLgrSimInput ( DtLgrSimManager &  manager )

protected

CTOR is protected since sub class will be the final object.

Member Function Documentation

virtual void MAKLogger::DtLgrSimInput::activate ( )

virtual

Activate the input.

Implements MAKLogger::DtMessageInput.

virtual void MAKLogger::DtLgrSimInput::activateImplementation ( )

pure virtual

Perform protocol-specific activation.

Implemented in MAKLogger::DtLgrDisSimInput.

virtual DtLgrClock* MAKLogger::DtLgrSimInput::clock ( )

virtual

Get the clock used for time.

virtual const DtLgrClock* MAKLogger::DtLgrSimInput::clock ( ) const

virtual

Get the clock used for time.

virtual void MAKLogger::DtLgrSimInput::connecting ( )

pure virtual

Called when simulation is connecting.

Implemented in MAKLogger::DtLgrDisSimInput.

virtual DtPacket* MAKLogger::DtLgrSimInput::createPacket ( size_t  size, DtPacket::DtPacketType  type  )

protectedvirtual

Creates an empty packet suitable for writing data into. The packet also is added to an internal buffer.

virtual void MAKLogger::DtLgrSimInput::deactivate ( )

virtual

Activate the input.

Implements MAKLogger::DtMessageInput.

virtual void MAKLogger::DtLgrSimInput::deactivateImplementation ( )

pure virtual

Perform protocol-specific activation.

Implemented in MAKLogger::DtLgrDisSimInput.

virtual void MAKLogger::DtLgrSimInput::disconnecting ( )

pure virtual

Called when simulation is disconnecting.

Implemented in MAKLogger::DtLgrDisSimInput.

virtual void MAKLogger::DtLgrSimInput::dropNextMessages ( )

virtual

Called to drop messages from the current read operation.

Implements MAKLogger::DtMessageInput.

virtual DtLgrEntityTracker* MAKLogger::DtLgrSimInput::entityTracker ( )

virtual

virtual void MAKLogger::DtLgrSimInput::filterPacket ( DtPacket *  packet )

protectedvirtual

Filter.

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

virtual

Get the next messages received.

Implements MAKLogger::DtMessageInput.

virtual void MAKLogger::DtLgrSimInput::initializeTracker ( DtLgrBaseSimManager *  manager )

virtual

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

virtual

Get the current input time.

Reimplemented from MAKLogger::DtMessageInput.

virtual bool MAKLogger::DtLgrSimInput::isActivated ( ) const

virtual

Get whether the output is active.

virtual bool MAKLogger::DtLgrSimInput::receivedPackets ( )

virtual

Have you received packets since last call.

virtual void MAKLogger::DtLgrSimInput::receivePacket ( DtPacket *  packet )

protectedvirtual

Called internally to add a packet to a receive buffer.

virtual void MAKLogger::DtLgrSimInput::setClock ( DtLgrClock *  clockToUse )

virtual

Set the clock to use for time.

virtual void MAKLogger::DtLgrSimInput::startReadMessages ( )

virtual

Called at the beginning of a read operation.

Member Data Documentation

bool MAKLogger::DtLgrSimInput::myActivateFlag

protected

DtLgrClock* MAKLogger::DtLgrSimInput::myClock

protected

DtLgrSimManager& MAKLogger::DtLgrSimInput::myManager

protected

DtMessageBuffer* MAKLogger::DtLgrSimInput::myReceiveBuffer

protected

bool MAKLogger::DtLgrSimInput::myReceivePacketsFlag

protected

DtSmartBuffer* MAKLogger::DtLgrSimInput::mySmartBuffer

protected

const int MAKLogger::DtLgrSimInput::theSmartBufferSize = 65536

staticprotected

---

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

• lgrSimInput.h