SimpleQueue class documentation

Authors

Generated by rh

Software documentation for the SimpleQueue class

SimpleQueue : NSObject

Declared in:
SimpleQueue.h
A simple queue class using NSMutableArray

Instance Variables

Method summary

dealloc 

- (void) dealloc;
release references and deallocate memory

init 

- (id) init;
default queue initialiser

isEmpty 

- (BOOL) isEmpty;
return YES if the queue is empty

peekObject 

- (id) peekObject;
return the element at the beginning of the queue without removing it

popObject 

- (id) popObject;
pop an object off the beginning of the queue

pushObject: 

- (id) pushObject: (id)object;
push an object onto the end of the queue

swapTopMostObjects 

- (id) swapTopMostObjects;
swap the two elements at the beginning of the queue



Instance Variables for SimpleQueue Class

elements

@protected NSMutableArray* elements;
elements held by the queue