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

#include <multilist.h>

Inherits GenericMultiListClass.

Public Member Functions

 MultiListClass (void)
 
virtual ~MultiListClass (void)
 
bool Add (ObjectType *obj, bool onlyonce=true)
 
bool Add_Tail (ObjectType *obj, bool onlyonce=true)
 
bool Add_After (ObjectType *obj, const ObjectType *existing_list_member, bool onlyonce=true)
 
bool Remove (ObjectType *obj)
 
ObjectType * Get_Head ()
 
ObjectType * Peek_Head ()
 
ObjectType * Remove_Head ()
 
void Reset_List ()
 
- Public Member Functions inherited from GenericMultiListClass
 GenericMultiListClass (void)
 
virtual ~GenericMultiListClass (void)
 
bool Is_In_List (MultiListObjectClass *obj)
 
bool Contains (MultiListObjectClass *obj)
 
bool Is_Empty (void)
 
int Count (void)
 

Additional Inherited Members

- Protected Member Functions inherited from GenericMultiListClass
bool Internal_Add (MultiListObjectClass *obj, bool onlyonce=true)
 
bool Internal_Add_Tail (MultiListObjectClass *obj, bool onlyonce=true)
 
bool Internal_Add_After (MultiListObjectClass *obj, const MultiListObjectClass *existing_list_member, bool onlyonce=true)
 
bool Internal_Remove (MultiListObjectClass *obj)
 
MultiListObjectClassInternal_Get_List_Head (void)
 
MultiListObjectClassInternal_Remove_List_Head (void)
 

Detailed Description

template<class ObjectType>
class MultiListClass< ObjectType >

MultiListClass This is a template derived from GenericMultiListClass which allows you to create specialized lists. All this template does is perform type-checking and internal type-casting of all pointers to your object type. Your object must be derived from MultiListObjectClass in order to be used with this template.

Definition at line 221 of file multilist.h.

Constructor & Destructor Documentation

◆ MultiListClass()

template<class ObjectType>
MultiListClass< ObjectType >::MultiListClass ( void )
inline

Definition at line 225 of file multilist.h.

◆ ~MultiListClass()

template<class ObjectType>
virtual MultiListClass< ObjectType >::~MultiListClass ( void )
inlinevirtual

Definition at line 227 of file multilist.h.

Member Function Documentation

◆ Add()

template<class ObjectType>
bool MultiListClass< ObjectType >::Add ( ObjectType * obj,
bool onlyonce = true )
inline

Definition at line 234 of file multilist.h.

◆ Add_After()

template<class ObjectType>
bool MultiListClass< ObjectType >::Add_After ( ObjectType * obj,
const ObjectType * existing_list_member,
bool onlyonce = true )
inline

Definition at line 244 of file multilist.h.

◆ Add_Tail()

template<class ObjectType>
bool MultiListClass< ObjectType >::Add_Tail ( ObjectType * obj,
bool onlyonce = true )
inline

Definition at line 239 of file multilist.h.

◆ Get_Head()

template<class ObjectType>
ObjectType * MultiListClass< ObjectType >::Get_Head ( )
inline

Definition at line 254 of file multilist.h.

◆ Peek_Head()

template<class ObjectType>
ObjectType * MultiListClass< ObjectType >::Peek_Head ( )
inline

Definition at line 259 of file multilist.h.

◆ Remove()

template<class ObjectType>
bool MultiListClass< ObjectType >::Remove ( ObjectType * obj)
inline

Definition at line 249 of file multilist.h.

◆ Remove_Head()

template<class ObjectType>
ObjectType * MultiListClass< ObjectType >::Remove_Head ( )
inline

Definition at line 264 of file multilist.h.

◆ Reset_List()

template<class ObjectType>
void MultiListClass< ObjectType >::Reset_List ( )
inline

Definition at line 269 of file multilist.h.


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