MAK RTIspy API Documentation for HLA 1516
Public Member Functions | Protected Member Functions | Protected Attributes
DtRetractInfoList Class Reference
+ Inheritance diagram for DtRetractInfoList:
+ Collaboration diagram for DtRetractInfoList:

List of all members.

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.

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 Attributes

MAKRti::DtHashlist mySerialIndexList
DtLogicalTimeFactorymyLogicalTimeFactory

Constructor & Destructor Documentation

Copy and assignment operators are disabled.


Member Function Documentation

DtRetractInfoItem * DtRetractInfoList::add ( const DtRtiMsg msg) [virtual]
DtSortedListItem * DtRetractInfoList::add ( void *  data) [protected, virtual]

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().

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().

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) [protected, virtual]

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) [protected, virtual]

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) [protected, virtual]

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

Referenced by add().

MAKRti::DtHashlist DtRetractInfoList::mySerialIndexList [protected]

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

Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)