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

#include <multilist.h>

Inherits GenericMultiListClass.

Public Member Functions

virtual ~RefMultiListClass (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)
 
bool Release_Head (void)
 
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 RefMultiListClass< ObjectType >

RefMultiListClass This is a template derived from GenericMultiListClass which handles ref-counted objects. It assumes that 'ObjectType' is derived from MultiListObjectClass and RefCountClass. It adds type-checking and reference counting to GenericMultiListClass.

Definition at line 342 of file multilist.h.

Constructor & Destructor Documentation

◆ ~RefMultiListClass()

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

Definition at line 346 of file multilist.h.

Member Function Documentation

◆ Add()

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

Definition at line 353 of file multilist.h.

◆ Add_After()

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

Definition at line 373 of file multilist.h.

◆ Add_Tail()

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

Definition at line 363 of file multilist.h.

◆ Get_Head()

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

Definition at line 405 of file multilist.h.

◆ Peek_Head()

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

Definition at line 415 of file multilist.h.

◆ Release_Head()

template<class ObjectType>
bool RefMultiListClass< ObjectType >::Release_Head ( void )
inline

Definition at line 393 of file multilist.h.

◆ Remove()

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

Definition at line 383 of file multilist.h.

◆ Remove_Head()

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

Definition at line 421 of file multilist.h.

◆ Reset_List()

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

Definition at line 427 of file multilist.h.


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