class Geo GeoPriorityQueue

This is the documentation for Enlighten.

class Geo GeoPriorityQueue

template<typename T>
class Geo::GeoPriorityQueue

    └>Geo::GeoQueue< T >

GeoPriorityQueue.

Implements a priority queue, with priority being determined by T's > operator.

Functions

Name

Description

Name

Description

~GeoQueue()

Destructor deletes all objects in the queue and then releases any memory allocated on init.

EmptyQueue()

Empty the queue.

Enumerate(GeoQueueEnumInterface< T > *, void *)

Walk all of the objects in the queue and call the callback (oldest first) Returns false if early termination requested by callback.

GeoPriorityQueue()

Constructor.

GeoQueue()

Constructor just clears the pointers, queue must have a size specified before it can be used.

GetArrayPointer()

Allows access to the start of the object array.

Peek(T &)

Read the oldest object in the queue but don't remover it.

Peek(T &)

Read the oldest object in the queue but don't remover it.

Read(T &)

Read the oldest object in the queue, removing it from the queue.

Read(T &)

Read the oldest object in the queue, removing it from the queue.

ReSetMaxObjects(Geo::u32)

Implements the actual moving of data used in SetMaxObjects.

SetMaxObjects(Geo::u32)

Sets the maximum number of objects to the specified value, retaining any objects already in the queue.

Write(const T &)

Write an object to the queue.

Write(const T &)

Write an object to the queue.



Geo::GeoQueue< T >::~GeoQueue


public: ~GeoQueue()


Destructor deletes all objects in the queue and then releases any memory allocated on init.



void Geo::GeoQueue< T >::EmptyQueue


public: void EmptyQueue()


Empty the queue.



bool Geo::GeoQueue< T >::Enumerate


public: bool Enumerate
(
    GeoQueueEnumInterface< T > * callback,
    void * context
)


Walk all of the objects in the queue and call the callback (oldest first) Returns false if early termination requested by callback.



Geo::GeoPriorityQueue< T >::GeoPriorityQueue