Sorted list for queueing messages in time stamped order. More...

Inheritance diagram for DtRtiMsgQueue:

Collaboration diagram for DtRtiMsgQueue:

Public Member Functions
	DtRtiMsgQueue (DtLogicalTimeFactory fedTimeFactory, DtObjectMgr objMgr=0, DtInteractionMgr *intMgr=0)

virtual	~DtRtiMsgQueue ()

virtual bool	timeRegulating ()
	Set/Get status of time regulation/constraint. More...

virtual void	setTimeRegulating (bool isTimeRegulating)

virtual bool	timeConstrained ()

virtual void	setTimeConstrained (bool isTimeConstrained)

virtual bool	asynchronous ()

virtual void	setAsynchronous (bool isAsynchronous)

virtual bool	timeAvailable ()

virtual void	setTimeAvailable (bool isTimeAvailable)

virtual bool	timeAdvancing ()

virtual void	setTimeAdvancing (bool isTimeAdvancing)

virtual const DtRtiApiTime &	timestamp ()
	Set/Get current federate time. More...

virtual void	setTimestamp (const DtRtiApiTime &federateTime)

virtual const DtRtiApiTimeInterval &	lookahead ()
	Set/Get current federate lookahead. More...

virtual void	setLookahead (const DtRtiApiTimeInterval &lookaheadValue)

virtual const DtRtiApiTime &	galt ()
	Set/Get greatest allowed logical time When in the time advancing state messages with timestamps less than this value (and greater than logical time) are passed through without being queued. More...

virtual void	setGalt (const DtRtiApiTime &federateTime)

virtual bool	queueMsg (DtRtiMsg const &msg)
	A clone of the message is added to queue if the queue is time constrained, message is timestamp order, and message timestamp is greater than queue timestamp. More...

virtual void	restoreMsg (DtRtiMsg const &msg)
	For restore. More...

virtual DtRtiMsg *	removeMsg (const DtMessageRetractionHandle &retractHandle)
	Return and remove the message with the supplied retraction handle. More...

virtual bool	deleteMsg (const DtMessageRetractionHandle &retractHandle)
	Remove and delete the message with the supplied retraction handle Return boolean: message was in queue and deleted? More...

virtual void	deleteMsgs (DtFederateHandle federateHandle)
	Remove and delete the messages with the supplied federate handle. More...

virtual void	deleteAll ()
	Remove and delete all the messages. More...

virtual DtRtiMsg *	nextMsg (const DtRtiApiTime &timestamp)
	Return and remove the next message with a lower timestamp. More...

virtual DtRtiMsg *	nextTsoMsg (const DtRtiApiTime &timestamp)
	Return and remove the next TSO message with a lower timestamp. More...

virtual DtRtiMsg *	removeNextTsoMsg ()
	Remove the next TSO message. More...

virtual DtRtiMsg *	peekNextTsoMsg ()
	Return but do not remove the next TSO message. More...

unsigned int	roQueueLength () const
	Return the RO queue length. More...

virtual void	clean ()
	Set the dirty status to clean (i.e., current messages have been checked) More...

virtual bool	isDirty () const
	Return dirty status - message has been inserted since last clean. More...

Public Member Functions inherited from DtSortedList
	DtSortedList (DtSortOrder sortOrderVal=DtSortOrderAscending)
	Constructor. More...

virtual	~DtSortedList ()
	Destructor - does NOT free memory of data associated with the items. More...

	DtSortedList (const DtSortedList &orig)
	Copy constructor. More...

DtSortedList &	operator= (const DtSortedList &orig)
	Assignment operator. More...

virtual void	setSortOrder (DtSortOrder sortOrderValue)
	Set/Get sort order. More...

virtual DtSortOrder	sortOrder () const

virtual DtSortedListItem *	first () const
	Return first and last item on the list. More...

virtual DtSortedListItem *	last () const

unsigned	count () const
	Returns the number of elements in the list. More...

virtual bool	compareItems (const DtSortedListItem &firstItem, const DtSortedListItem &secondItem) const
	Compare the two items based on sort order and return true if first comes first in order to second. More...

virtual void *	remove (DtSortedListItem *item)
	Remove an element from the list. More...

virtual void	removeAll ()
	Calls remove for all elements in the list. More...

virtual DtSortedListItem *	itemLookup (void *data) const
	Returns the DtSortedListItem envelope object containing the indicated data element. More...

virtual void	reverseSortOrder ()
	Reverses sort order of list. More...

virtual void	printData (DtSortOrder order=DtSortOrderAscending)
	Print the list. More...

Protected Member Functions
virtual DtSortedListItem *	newItem (void *data)
	Create a new DtMessageItem envelope for the data to be inserted into the list. More...

	DtRtiMsgQueue (const DtRtiMsgQueue &orig)

DtRtiMsgQueue &	operator= (DtRtiMsgQueue const &orig)

virtual DtSortedListItem *	add (void *data)
	Only internal methods should use this non typed add. More...

virtual int	evaluateSubscription (DtRtiMsg const &msg)
	Evaluate message for subscription Returns -1 if not an interaction/update/delete, 0 if no delivery expected, 1 if delivery expected. More...

Protected Member Functions inherited from DtSortedList
virtual void	addToList (DtSortedListItem item, DtSortedListItem before)
	Add first item to the list before second. More...

virtual void	removeFromList (DtSortedListItem *item)
	Remove item from the list. Does NOT delete the data contained in item. More...

virtual void	reposition (DtSortedListItem *item)
	An item's data for sorting has changed. Reposition it within the list. More...

virtual void	repositionForward (DtSortedListItem item, DtSortedListItem positionItem)
	An item's data for sorting has changed. More...

virtual void	repositionBackward (DtSortedListItem item, DtSortedListItem positionItem)
	An item's data for sorting has changed. More...

virtual void	insertBefore (DtSortedListItem item, DtSortedListItem positionItem)
	Insert the first item before the second. More...

virtual void	insertAfter (DtSortedListItem item, DtSortedListItem positionItem)
	Insert the first item after the second. More...

Protected Attributes
MAKRti::DtList	myRoList

bool	myTimeConstrainedEnabled

bool	myTimeRegulatingEnabled

bool	myAsynchronous

bool	myTimeAvailable

bool	myTimeAdvancing

bool	myIsDirty

DtLogicalTimeFactory *	myLogicalTimeFactory

DtObjectMgr *	myObjMgr

DtInteractionMgr *	myIntMgr

DtRtiApiUniquePtr< DtRtiApiTime >	myTime

DtRtiApiUniquePtr < DtRtiApiTimeInterval >	myLookahead

DtRtiApiUniquePtr< DtRtiApiTime >	myGalt

Protected Attributes inherited from DtSortedList
DtSortedListItem *	myFirst

DtSortedListItem *	myLast

unsigned	myCount

DtSortOrder	mySortOrder

Detailed Description

Sorted list for queueing messages in time stamped order.

Constructor & Destructor Documentation

DtRtiMsgQueue::DtRtiMsgQueue	(	DtLogicalTimeFactory *	fedTimeFactory,
		DtObjectMgr *	objMgr = `0`,
		DtInteractionMgr *	intMgr = `0`
	)

virtual DtRtiMsgQueue::~DtRtiMsgQueue ( )

virtual

DtRtiMsgQueue::DtRtiMsgQueue ( const DtRtiMsgQueue & orig )

protected

Member Function Documentation

virtual DtSortedListItem* DtRtiMsgQueue::add ( void * data )

protectedvirtual

Only internal methods should use this non typed add.

Reimplemented from DtSortedList.

bool DtRtiMsgQueue::asynchronous ( )

inlinevirtual

References myAsynchronous.

virtual void DtRtiMsgQueue::clean ( )

virtual

Set the dirty status to clean (i.e., current messages have been checked)

virtual void DtRtiMsgQueue::deleteAll ( )

virtual

Remove and delete all the messages.

virtual bool DtRtiMsgQueue::deleteMsg ( const DtMessageRetractionHandle & retractHandle )

virtual

Remove and delete the message with the supplied retraction handle Return boolean: message was in queue and deleted?

virtual void DtRtiMsgQueue::deleteMsgs ( DtFederateHandle federateHandle )

virtual

Remove and delete the messages with the supplied federate handle.

virtual int DtRtiMsgQueue::evaluateSubscription ( DtRtiMsg const & msg )

protectedvirtual

Evaluate message for subscription Returns -1 if not an interaction/update/delete, 0 if no delivery expected, 1 if delivery expected.

const DtRtiApiTime & DtRtiMsgQueue::galt ( )

inlinevirtual

Set/Get greatest allowed logical time When in the time advancing state messages with timestamps less than this value (and greater than logical time) are passed through without being queued.

Time available includes equal values.

References myGalt.

virtual bool DtRtiMsgQueue::isDirty ( ) const

virtual

Return dirty status - message has been inserted since last clean.

const DtRtiApiTimeInterval & DtRtiMsgQueue::lookahead ( )

inlinevirtual

Set/Get current federate lookahead.

References myLookahead.

virtual DtSortedListItem* DtRtiMsgQueue::newItem ( void * data )

protectedvirtual

Create a new DtMessageItem envelope for the data to be inserted into the list.

Reimplemented from DtSortedList.

virtual DtRtiMsg* DtRtiMsgQueue::nextMsg ( const DtRtiApiTime & timestamp )

virtual

Return and remove the next message with a lower timestamp.

virtual DtRtiMsg* DtRtiMsgQueue::nextTsoMsg ( const DtRtiApiTime & timestamp )

virtual

Return and remove the next TSO message with a lower timestamp.

DtRtiMsgQueue& DtRtiMsgQueue::operator= ( DtRtiMsgQueue const & orig )

protected

virtual DtRtiMsg* DtRtiMsgQueue::peekNextTsoMsg ( )

virtual

Return but do not remove the next TSO message.

virtual bool DtRtiMsgQueue::queueMsg ( DtRtiMsg const & msg )

virtual

A clone of the message is added to queue if the queue is time constrained, message is timestamp order, and message timestamp is greater than queue timestamp.

Return boolean: message was added to queue?

virtual DtRtiMsg* DtRtiMsgQueue::removeMsg ( const DtMessageRetractionHandle & retractHandle )

virtual

Return and remove the message with the supplied retraction handle.

virtual DtRtiMsg* DtRtiMsgQueue::removeNextTsoMsg ( )

virtual

Remove the next TSO message.

virtual void DtRtiMsgQueue::restoreMsg ( DtRtiMsg const & msg )

virtual

For restore.

unsigned int DtRtiMsgQueue::roQueueLength ( ) const

inline