PriorityQueueIterator< TYPE > Class Template Reference
[Containers]

Iterator for PriorityQueue. More...

List of all members.

Public Member Functions
	PriorityQueueIterator (const PriorityQueue< TYPE > &priorityQueue)
void	MoveFirst ()
void	MoveNext ()
void	MovePrevious ()
void	MoveLast ()
TYPE &	GetCurrent () const
bool	IsValid () const
bool	Find (const TYPE &data)
int	GetCurrentIndex () const

---

Detailed Description

template<class TYPE>
class PriorityQueueIterator< TYPE >

Iterator for PriorityQueue.

Author:

Mattias Gustavsson

Definition at line 20 of file PriorityQueueIterator.h.

---

Constructor & Destructor Documentation

template<class TYPE >

PriorityQueueIterator< TYPE >::PriorityQueueIterator

(

const PriorityQueue< TYPE > &

priorityQueue

)

Constructor

Definition at line 9 of file PriorityQueueIterator.inl.

---

Member Function Documentation

template<class TYPE >

void PriorityQueueIterator< TYPE >::MoveFirst

(

)

Returns the first item in the queue, and resets the iterator to return the second item next time GetNext is called

Returns:

The first item in the queue

Definition at line 20 of file PriorityQueueIterator.inl.

template<class TYPE >

void PriorityQueueIterator< TYPE >::MoveNext

(

)

Returns the next item in the queue, and advances the iterator

Returns:

The next item in the queue

Definition at line 29 of file PriorityQueueIterator.inl.

template<class TYPE >

void PriorityQueueIterator< TYPE >::MovePrevious

(

)

Returns the previous item in the queue, and moves the iterator back

Returns:

The previous item in the queue

Definition at line 50 of file PriorityQueueIterator.inl.

template<class TYPE >

void PriorityQueueIterator< TYPE >::MoveLast

(

)

Returns the last item in the queue, and resets the iterator to return the second last item next time GetPrevious is called

Returns:

The last item in the queue

Definition at line 41 of file PriorityQueueIterator.inl.

template<class TYPE >

TYPE & PriorityQueueIterator< TYPE >::GetCurrent

(

)

const

Returns the item the iterator is currently pointing at

Returns:

The current item

Definition at line 62 of file PriorityQueueIterator.inl.

template<class TYPE >

bool PriorityQueueIterator< TYPE >::IsValid

(

)

const

Checks if the iterator have reached the end of the table

Returns:

True if the iterator is at the end of the table

Definition at line 78 of file PriorityQueueIterator.inl.

template<class TYPE >

bool PriorityQueueIterator< TYPE >::Find

(

const TYPE &

data

)

Finds an item in the queue

Returns:

True if the item was found, or false if it was not found

Parameters:

data

item to look for

Definition at line 92 of file PriorityQueueIterator.inl.

template<class TYPE >

int PriorityQueueIterator< TYPE >::GetCurrentIndex

(

)

const

Gets the index that the iterator is currently pointing at

Returns:

Index of the item the iterator is currently pointing at

Definition at line 116 of file PriorityQueueIterator.inl.