The Abstract message state maintained by the logger. More...

Inheritance diagram for MAKLogger::DtMessageState:

Collaboration diagram for MAKLogger::DtMessageState:

Classes
struct	NetCheckpointHeader
struct	NetInitialStateHeader

Public Types
enum	CheckpointProcessing { IgnoreCheckpoints, ProcessAllCheckpoints, ProcessFirstCheckpoint }
enum	InteractionProcessing { IgnoreInteractions, IncludeInteractions, DrainInteractions }
typedef std::list< DtPacket * >	DtPacketList
	Type for the queue of interactions.

Public Member Functions
virtual	~DtMessageState ()
	DTOR Will destroy all state objects.
virtual const DtLgrSimManager *	simMgr () const
	Return the sim manager.
virtual void	startDiff ()
	Start difference mode, creates snapshot of existing state to be used with.
virtual void	generateDiff (DtMessageBuffer &stateBuffer, const DtAbsoluteTime &time, bool addUpdates, InteractionProcessing processInteractions)
	Next update will generate only diff messages which are necessary to go from the backed up state to the current state.
virtual void	endDiff ()
	Destroys the snapshot.
virtual bool	isDiffInProgress () const
	Indicates if a diff is in progress.
virtual void	updateState (DtMessageBuffer &stateBuffer)
	Update existing objects and add new objects.
virtual void	updateState (DtPacket *packet)
	Update existing objects and add new objects.
virtual void	postUpdate ()
	Call post update after finished.
virtual void	setState (DtMessageBuffer &completeStateBuffer, const DtAbsoluteTime &time, DtMessageBuffer *diffBuffer=0)
	Set the state with the internal messages.
virtual void	addState (DtMessageBuffer &stateBuffer, const DtAbsoluteTime &time)
	Add objects from buffer to the state.
virtual void	clearState (DtMessageBuffer &emptyBuffer, const DtAbsoluteTime &time)
	Clear the state and returns the messages necessary to send to clear the state.
virtual void	getState (DtMessageBuffer &emptyBuffer, const DtAbsoluteTime *time, bool modifyMessages=true)
	Return a message buffer with state messages of all cached objects and interactions.
virtual void	getStateObjects (DtMessageBuffer &buffer, const DtAbsoluteTime *time, bool modifyMessages=true)
	Create update packets at the given time for each object in the state and add them to the buffer.
virtual void	getStateInteractions (DtMessageBuffer &buffer, const DtAbsoluteTime *time, bool modifyMessages=true)
	Get any cached interactions into the given buffer.
virtual void	activate ()
	Activate the Message state.
virtual void	deactivate ()
	Deactivate the message state.
virtual const std::list < DtStateObject * > &	stateObjectList () const
	Gets a list of state objects.
virtual void	clearState ()
	Clear the state without creating the removals.
virtual CheckpointProcessing	processCheckpoints ()
	Check to see if checkpoints affect the state.
virtual void	setProcessCheckpoints (CheckpointProcessing value)
	Set whether checkpoints affect the state.
virtual void	setInteractionsCollectedForCheckpoints (bool enable)
	Set whether to collect interactions used for checkpoints.
virtual bool	interactionsCollectedForCheckpoints () const
	Get whether to collect interactions used for checkpoints.
virtual void	setInteractionsCollectedFromCheckpoints (bool enable)
	Set whether to collect interactions from checkpoints)
virtual bool	interactionsCollectedFromCheckpoints () const
	Get whether to collect interactions from checkpoints.
virtual void	modifyMessages (DtMessageBuffer &messages) const
	Calls modifyMessage for each packet in the buffer.
virtual void	modifyMessage (DtPacket &packet) const =0
	Modify a packet.
virtual bool	isInitialStateMessage (const DtPacket &packet) const
	Check to see if the State considers this packet an initial state.
virtual bool	isCheckpointMessage (const DtPacket &packet) const
	Check to see if the State considers this packet a checkpoint.
virtual bool	isUpdateMessage (const DtPacket &packet) const =0
	Check to see if the state thinks this is an object update.
virtual bool	isRemovalMessage (const DtPacket &packet) const =0
	Check to see if the state thinks this is an object removal.
virtual bool	isInteractionMessage (const DtPacket &packet) const =0
	Check to see if the state thinks this is an interaction.
virtual void	createUpdate (const DtStateObject &object, const DtAbsoluteTime *time, DtPacketList &packetlist) const =0
	Create update packet(s) for the object at the given time if provided.
virtual DtPacket *	createRemoval (const DtStateObject &object, const DtAbsoluteTime &time) const =0
	Create an removal packet for the object at the given time.

virtual DtStateObject *	findObject (DtU64 uniqueId)
	Find an object.
virtual const DtStateObject *	findObject (DtU64 uniqueId) const
	Find an object.

virtual DtStateObject *	findObjectByName (const DtString &name)
	Find an object with the given name.
virtual const DtStateObject *	findObjectByName (const DtString &name) const
	Find an object with the given name.

virtual void	setLinkCheckpoints (bool enableLinking)
	Set/Get link checkpoint flag.
virtual bool	linkCheckpointsEnabled () const
	Set/Get link checkpoint flag.
Abstract message state interface.
virtual void	setInputInfo (const DtMessageIOInfo *info)
	Sets the Input Io Info.
virtual void	setOutputInfo (const DtMessageIOInfo *info)
	Sets the Input Io Info.
virtual void	decodeInitialState (const DtPacket &packet, DtMessageBuffer &buffer)=0
	Decode an initial state packet into a message buffer.
virtual void	decodeCheckpoint (const DtPacket &packet, DtMessageBuffer &buffer, bool includeInteractions)=0
	Decode a checkpoint packet into a message buffer.
virtual void	decodeLinkedCheckpoint (const DtPacket &packet, DtMessageBuffer &buffer, bool includeInteractions)=0
	Decode a linked checkpoint packet into a message buffer.
virtual DtPacket *	generateInitialState (const DtAbsoluteTime &timestamp, const DtAbsoluteTime &currentTime, bool isTransition)
	Generates an initial state packet containing the current state.
virtual DtPacket *	generateCheckpoint (const DtAbsoluteTime &timestamp, bool includeInteractions)
	Generates a checkpoint packet containing the current state including received interactions if specified.

virtual DtObserveEvent < DtMessageState > *	inputChangedEvent ()
	Event accessors.
virtual DtObserveEvent < DtMessageState > *	outputChangedEvent ()
	Event accessors.
virtual DtObserveEvent < DtMessageState > *	stateModifiedEvent ()
	Event accessors.
virtual DtObserveEvent < DtMessageState > *	stateActivatedEvent ()
	Event accessors.
virtual DtObserveEvent < DtMessageState > *	stateDeactivatedEvent ()
	Event accessors.
virtual DtObserveEvent < DtMessageState > *	endDiffEvent ()
	Event accessors.
virtual DtObserveEvent < DtStateObject > *	objectAddedEvent ()
	Event accessors.
virtual DtObserveEvent < DtStateObject > *	objectToBeRemovedEvent ()
	Event accessors.
virtual DtObserveEvent < DtStateObject > *	objectUpdatedEvent ()
	Event accessors.

Protected Types
typedef std::list < DtStateObject * >	DtStateObjectList
	Type for the list of objects.
typedef std::map< DtU64, DtStateObject * >	DtStateObjectMap
	Type for lookup objects by unique id.
typedef std::map< DtString, DtStateObject * >	DtStateObjectNameMap
	Type for lookup objects by name.

Protected Member Functions
	DtMessageState (const DtLgrSimManager *simMgr=0)
	Protected CTOR since class is abstract.
	DtMessageState (const DtMessageState &)
	CopyCTOR not implemented.
DtMessageState &	operator= (const DtMessageState &)
	Assignment operator not implemented.
virtual void	activateState ()=0
	Activate the protocol specific state.
virtual void	deactivateState ()=0
	Deactivate the protocol specific state.
virtual DtPacket *	createInitialStatePacket (const DtMessageBuffer &initialStateBuffer, const DtAbsoluteTime &timestamp, double offsetTime)=0
	Return an initial state packet with the given timestamp filled with the state data from the given buffer A negative offset indicates the state data is transitional and when decoding state packet times from the past should not be adjusted.
virtual DtPacket *	createCheckpointPacket (const DtMessageBuffer &checkpointBuffer, const DtAbsoluteTime &timestamp)=0
	Return a checkpoint packet filled with the state data from the given buffer.
virtual bool	updateStateObjects (const DtPacket &packet)
	Used to update state objects using the packet.
virtual DtStateObject *	createStateObject (const DtPacket &packet)
	Create the state object based upon the packet.
virtual DtStateObject *	updateStateObject (const DtPacket &packet)
	Update the state object based upon the packet.
virtual DtStateObject *	findStateObject (const DtPacket &packet)
	Find a state object for a packet.
virtual void	removeStateObject (const DtStateObject *object)
	Remove the state object.
virtual void	createUpdate (const DtStateObject &object, const DtAbsoluteTime *time, DtMessageBuffer &buffer) const
	Create update packet(s) for the object at the given time if provided and add them to buffer.
virtual bool	removeStateObject (const DtPacket &packet)
	Remove the state object based upon the packet.
virtual void	clearObjectList (DtStateObjectList &objectList, DtMessageBuffer *emptyStateBuffer, DtAbsoluteTime time)
	Clear the object list.
virtual void	clearObjectList (DtStateObjectList &objectList)
	Clear the object list.
virtual void	clearInteractionList (DtPacketList &interactionList)
	Clear the interaction list.

Protected Attributes
DtStateObjectList	myObjects
	List of state objects.
DtPacketList	myInteractions
	List of interactions received since last flush.
DtStateObjectMap	myObjectLookupMap
	Map to lookup state objects.
DtStateObjectNameMap	myObjectLookupNameMap
	Map to lookup state objects.
DtStateObjectList	mySnapshotOfObjects
	List of objects used when diffing two different states.
const DtLgrSimManager *	mySimMgr
	The simulation manager.
CheckpointProcessing	myCheckpointProcessing
bool	myStateChanged
bool	myCheckpointInteractions
bool	myLinkCheckpoints
bool	myUseDiffTimeForStateObjects
bool	myCollectInteractionsFromCheckpoint
bool	myDiffInProgress

DtObserveEvent< DtMessageState >	myInputChangedEvent
	Events called on certain actions of the messageState.
DtObserveEvent< DtMessageState >	myOutputChangedEvent
	Events called on certain actions of the messageState.
DtObserveEvent< DtMessageState >	myStateModifiedEvent
	Events called on certain actions of the messageState.
DtObserveEvent< DtMessageState >	myStateActivatedEvent
	Events called on certain actions of the messageState.
DtObserveEvent< DtMessageState >	myStateDeactivetedEvent
	Events called on certain actions of the messageState.
DtObserveEvent< DtMessageState >	myEndDiffEvent
	Events called on certain actions of the messageState.
DtObserveEvent< DtStateObject >	myObjectAddedEvent
	Events called on certain actions of the messageState.
DtObserveEvent< DtStateObject >	myObjectToBeRemovedEvent
	Events called on certain actions of the messageState.
DtObserveEvent< DtStateObject >	myObjectUpdatedEvent
	Events called on certain actions of the messageState.

Detailed Description

The Abstract message state maintained by the logger.

The message state takes in messages from the input and maintains a state of all 'statefull objects' in the simulation.

Member Typedef Documentation

typedef std::list<DtPacket*> MAKLogger::DtMessageState::DtPacketList

Type for the queue of interactions.

typedef std::list<DtStateObject*> MAKLogger::DtMessageState::DtStateObjectList

protected

Type for the list of objects.

typedef std::map<DtU64,DtStateObject*> MAKLogger::DtMessageState::DtStateObjectMap

protected

Type for lookup objects by unique id.

typedef std::map<DtString, DtStateObject*> MAKLogger::DtMessageState::DtStateObjectNameMap

protected

Type for lookup objects by name.

Member Enumeration Documentation

enum MAKLogger::DtMessageState::CheckpointProcessing

Enumerator:

IgnoreCheckpoints
ProcessAllCheckpoints
ProcessFirstCheckpoint

enum MAKLogger::DtMessageState::InteractionProcessing

Enumerator:

IgnoreInteractions
IncludeInteractions
DrainInteractions

Constructor & Destructor Documentation

virtual MAKLogger::DtMessageState::~DtMessageState ( )

virtual

DTOR Will destroy all state objects.

MAKLogger::DtMessageState::DtMessageState ( const DtLgrSimManager * simMgr = 0 )

protected

Protected CTOR since class is abstract.

MAKLogger::DtMessageState::DtMessageState ( const DtMessageState & )

protected

CopyCTOR not implemented.

Member Function Documentation

virtual void MAKLogger::DtMessageState::activate ( )

virtual

Activate the Message state.

virtual void MAKLogger::DtMessageState::activateState ( )

protectedpure virtual

Activate the protocol specific state.

Implemented in MAKLogger::DtLgrDisMessageState.

virtual void MAKLogger::DtMessageState::addState	(	DtMessageBuffer &	stateBuffer,
		const DtAbsoluteTime &	time
	)

virtual

Add objects from buffer to the state.

virtual void MAKLogger::DtMessageState::clearInteractionList ( DtPacketList & interactionList )

protectedvirtual

Clear the interaction list.

virtual void MAKLogger::DtMessageState::clearObjectList	(	DtStateObjectList &	objectList,
		DtMessageBuffer *	emptyStateBuffer,
		DtAbsoluteTime	time
	)

protectedvirtual

Clear the object list.

If provided, fill the message buffer with updates of the emptied state using the given time.

virtual void MAKLogger::DtMessageState::clearObjectList ( DtStateObjectList & objectList )

protectedvirtual

Clear the object list.

virtual void MAKLogger::DtMessageState::clearState	(	DtMessageBuffer &	emptyBuffer,
		const DtAbsoluteTime &	time
	)

virtual

Clear the state and returns the messages necessary to send to clear the state.

Note message buffer passed in will be emptied before filled.

Parameters

Output
emptyBuffer	Contains the modified messages to send to clear the state.

virtual void MAKLogger::DtMessageState::clearState ( )

virtual

Clear the state without creating the removals.

virtual DtPacket* MAKLogger::DtMessageState::createCheckpointPacket	(	const DtMessageBuffer &	checkpointBuffer,
		const DtAbsoluteTime &	timestamp
	)

protectedpure virtual

Return a checkpoint packet filled with the state data from the given buffer.

Implemented in MAKLogger::DtLgrDisMessageState.

virtual DtPacket* MAKLogger::DtMessageState::createInitialStatePacket	(	const DtMessageBuffer &	initialStateBuffer,
		const DtAbsoluteTime &	timestamp,
		double	offsetTime
	)

protectedpure virtual

Return an initial state packet with the given timestamp filled with the state data from the given buffer A negative offset indicates the state data is transitional and when decoding state packet times from the past should not be adjusted.

The actual offset value is not used other than informational.

Implemented in MAKLogger::DtLgrDisMessageState.

virtual DtPacket* MAKLogger::DtMessageState::createRemoval	(	const DtStateObject &	object,
		const DtAbsoluteTime &	time
	)		const

pure virtual

Create an removal packet for the object at the given time.

Implemented in MAKLogger::DtLgrDisMessageState.

virtual DtStateObject* MAKLogger::DtMessageState::createStateObject ( const DtPacket & packet )

protectedvirtual

Create the state object based upon the packet.

Return values

Valid	Pointer If object was created.
NULL	If object was not created.

virtual void MAKLogger::DtMessageState::createUpdate	(	const DtStateObject &	object,
		const DtAbsoluteTime *	time,
		DtPacketList &	packetlist
	)		const

pure virtual

Create update packet(s) for the object at the given time if provided.

virtual void MAKLogger::DtMessageState::createUpdate	(	const DtStateObject &	object,
		const DtAbsoluteTime *	time,
		DtMessageBuffer &	buffer
	)		const

protectedvirtual

Create update packet(s) for the object at the given time if provided and add them to buffer.

virtual void MAKLogger::DtMessageState::deactivate ( )

virtual

Deactivate the message state.

virtual void MAKLogger::DtMessageState::deactivateState ( )

protectedpure virtual

Deactivate the protocol specific state.

Implemented in MAKLogger::DtLgrDisMessageState.

virtual void MAKLogger::DtMessageState::decodeCheckpoint	(	const DtPacket &	packet,
		DtMessageBuffer &	buffer,
		bool	includeInteractions
	)

pure virtual

Decode a checkpoint packet into a message buffer.

Implemented in MAKLogger::DtLgrDisMessageState.

virtual void MAKLogger::DtMessageState::decodeInitialState	(	const DtPacket &	packet,
		DtMessageBuffer &	buffer
	)

pure virtual

Decode an initial state packet into a message buffer.

Implemented in MAKLogger::DtLgrDisMessageState.

virtual void MAKLogger::DtMessageState::decodeLinkedCheckpoint	(	const DtPacket &	packet,
		DtMessageBuffer &	buffer,
		bool	includeInteractions
	)

pure virtual

Decode a linked checkpoint packet into a message buffer.

Implemented in MAKLogger::DtLgrDisMessageState.

virtual void MAKLogger::DtMessageState::endDiff ( )

virtual

Destroys the snapshot.

virtual DtObserveEvent<DtMessageState>* MAKLogger::DtMessageState::endDiffEvent ( )

virtual

Event accessors.

virtual DtStateObject* MAKLogger::DtMessageState::findObject ( DtU64 uniqueId )

virtual

Find an object.

Return values

0	If no object with the uniqueId is found.

virtual const DtStateObject* MAKLogger::DtMessageState::findObject ( DtU64 uniqueId ) const

virtual

Find an object.

Return values

0	If no object with the uniqueId is found.

virtual DtStateObject* MAKLogger::DtMessageState::findObjectByName ( const DtString & name )

virtual

Find an object with the given name.

Return values

0	If no object with the name is found.

virtual const DtStateObject* MAKLogger::DtMessageState::findObjectByName ( const DtString & name ) const

virtual

Find an object with the given name.

Return values

0	If no object with the name is found.

virtual DtStateObject* MAKLogger::DtMessageState::findStateObject ( const DtPacket & packet )

protectedvirtual

Find a state object for a packet.

Return values

Valid	Pointer If object was found.
NULL	If object was not updated (due to not being found).

virtual DtPacket* MAKLogger::DtMessageState::generateCheckpoint	(	const DtAbsoluteTime &	timestamp,
		bool	includeInteractions
	)

virtual

Generates a checkpoint packet containing the current state including received interactions if specified.

The generated packet is given the provided timestamp.

virtual void MAKLogger::DtMessageState::generateDiff	(	DtMessageBuffer &	stateBuffer,
		const DtAbsoluteTime &	time,
		bool	addUpdates,
		InteractionProcessing	processInteractions
	)

virtual

Next update will generate only diff messages which are necessary to go from the backed up state to the current state.

virtual DtPacket* MAKLogger::DtMessageState::generateInitialState	(	const DtAbsoluteTime &	timestamp,
		const DtAbsoluteTime &	currentTime,
		bool	isTransition
	)

virtual

Generates an initial state packet containing the current state.

The current time is used to calculate an offset to the packet with the earliest timestamp. The generated packet is given the provided timestamp. Enable isTransition if this state is being generated to transition across an edit.

virtual void MAKLogger::DtMessageState::getState	(	DtMessageBuffer &	emptyBuffer,
		const DtAbsoluteTime *	time,
		bool	modifyMessages = `true`
	)

virtual

Return a message buffer with state messages of all cached objects and interactions.

Parameters

Output
emptyBuffer	Contains the modified messages to send to recreate the state.

virtual void MAKLogger::DtMessageState::getStateInteractions	(	DtMessageBuffer &	buffer,
		const DtAbsoluteTime *	time,
		bool	modifyMessages = `true`
	)

virtual

Get any cached interactions into the given buffer.

Set them with the given time and modify them desired.

virtual void MAKLogger::DtMessageState::getStateObjects	(	DtMessageBuffer &	buffer,
		const DtAbsoluteTime *	time,
		bool	modifyMessages = `true`
	)

virtual

Create update packets at the given time for each object in the state and add them to the buffer.

virtual DtObserveEvent<DtMessageState>* MAKLogger::DtMessageState::inputChangedEvent ( )

virtual

Event accessors.

virtual bool MAKLogger::DtMessageState::interactionsCollectedForCheckpoints ( ) const

virtual

Get whether to collect interactions used for checkpoints.

virtual bool MAKLogger::DtMessageState::interactionsCollectedFromCheckpoints ( ) const

virtual

Get whether to collect interactions from checkpoints.

virtual bool MAKLogger::DtMessageState::isCheckpointMessage ( const DtPacket & packet ) const

virtual

Check to see if the State considers this packet a checkpoint.

Checkpoint messages are decoded to modify all objects.

virtual bool MAKLogger::DtMessageState::isDiffInProgress ( ) const

virtual

Indicates if a diff is in progress.

virtual bool MAKLogger::DtMessageState::isInitialStateMessage ( const DtPacket & packet ) const

virtual

Check to see if the State considers this packet an initial state.

Initial state messages are decoded to modify all objects.

virtual bool MAKLogger::DtMessageState::isInteractionMessage ( const DtPacket & packet ) const

pure virtual

Check to see if the state thinks this is an interaction.

Implemented in MAKLogger::DtLgrDisMessageState.

virtual bool MAKLogger::DtMessageState::isRemovalMessage ( const DtPacket & packet ) const

pure virtual

Check to see if the state thinks this is an object removal.

Implemented in MAKLogger::DtLgrDisMessageState.

virtual bool MAKLogger::DtMessageState::isUpdateMessage ( const DtPacket & packet ) const

pure virtual

Check to see if the state thinks this is an object update.

Implemented in MAKLogger::DtLgrDisMessageState.

virtual bool MAKLogger::DtMessageState::linkCheckpointsEnabled ( ) const

virtual

Set/Get link checkpoint flag.

virtual void MAKLogger::DtMessageState::modifyMessage ( DtPacket & packet ) const

pure virtual

Modify a packet.

This typically does not need to be called since it is internally called by update state.

Parameters

Output

Implemented in MAKLogger::DtLgrDisMessageState.

virtual void MAKLogger::DtMessageState::modifyMessages ( DtMessageBuffer & messages ) const

virtual

Calls modifyMessage for each packet in the buffer.

Modifies the messages. This typically does not need to be called since it is internally called by update state.

Parameters

Output

Reimplemented in MAKLogger::DtLgrDisMessageState.

virtual DtObserveEvent<DtStateObject>* MAKLogger::DtMessageState::objectAddedEvent ( )

virtual

Event accessors.

virtual DtObserveEvent<DtStateObject>* MAKLogger::DtMessageState::objectToBeRemovedEvent ( )

virtual

Event accessors.

virtual DtObserveEvent<DtStateObject>* MAKLogger::DtMessageState::objectUpdatedEvent ( )

virtual

Event accessors.

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

protected

Assignment operator not implemented.

virtual DtObserveEvent<DtMessageState>* MAKLogger::DtMessageState::outputChangedEvent ( )

virtual

Event accessors.

virtual void MAKLogger::DtMessageState::postUpdate ( )

virtual

Call post update after finished.

virtual CheckpointProcessing MAKLogger::DtMessageState::processCheckpoints ( )

virtual

Check to see if checkpoints affect the state.

virtual void MAKLogger::DtMessageState::removeStateObject ( const DtStateObject * object )

protectedvirtual

Remove the state object.

virtual bool MAKLogger::DtMessageState::removeStateObject ( const DtPacket & packet )

protectedvirtual

Remove the state object based upon the packet.

Return values

true	If object was removed.
false	If object was not removed (due to not being found).

virtual void MAKLogger::DtMessageState::setInputInfo ( const DtMessageIOInfo * info )

virtual

Sets the Input Io Info.

virtual void MAKLogger::DtMessageState::setInteractionsCollectedForCheckpoints ( bool enable )

virtual

Set whether to collect interactions used for checkpoints.

virtual void MAKLogger::DtMessageState::setInteractionsCollectedFromCheckpoints ( bool enable )

virtual

Set whether to collect interactions from checkpoints)

virtual void MAKLogger::DtMessageState::setLinkCheckpoints ( bool enableLinking )

virtual

Set/Get link checkpoint flag.

virtual void MAKLogger::DtMessageState::setOutputInfo ( const DtMessageIOInfo * info )

virtual

Sets the Input Io Info.

virtual void MAKLogger::DtMessageState::setProcessCheckpoints ( CheckpointProcessing value )

virtual

Set whether checkpoints affect the state.

virtual void MAKLogger::DtMessageState::setState	(	DtMessageBuffer &	completeStateBuffer,
		const DtAbsoluteTime &	time,
		DtMessageBuffer *	diffBuffer = `0`
	)

virtual

Set the state with the internal messages.

All objects not in the buffer are removed from the state.

Parameters

Input
completeStateBuffer	Contains the messages used to create a specific state.
time	Time used for for diff messages
Output
diffBuffer	If not null, populated with the modified messages that can create the new state from the old. Note: can be same buffer as completeStateBuffer

virtual const DtLgrSimManager* MAKLogger::DtMessageState::simMgr ( ) const

virtual

Return the sim manager.

virtual void MAKLogger::DtMessageState::startDiff ( )

virtual

Start difference mode, creates snapshot of existing state to be used with.

virtual DtObserveEvent<DtMessageState>* MAKLogger::DtMessageState::stateActivatedEvent ( )

virtual

Event accessors.

virtual DtObserveEvent<DtMessageState>* MAKLogger::DtMessageState::stateDeactivatedEvent ( )

virtual

Event accessors.

virtual DtObserveEvent<DtMessageState>* MAKLogger::DtMessageState::stateModifiedEvent ( )

virtual

Event accessors.

virtual const std::list<DtStateObject*>& MAKLogger::DtMessageState::stateObjectList ( ) const

virtual

Gets a list of state objects.

virtual void MAKLogger::DtMessageState::updateState ( DtMessageBuffer & stateBuffer )

virtual

Update existing objects and add new objects.

Calls updateState for each packet in the message buffer.

Parameters

Input
stateBuffer	Contains the messages used to create a specific state.
Output
stateBuffer	Contains the modified messages to send to create the state.

virtual void MAKLogger::DtMessageState::updateState ( DtPacket * packet )

virtual

Update existing objects and add new objects.

Calls udpateStateObjects on message. This function will not send event notifications. Call post update to send this value.

Parameters

Input
packet	A packet to be added to the state.
Output
message	The packet may be modified depending on the state's output.

virtual DtStateObject* MAKLogger::DtMessageState::updateStateObject ( const DtPacket & packet )

protectedvirtual

Update the state object based upon the packet.

Return values

Valid	Pointer If object was updated.
NULL	If object was not updated (due to not being found).

virtual bool MAKLogger::DtMessageState::updateStateObjects ( const DtPacket & packet )

protectedvirtual

Used to update state objects using the packet.

Packet specific functions will be called here depending on the type of message.

Returns: Returns whether the state was modified.

Return values

true	If state was modified.
false	If state was not modified.

Member Data Documentation

bool MAKLogger::DtMessageState::myCheckpointInteractions

protected

CheckpointProcessing MAKLogger::DtMessageState::myCheckpointProcessing

protected

bool MAKLogger::DtMessageState::myCollectInteractionsFromCheckpoint

protected

bool MAKLogger::DtMessageState::myDiffInProgress

protected

DtObserveEvent<DtMessageState> MAKLogger::DtMessageState::myEndDiffEvent

protected

Events called on certain actions of the messageState.

DtObserveEvent<DtMessageState> MAKLogger::DtMessageState::myInputChangedEvent

protected

Events called on certain actions of the messageState.

DtPacketList MAKLogger::DtMessageState::myInteractions

protected

List of interactions received since last flush.

bool MAKLogger::DtMessageState::myLinkCheckpoints

protected

DtObserveEvent<DtStateObject> MAKLogger::DtMessageState::myObjectAddedEvent

protected

Events called on certain actions of the messageState.

DtStateObjectMap MAKLogger::DtMessageState::myObjectLookupMap

protected

Map to lookup state objects.

DtStateObjectNameMap MAKLogger::DtMessageState::myObjectLookupNameMap

protected

Map to lookup state objects.

DtStateObjectList MAKLogger::DtMessageState::myObjects

protected

List of state objects.

DtObserveEvent<DtStateObject> MAKLogger::DtMessageState::myObjectToBeRemovedEvent

protected

Events called on certain actions of the messageState.

DtObserveEvent<DtStateObject> MAKLogger::DtMessageState::myObjectUpdatedEvent

protected

Events called on certain actions of the messageState.

DtObserveEvent<DtMessageState> MAKLogger::DtMessageState::myOutputChangedEvent

protected

Events called on certain actions of the messageState.

const DtLgrSimManager* MAKLogger::DtMessageState::mySimMgr

protected

The simulation manager.

DtStateObjectList MAKLogger::DtMessageState::mySnapshotOfObjects

protected

List of objects used when diffing two different states.

DtObserveEvent<DtMessageState> MAKLogger::DtMessageState::myStateActivatedEvent

protected

Events called on certain actions of the messageState.

bool MAKLogger::DtMessageState::myStateChanged

protected

DtObserveEvent<DtMessageState> MAKLogger::DtMessageState::myStateDeactivetedEvent

protected

Events called on certain actions of the messageState.

DtObserveEvent<DtMessageState> MAKLogger::DtMessageState::myStateModifiedEvent

protected

Events called on certain actions of the messageState.

bool MAKLogger::DtMessageState::myUseDiffTimeForStateObjects

protected

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

messageState.h

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation