siliziumbrain.queue:

Queue.

This module provides a Queue class (#TQueue). It can do everything what a queue should can do.

Types Summary

TQueue class.

Types

Type TQueue Extends TObject
Description	TQueue class.
Information	A queue which can add object at the and and remove objects at the beginning.

Methods Summary
__Content	Private Method. Do not use.
__ID	Private Method. Do not use.
__SetContent	Private Method. Do not use.
__SetID	Private Method. Do not use.
__SetTimeWhenCreated	Private Method. Do not use.
__TimeWhenCreated	Private Method. Do not use.
Clear	Clears the queue.
Contains	Checks if a certain object is in the queue.
Copy	Copies the queue (deep).
CopyTo	Copies the queue to an array (flat).
Count	Returns the amount of objects in the queue.
Dequeue	Deques an object.
Enqueue	Enqueue an object.
Equals	Checks if the queue is equal to another object.
New	Constructor.
Peek	Peeks an object.
ToArray	Returns the queue as an array.
ToString	Returns the queue as a string.

Method __Content:TList()
Description	Private Method. Do not use.
Information	Returns the intern list.

Method __ID:Int()
Description	Private Method. Do not use.
Information	Returns the ID of the queue.

Method __SetContent(ptlContent:TList)
Description	Private Method. Do not use.
Information	Sets the intern list.

Method __SetID(piID:Int)
Description	Private Method. Do not use.
Information	Sets the ID of the queue.

Method __SetTimeWhenCreated(psTimeWhenCreated:String)
Description	Private Method. Do not use.
Information	Sets the time when the queue was created as a string.

Method __TimeWhenCreated:String()
Description	Private Method. Do not use.
Information	Returns the time when the queue was created as a string.

Method Clear()
Description	Clears the queue.
Information	Removes every object from the queue.

Method Contains:Byte(poObject:Object)
Description	Checks if a certain object is in the queue.
Information	Checks if poObject is in the queue. returns: True if object is in queue, otherwise false.

Method Copy:TQueue()
Description	Copies the queue (deep).
Information	Creates a deep copy of the queue (as far as possible). returns: New queue which is a (deep) copy of this queue.

Method CopyTo(oaArrayToCopyTo:Object[] Var, iStartIndex:Int = 0)
Description	Copies the queue to an array (flat).
Information	The queue is copied into the array oaArrayToCopyTo, starting at index iStartIndex. The array is given to the method as pointer. So nothing is returned. Throws: TNullPointerException if oaArrayToCopyTo is null. Throws: TArgumentOutOfRangeException if iStartIndex is < 0. Throws: TIllegalArgumentException if iStartIndex is too big.

Method Count:Int()
Description	Returns the amount of objects in the queue.
Information	Sets the time when the list was created as a string. returns: Amount of elements in the queue.

Method Dequeue:Object()
Description	Deques an object.
Information	Returns the first object in the queue and removes it from the queue. Throws: TInvalidOperationException if the queue is empty. returns: First object in queue.

Method Enqueue(poObjectToEnqueue:Object)
Description	Enqueue an object.
Information	Adds poObjectToEnqueue at the end of the queue.

Method Equals:Byte(ptoOtherObject:TObject)
Description	Checks if the queue is equal to another object.
Information	Checks if the queue equals ptoOtherObject. returns: true if they are equal, otherwise false.

Method New()
Description	Constructor.
Information	Returns a new queue.

Method Peek:Object()
Description	Peeks an object.
Information	Returns the first object in the queue without removing it from the queue. Throws: TInvalidOperationException if the queue is empty. returns: First object in queue.

Method ToArray:Object[] ()
Description	Returns the queue as an array.
Information	Every entry of the queue is copied (flat) into an array. returns: Queue as an array.

Method ToString:String()
Description	Returns the queue as a string.
Information	Gives certain information about the queue. returns: The queue as a string.

Module Information

Version	v1.00
Author	M0rgenstern - Siliziumbrain - Kevin Peter Hoffeld
License	Public Domain
History v1.00	12 July 2012 - Final Release