class QueuedEvents

Provides an interface to many queues of events

Public Methods

QueuedEvents()

Default constructor

~QueuedEvents()

Destructor

QueuedEventsItr startQueue(const ID tokenId)

bool enqueue(const ID tokenId, const ProcessEvent event, const ID resource, const double amount)

Add an event to the event list for a particular token

bool enqueue(const QueuedEventsItr& itr, const ProcessEvent event, const ID resource, const double amount)

bool dequeue(const ID tokenId)

Remove an event from the token's event list.

bool dequeue(QueuedEventsItr& itr)

EventData front(const ID tokenId) const

Get the next event and resource this event will be performed on

EventData front(const QueuedEventsConstItr& itr) const

bool find(const ID tokenId) const

Finds the token in the queue

QueuedEventsItr findItr(const ID tokenId)

SIZE size(void) const

SIZE size(const ID tokenId) const

Get the number of events that the token has pending

SIZE size(const QueuedEventsConstItr& itr) const

bool empty(const ID tokenID) const

Checks to see if the queue associated with the tokenID is empty

bool empty(QueuedEventsItr& itr) const

bool set(const ID tokenId, const queue <EventData> & sequence)

Set the token's event list to the queue passed as an argument

void clear(const ID tokenID)

Deletes the token's event list

void clear(QueuedEventsItr& itr)

void clearAll()

Deletes all event lists

Documentation

This object is a convienience that helps keep track of what tokens need what services next.

QueuedEvents()

~QueuedEvents()

QueuedEventsItr startQueue(const ID tokenId)

bool enqueue(const ID tokenId, const ProcessEvent event, const ID resource, const double amount)

This method adds on something else the token needs to do in order to accomplish a task. Each event in the queue is a low-level event that has come from a higher-level event.

bool enqueue(const QueuedEventsItr& itr, const ProcessEvent event, const ID resource, const double amount)

bool dequeue(const ID tokenId)

bool dequeue(QueuedEventsItr& itr)

EventData front(const ID tokenId) const

EventData front(const QueuedEventsConstItr& itr) const

bool find(const ID tokenId) const

Returns:

true if found, false if not.

QueuedEventsItr findItr(const ID tokenId)

SIZE size(void) const

SIZE size(const ID tokenId) const

SIZE size(const QueuedEventsConstItr& itr) const

bool empty(const ID tokenID) const

Note that if no queue exists, it is regarded as empty.

Returns:

true if the queue associated with the tokenID is empty. False otherwise

bool empty(QueuedEventsItr& itr) const

bool set(const ID tokenId, const queue <EventData> & sequence)

void clear(const ID tokenID)

void clear(QueuedEventsItr& itr)

void clearAll()

This class has no child classes.

Author:

John Oleszkiewicz

Alphabetic index HTML hierarchy of classes or Java