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

Template class implementing a queue, derived from MxList. More...

#include <mxqueue.h>

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

Public Member Functions

void Enqueue (T &p_obj)
 Adds an object to the end of the queue. More...
 
MxBool Dequeue (T &p_obj)
 Removes the object from the front of the queue and copies it to p_obj. 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...
 

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 MxQueue< T >

Template class implementing a queue, derived from MxList.

[AI]

Provides typical queue operations (enqueue and dequeue) using the list infrastructure for storage. [AI]

Template Parameters
TType of object to be stored in the queue. [AI]

Definition at line 11 of file mxqueue.h.

Member Function Documentation

◆ Dequeue()

template<class T >
MxBool MxQueue< T >::Dequeue ( T &  p_obj)
inline

Removes the object from the front of the queue and copies it to p_obj.

[AI]

Parameters
p_objReference to object where the dequeued value will be copied. [AI]
Returns
TRUE if an object was dequeued, FALSE if the queue was empty. [AI]

Definition at line 23 of file mxqueue.h.

◆ Enqueue()

template<class T >
void MxQueue< T >::Enqueue ( T &  p_obj)
inline

Adds an object to the end of the queue.

[AI]

Parameters
p_objReference to the object to be enqueued. [AI]

Definition at line 15 of file mxqueue.h.


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