Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
Public Member Functions | List of all members
MultiListIterator< ObjectType > Class Template Reference

#include <multilist.h>

Inherits GenericMultiListIterator.

Inherited by PriorityMultiListIterator< ObjectType >.

Public Member Functions

 MultiListIterator (MultiListClass< 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
MultiListObjectClass * Current_Object (void)
 
- Protected Attributes inherited from GenericMultiListIterator
GenericMultiListClass * List
 
MultiListNodeClass * CurNode
 

Detailed Description

template<class ObjectType>
class MultiListIterator< ObjectType >

MultiListIterator This is a template derived from GenericMultiListIterator which allows you to iterate through specialized MultiListClass's. Again, it basically just type-casts all of the pointers for you (hopefully compiles away to nothing...)

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

Definition at line 295 of file multilist.h.

Constructor & Destructor Documentation

◆ MultiListIterator()

template<class ObjectType>
MultiListIterator< ObjectType >::MultiListIterator ( MultiListClass< ObjectType > * list)
inline

Definition at line 299 of file multilist.h.

Member Function Documentation

◆ Get_Obj()

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

Definition at line 301 of file multilist.h.

◆ Peek_Obj()

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

Definition at line 306 of file multilist.h.

◆ Remove_Current_Object()

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

Definition at line 311 of file multilist.h.

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