MAK RTIspy API Documentation for HLA Evolved
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
DtRetractInfoList Class Reference
+ Inheritance diagram for DtRetractInfoList:
+ Collaboration diagram for DtRetractInfoList:

Public Member Functions

 DtRetractInfoList (DtLogicalTimeFactory *logicalTimeFactory)
virtual ~DtRetractInfoList ()
virtual DtRetractInfoItemadd (DtRetractInfo *info)
 retract entry is added to list.
virtual DtRetractInfoItemadd (const DtRtiMsg &msg)
 Add an entry using data from the supplied message.
virtual void removeAll ()
 Calls remove for all elements in the list.
virtual void deleteAll (RTI::FedTime const &time)
 Delete all entries with a time less then the supplied time.
virtual DtRetractInforemoveByNumber (unsigned long serialNumber)
 Return and remove the entry with the supplied serial number.
virtual void deleteByNumber (unsigned long serialNumber)
 Remove and delete the entry with the supplied serial number.
virtual DtRetractInfolookupByNumber (unsigned long serialNumber)
 Return the entry for the given serial number.
virtual DtRetractInfoItemfirstRetractItem () const
 Return first and last item on the list.
virtual DtRetractInfoItemlastRetractItem () const
virtual DtRetractInfominRetraction (RTI::FedTime const &lower, RTI::FedTime const &upper, bool includeLower) const
 Return the retraction info for the item with the minimum time greater (equal if include is true) than the given lower time and less equal than the upper time; NULL if no such item found.
- Public Member Functions inherited from DtSortedList
 DtSortedList (DtSortOrder sortOrderVal=DtSortOrderAscending)
 Constructor.
virtual ~DtSortedList ()
 Destructor - does NOT free memory of data associated with the items.
 DtSortedList (const DtSortedList &orig)
 Copy constructor.
DtSortedListoperator= (const DtSortedList &orig)
 Assignment operator.
virtual void setSortOrder (DtSortOrder sortOrderValue)
 Set/Get sort order.
virtual DtSortOrder sortOrder () const
virtual DtSortedListItemfirst () const
 Return first and last item on the list.
virtual DtSortedListItemlast () const
unsigned count () const
 Returns the number of elements in the list.
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.
virtual DtSortedListItemitemLookup (void *data) const
 Returns the DtSortedListItem envelope object containing the indicated data element.
virtual void reverseSortOrder ()
 Reverses sort order of list.
virtual void printData (DtSortOrder order=DtSortOrderAscending)
 Print the list.

Protected Member Functions

virtual DtSortedListItemadd (void *data)
 Only allowed internally in this class.
virtual void * remove (DtSortedListItem *item)
 Only allowed internally in this class See public method that requires serial number.
virtual DtSortedListItemnewItem (void *data)
 Create a new DtRetractInfoItem envelope for the data to be inserted into the list.
virtual DtRetractInfoItemlookupItem (unsigned long serialNumber)
 Return the list item for the given serial number.
 DtRetractInfoList (const DtRetractInfoList &orig)
 Copy and assignment operators are disabled.
DtRetractInfoListoperator= (DtRetractInfoList const &orig)
- Protected Member Functions inherited from DtSortedList
virtual void addToList (DtSortedListItem *item, DtSortedListItem *before)
 Add first item to the list before second.
virtual void removeFromList (DtSortedListItem *item)
 Remove item from the list. Does NOT delete the data contained in item.
virtual void reposition (DtSortedListItem *item)
 An item's data for sorting has changed. Reposition it within the list.
virtual void repositionForward (DtSortedListItem *item, DtSortedListItem *positionItem)
 An item's data for sorting has changed.
virtual void repositionBackward (DtSortedListItem *item, DtSortedListItem *positionItem)
 An item's data for sorting has changed.
virtual void insertBefore (DtSortedListItem *item, DtSortedListItem *positionItem)
 Insert the first item before the second.
virtual void insertAfter (DtSortedListItem *item, DtSortedListItem *positionItem)
 Insert the first item after the second.

Protected Attributes

MAKRti::DtHashlist mySerialIndexList
DtLogicalTimeFactorymyLogicalTimeFactory
- Protected Attributes inherited from DtSortedList
DtSortedListItemmyFirst
DtSortedListItemmyLast
unsigned myCount
DtSortOrder mySortOrder

Constructor & Destructor Documentation

DtRetractInfoList::DtRetractInfoList ( DtLogicalTimeFactory logicalTimeFactory)
DtRetractInfoList::~DtRetractInfoList ( )
virtual
DtRetractInfoList::DtRetractInfoList ( const DtRetractInfoList orig)
protected

Copy and assignment operators are disabled.

Member Function Documentation

DtRetractInfoItem * DtRetractInfoList::add ( DtRetractInfo info)
virtual
DtRetractInfoItem * DtRetractInfoList::add ( const DtRtiMsg msg)
virtual
DtSortedListItem * DtRetractInfoList::add ( void *  data)
protectedvirtual

Only allowed internally in this class.

Reimplemented from DtSortedList.

References add().

void DtRetractInfoList::deleteAll ( RTI::FedTime const &  time)
virtual

Delete all entries with a time less then the supplied time.

References DtSortedListItem::data(), DtSortedListItem::next(), NULL, DtRetractInfo::serialNumber(), and DtRetractInfo::time().

void DtRetractInfoList::deleteByNumber ( unsigned long  serialNumber)
virtual

Remove and delete the entry with the supplied serial number.

References removeByNumber().

DtRetractInfoItem * DtRetractInfoList::firstRetractItem ( ) const
inlinevirtual

Return first and last item on the list.

DtRetractInfoItem is an envelope for your retract data. The data can be obtained using DtRetractInfoItem::RetractInfo()

References DtSortedList::first().

DtRetractInfoItem * DtRetractInfoList::lastRetractItem ( ) const
inlinevirtual

References DtSortedList::last().

DtRetractInfo * DtRetractInfoList::lookupByNumber ( unsigned long  serialNumber)
virtual

Return the entry for the given serial number.

References mySerialIndexList, NULL, and DtRetractInfoItem::retractInfo().

DtRetractInfoItem * DtRetractInfoList::lookupItem ( unsigned long  serialNumber)
protectedvirtual

Return the list item for the given serial number.

References mySerialIndexList.

DtRetractInfo * DtRetractInfoList::minRetraction ( RTI::FedTime const &  lower,
RTI::FedTime const &  upper,
bool  includeLower 
) const
virtual

Return the retraction info for the item with the minimum time greater (equal if include is true) than the given lower time and less equal than the upper time; NULL if no such item found.

References NULL, and DtRetractInfo::time().

DtSortedListItem * DtRetractInfoList::newItem ( void *  data)
protectedvirtual

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

Reimplemented from DtSortedList.

DtRetractInfoList & DtRetractInfoList::operator= ( DtRetractInfoList const &  orig)
protected
void * DtRetractInfoList::remove ( DtSortedListItem item)
protectedvirtual

Only allowed internally in this class See public method that requires serial number.

Remove an element from the list. Item is the envelope containing the data element you would like to remove. Note: remove does not free memory of data associated with the item. It only frees the item. The data is returned to the caller for deletion if required.

Reimplemented from DtSortedList.

void DtRetractInfoList::removeAll ( )
virtual

Calls remove for all elements in the list.

It does NOT delete the data in the list. Merely removes the data from the list.

Reimplemented from DtSortedList.

References mySerialIndexList.

DtRetractInfo * DtRetractInfoList::removeByNumber ( unsigned long  serialNumber)
virtual

Return and remove the entry with the supplied serial number.

References mySerialIndexList, and NULL.

Referenced by deleteByNumber().

Member Data Documentation

DtLogicalTimeFactory* DtRetractInfoList::myLogicalTimeFactory
protected

Referenced by add().

MAKRti::DtHashlist DtRetractInfoList::mySerialIndexList
protected

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

Document ID: Generated on Tue May 7 16:26:47 EDT 2013 from SVN revision 126903
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)