MAPUtil::Queue< T > Class Template Reference

#include <MAP/Queue.h>

List of all members.

---

Detailed Description

template<class T>
class MAPUtil::Queue< T >

Template class for a queue with a limited fixed capacity.

Public Member Functions
	Queue (const int capacity)
virtual	~Queue ()
T *	peekAt (int location)
int	getCapacity () const
int	getCount () const
void	clear ()
bool	contains (const T *item) const
int	find (const T *item) const
T *	dequeue ()
void	enqueue (T *item)
const T *	peek () const

---

Constructor & Destructor Documentation

template<class T> MAPUtil::Queue< T >::Queue (  const int  capacity  )  [inline]

Creates a queue with fixed capacity. Queue keeps heap-allocated objects of type T. Client must create objects. Queue assumes ownership of objects as long as objects are in queue. Dequeueing an object means ownership is transferred to client.

template<class T> virtual MAPUtil::Queue< T >::~Queue (   )  [inline, virtual]

Destroys a queue

---

Member Function Documentation

template<class T> T* MAPUtil::Queue< T >::peekAt (  int  location  )  [inline]

Returns item at location in queue. Returns null if item is unused.

template<class T> int MAPUtil::Queue< T >::getCapacity (   )  const [inline]

Returns item capacity of queue.

template<class T> int MAPUtil::Queue< T >::getCount (   )  const [inline]

Returns count of queued items.

template<class T> void MAPUtil::Queue< T >::clear (   )  [inline]

Removes all items in queue.

template<class T> bool MAPUtil::Queue< T >::contains (  const T *  item  )  const [inline]

returns true if queue contains item.

template<class T> int MAPUtil::Queue< T >::find (  const T *  item  )  const [inline]

Returns position in array of item. If not found, returns -1.

template<class T> T* MAPUtil::Queue< T >::dequeue (   )  [inline]

Returns ref to next T in queue. Caller assumes ownership of item, and is responsible for deleting item. Returns InvalidPtr if queue is empty.

template<class T> void MAPUtil::Queue< T >::enqueue (  T *  item  )  [inline]

Enters T into queue. Queue takes ownership of item.

template<class T> const T* MAPUtil::Queue< T >::peek (   )  const [inline]

Returns next item in queue, without removing it from queue.

---