Isle
Loading...
Searching...
No Matches
MxPtrList< T > Class Template Reference

[AI] More...

#include <mxlist.h>

Inheritance diagram for MxPtrList< T >:
Collaboration diagram for MxPtrList< T >:

Public Member Functions

 MxPtrList (MxBool p_ownership)
 [AI] More...
 
void SetOwnership (MxBool p_ownership)
 [AI] More...
 
- Public Member Functions inherited from MxList< T * >
 MxList ()
 [AI] Constructor. Initializes the list pointers to null (empty list). [AI] More...
 
 ~MxList () override
 [AI] Destructor. Deletes all entries in the list and manages resource ownership. [AI] More...
 
void Append (T * p_obj)
 [AI] More...
 
void Prepend (T * p_obj)
 [AI] More...
 
void DeleteAll ()
 [AI] More...
 
void Empty ()
 [AI] More...
 
MxU32 GetNumElements ()
 [AI] More...
 

Static Public Member Functions

static void Destroy (T *p_obj)
 [AI] More...
 

Additional Inherited Members

- Protected Member Functions inherited from MxList< T * >
void DeleteEntry (MxListEntry< T * > *)
 [AI] More...
 
MxListEntry< T * > * InsertEntry (T *, MxListEntry< T * > *, MxListEntry< T * > *)
 [AI] More...
 
- Protected Member Functions inherited from MxCollection< T >
 MxCollection ()
 [AI] Constructs an empty collection, initializing count and default element destructor. More...
 
virtual MxS8 Compare (T a, T b)
 [AI] Compares two elements of the collection (default implementation returns zero; override in subclasses for meaningful comparison). More...
 
 ~MxCollection () override
 [AI] Virtual destructor for proper polymorphic destruction. More...
 
void SetDestroy (void(*p_customDestructor)(T))
 [AI] Assigns a custom destructor function to be used for elements of this collection. More...
 
- Protected Member Functions inherited from MxCore
 MxCore ()
 [AI] Constructs a new MxCore object and assigns it a unique id. More...
 
virtual ~MxCore ()
 [AI] Virtual destructor. Required for correct polymorphic cleanup in derived classes. More...
 
virtual MxLong Notify (MxParam &p_param)
 [AI] Virtual callback notification mechanism. More...
 
virtual MxResult Tickle ()
 [AI] Called by tickle managers to allow the object to update itself. More...
 
virtual const char * ClassName () const
 [AI] Returns the runtime class name of this object. More...
 
virtual MxBool IsA (const char *p_name) const
 [AI] Checks whether this object's class type or parents match the given name. More...
 
MxU32 GetId ()
 [AI] Gets the unique (per-process) id assigned to this object instance. More...
 
- Static Protected Member Functions inherited from MxCollection< T >
static void Destroy (T obj)
 [AI] Static no-op destroy function; suitable for types that do not need destruction. More...
 
- Protected Attributes inherited from MxList< T * >
MxListEntry< T * > * m_first
 [AI] Pointer to the first entry in the list. [AI] More...
 
MxListEntry< T * > * m_last
 [AI] Pointer to the last entry in the list. [AI] More...
 
- Protected Attributes inherited from MxCollection< T >
MxU32 m_count
 [AI] Number of elements currently stored in the collection. More...
 
void(* m_customDestructor )(T)
 [AI] Function pointer to the custom element destructor used for cleanup of elements. More...
 

Detailed Description

template<class T>
class MxPtrList< T >

[AI]

Pointer-based linked-list, with optional ownership handling for the objects. [AI]

[AI] When ownership is enabled, the destructor deletes owned pointer objects; otherwise it only manages the list entries. [AI]

Definition at line 148 of file mxlist.h.

Constructor & Destructor Documentation

◆ MxPtrList()

template<class T >
MxPtrList< T >::MxPtrList ( MxBool  p_ownership)
inline

[AI]

Constructs a pointer list with ownership semantics. [AI]

Parameters
p_ownershipIf true, list will delete contained pointers on removal. [AI]

Definition at line 153 of file mxlist.h.

Member Function Documentation

◆ Destroy()

template<class T >
static void MxPtrList< T >::Destroy ( T *  p_obj)
inlinestatic

[AI]

Static deletion utility for pointer ownership. [AI]

Parameters
p_objPointer to the object to delete. [AI]

Definition at line 158 of file mxlist.h.

◆ SetOwnership()

template<class T >
void MxPtrList< T >::SetOwnership ( MxBool  p_ownership)
inline

[AI]

Sets the list to own and destroy objects, or not. [AI]

Parameters
p_ownershipIf true, enables object deletion via Destroy; else disables. [AI]

Definition at line 163 of file mxlist.h.


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