siliziumbrain.queue: Types Modinfo Source  

Queue.

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

Types Summary

TQueue TQueue class.

Types

Type TQueue Extends TObject
DescriptionTQueue class.
InformationA 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()
DescriptionPrivate Method. Do not use.
InformationReturns the intern list.
Method __ID:Int()
DescriptionPrivate Method. Do not use.
InformationReturns the ID of the queue.
Method __SetContent(ptlContent:TList)
DescriptionPrivate Method. Do not use.
InformationSets the intern list.
Method __SetID(piID:Int)
DescriptionPrivate Method. Do not use.
InformationSets the ID of the queue.
Method __SetTimeWhenCreated(psTimeWhenCreated:String)
DescriptionPrivate Method. Do not use.
InformationSets the time when the queue was created as a string.
Method __TimeWhenCreated:String()
DescriptionPrivate Method. Do not use.
InformationReturns the time when the queue was created as a string.
Method Clear()
DescriptionClears the queue.
InformationRemoves every object from the queue.
Method Contains:Byte(poObject:Object)
DescriptionChecks if a certain object is in the queue.
InformationChecks if poObject is in the queue.
returns: True if object is in queue, otherwise false.
Method Copy:TQueue()
DescriptionCopies the queue (deep).
InformationCreates 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)
DescriptionCopies the queue to an array (flat).
InformationThe 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()
DescriptionReturns the amount of objects in the queue.
InformationSets the time when the list was created as a string. returns: Amount of elements in the queue.
Method Dequeue:Object()
DescriptionDeques an object.
InformationReturns 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)
DescriptionEnqueue an object.
InformationAdds poObjectToEnqueue at the end of the queue.
Method Equals:Byte(ptoOtherObject:TObject)
DescriptionChecks if the queue is equal to another object.
InformationChecks if the queue equals ptoOtherObject.
returns: true if they are equal, otherwise false.
Method New()
DescriptionConstructor.
InformationReturns a new queue.
Method Peek:Object()
DescriptionPeeks an object.
InformationReturns 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[] ()
DescriptionReturns the queue as an array.
InformationEvery entry of the queue is copied (flat) into an array.
returns: Queue as an array.
Method ToString:String()
DescriptionReturns the queue as a string.
InformationGives certain information about the queue.
returns: The queue as a string.

Module Information

Versionv1.00
AuthorM0rgenstern - Siliziumbrain - Kevin Peter Hoffeld
LicensePublic Domain
History v1.0012 July 2012 - Final Release