zeus::IQueue< T > Class Template Reference

#include <IQueue.hpp>

Inheritance diagram for zeus::IQueue< T >:

List of all members.

Public Member Functions
virtual void MQUALIFIER	appendItem (const T &tData)=0
virtual void MQUALIFIER	copyToQueue (IQueue< T > &rQueue) const =0
virtual void MQUALIFIER	copyToList (IList< T > &rList) const =0
virtual T MQUALIFIER	removeItem ()=0
virtual Int MQUALIFIER	getCount () const =0
virtual void MQUALIFIER	flush ()=0
virtual bool MQUALIFIER	isEmpty () const =0
virtual T &MQUALIFIER	peekItem ()=0
virtual const T &MQUALIFIER	peekItemConst () const =0

---

Detailed Description

template<class T>
class zeus::IQueue< T >

This interface describes a FIFO list (queue).

---

Member Function Documentation

template<class T>

virtual void MQUALIFIER zeus::IQueue< T >::appendItem

(

const T &

tData )

[pure virtual]

adds an object to the queue

Parameters:

tData

: Data object

Implemented in zeus::TAtomicQueue< T >, zeus::TManagedQueue< T >, zeus::TPriorityQueue< TKeyType, TValueType >, zeus::TQueue< T >, zeus::TQueueCB< T >, zeus::TQueue< TAutoPtr< T > >, zeus::TQueue< TItemContainer * >, and zeus::TQueue< TypeToken >.

template<class T>

virtual void MQUALIFIER zeus::IQueue< T >::copyToList

(

IList< T > &

rList )

const [pure virtual]

Copies the content to the rList object

Parameters:

rList

: Target object

Implemented in zeus::TAtomicQueue< T >, zeus::TPriorityQueue< TKeyType, TValueType >, zeus::TQueue< T >, zeus::TQueueCB< T >, zeus::TQueue< TAutoPtr< T > >, zeus::TQueue< TItemContainer * >, and zeus::TQueue< TypeToken >.

template<class T>

virtual void MQUALIFIER zeus::IQueue< T >::copyToQueue

(

IQueue< T > &

rQueue )

const [pure virtual]

Copies the content to the rQueue object

Parameters:

rQueue

: Target object

Implemented in zeus::TAtomicQueue< T >, zeus::TPriorityQueue< TKeyType, TValueType >, zeus::TQueue< T >, zeus::TQueueCB< T >, zeus::TQueue< TAutoPtr< T > >, zeus::TQueue< TItemContainer * >, and zeus::TQueue< TypeToken >.

template<class T>

virtual void MQUALIFIER zeus::IQueue< T >::flush

(

)

[pure virtual]

flushes the queue. All items will be removed

Implemented in zeus::TAtomicQueue< T >, zeus::TPriorityQueue< TKeyType, TValueType >, zeus::TQueue< T >, zeus::TQueueCB< T >, zeus::TQueue< TAutoPtr< T > >, zeus::TQueue< TItemContainer * >, and zeus::TQueue< TypeToken >.

template<class T>

virtual Int MQUALIFIER zeus::IQueue< T >::getCount

(

)

const [pure virtual]

Returns the number of items inside the queue

Returns:

Size of Queue

Implemented in zeus::TAtomicQueue< T >, zeus::TPriorityQueue< TKeyType, TValueType >, zeus::TQueue< T >, zeus::TQueueCB< T >, zeus::TQueue< TAutoPtr< T > >, zeus::TQueue< TItemContainer * >, and zeus::TQueue< TypeToken >.

template<class T>

virtual bool MQUALIFIER zeus::IQueue< T >::isEmpty

(

)

const [pure virtual]

Checks if the queue is empty

Return values:

true	: queue is empty
false	: queue is not empty

Implemented in zeus::TAtomicQueue< T >, zeus::TPriorityQueue< TKeyType, TValueType >, zeus::TQueue< T >, zeus::TQueueCB< T >, zeus::TQueue< TAutoPtr< T > >, zeus::TQueue< TItemContainer * >, and zeus::TQueue< TypeToken >.

template<class T>

virtual T& MQUALIFIER zeus::IQueue< T >::peekItem

(

)

[pure virtual]

returns the front element of the queue without removing it

Returns:

front element

Implemented in zeus::TAtomicQueue< T >, zeus::TPriorityQueue< TKeyType, TValueType >, zeus::TQueue< T >, zeus::TQueueCB< T >, zeus::TQueue< TAutoPtr< T > >, zeus::TQueue< TItemContainer * >, and zeus::TQueue< TypeToken >.

template<class T>

virtual const T& MQUALIFIER zeus::IQueue< T >::peekItemConst

(

)

const [pure virtual]

returns the front element of the queue without removing it

Returns:

front element

Implemented in zeus::TAtomicQueue< T >, zeus::TPriorityQueue< TKeyType, TValueType >, zeus::TQueue< T >, zeus::TQueueCB< T >, zeus::TQueue< TAutoPtr< T > >, zeus::TQueue< TItemContainer * >, and zeus::TQueue< TypeToken >.

template<class T>

virtual T MQUALIFIER zeus::IQueue< T >::removeItem

(

)

[pure virtual]

returns the front element of the queue and removes it

Returns:

front element

Implemented in zeus::TAtomicQueue< T >, zeus::TPriorityQueue< TKeyType, TValueType >, zeus::TQueue< T >, zeus::TQueueCB< T >, zeus::TQueue< TAutoPtr< T > >, zeus::TQueue< TItemContainer * >, and zeus::TQueue< TypeToken >.

---

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

• IQueue.hpp