sequentialQueueAdapter Class Template Reference
[GroupSequentialContainers]

Implements a sequential queue adapter for STL deques. More...

#include <sequentialQueue.h>

Inheritance diagram for sequentialQueueAdapter:

goblinQueue managedObject goblinRootObject

Public Member Functions

 sequentialQueueAdapter (TItem _n, goblinController &thisContext) throw ()
 ~sequentialQueueAdapter () throw ()
unsigned long Size () const throw ()
unsigned long Allocated () const throw ()
char * Display () const throw ()
deque< TItem > & GetDeque ()
void Insert (TItem w, TKey alpha=0) throw (ERRange)
TItem Delete () throw (ERRejected)
TItem Peek () const throw (ERRejected)
bool Empty () const throw ()
TItem Cardinality () const throw ()

Detailed Description

template<class TItem, class TKey = TFloat>
class sequentialQueueAdapter< TItem, TKey >

Implements a sequential queue adapter for STL deques.


Constructor & Destructor Documentation

sequentialQueueAdapter TItem  _n,
goblinController thisContext
throw ()
 

~sequentialQueueAdapter  )  throw ()
 


Member Function Documentation

unsigned long Allocated  )  const throw ()
 

Reimplemented from managedObject.

TItem Cardinality  )  const throw () [virtual]
 

Query the current queue cardinality.

Returns:
The queue cardinality

Implements goblinQueue.

TItem Delete  )  throw (ERRejected) [virtual]
 

Delete an element from the queue.

Returns:
The index of the deleted element

Implements goblinQueue.

char* Display  )  const throw () [virtual]
 

Unconditional display of data objects.

Reimplemented from managedObject.

bool Empty  )  const throw () [virtual]
 

Check if the queue is empty.

Return values:
true The queue is empty

Implements goblinQueue.

deque<TItem>& GetDeque  ) 
 

Extract the embeded STL deque object.

Returns:
A reference of the embeded STL deque object

void Insert TItem  w,
TKey  alpha = 0
throw (ERRange) [virtual]
 

Insert an index into the queue.

Parameters:
w The index to be inserted
alpha The priority of the inserted index

Implements goblinQueue.

TItem Peek  )  const throw (ERRejected) [virtual]
 

Query what is coming next on the queue.

Returns:
The index of the element to be deleted next

Implements goblinQueue.

unsigned long Size  )  const throw () [virtual]
 

Implements goblinQueue.