Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
RefMultiListIterator< ObjectType > Class Template Reference

#include <multilist.h>

Inherits GenericMultiListIterator.

Public Member Functions

 RefMultiListIterator (RefMultiListClass< ObjectType > *list)
 
ObjectType * Get_Obj (void)
 
ObjectType * Peek_Obj (void)
 
void Remove_Current_Object (void)
 
- Public Member Functions inherited from GenericMultiListIterator
 GenericMultiListIterator (GenericMultiListClass *list)
 
void First (GenericMultiListClass *list)
 
void First (void)
 
void Last (GenericMultiListClass *list)
 
void Last (void)
 
void Next (void)
 
void Prev (void)
 
bool Is_Done (void)
 

Additional Inherited Members

- Protected Member Functions inherited from GenericMultiListIterator
MultiListObjectClassCurrent_Object (void)
 
- Protected Attributes inherited from GenericMultiListIterator
GenericMultiListClassList
 
MultiListNodeClassCurNode
 

Detailed Description

template<class ObjectType>
class RefMultiListIterator< ObjectType >

RefMultiListIterator This is a template derived from GenericMultiListIterator which can iterate through RefMultiListClass's. It adds type-checking and reference counting to GenericMultiListIterator.

WARNING: If you need to remove an object from a MultiList while you are iterating, use the Remove_Current_Object function (don't modify the list directly while iterating it). Also note that this function will cause the list to release its reference to the object.

Definition at line 446 of file multilist.h.

Constructor & Destructor Documentation

◆ RefMultiListIterator()

template<class ObjectType>
RefMultiListIterator< ObjectType >::RefMultiListIterator ( RefMultiListClass< ObjectType > * list)
inline

Definition at line 450 of file multilist.h.

Member Function Documentation

◆ Get_Obj()

template<class ObjectType>
ObjectType * RefMultiListIterator< ObjectType >::Get_Obj ( void )
inline

Definition at line 452 of file multilist.h.

◆ Peek_Obj()

template<class ObjectType>
ObjectType * RefMultiListIterator< ObjectType >::Peek_Obj ( void )
inline

Definition at line 461 of file multilist.h.

◆ Remove_Current_Object()

template<class ObjectType>
void RefMultiListIterator< ObjectType >::Remove_Current_Object ( void )
inline

Definition at line 466 of file multilist.h.


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