Difference between revisions of "Unit UltiboClasses"

From Ultibo.org
Jump to: navigation, search
Line 12: Line 12:
 
----
 
----
  
''To be documented''
+
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''Error constants''' <code> *_Error </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>SListIndexError = 'List index out of bounds (%d)';</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>SFCreateError = 'Cannot create file %s';</code>
 +
| &nbsp;
 +
|-
 +
| <code>SFOpenError = 'Cannot open file %s';</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br /> 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''B-Tree constants''' <code> btree_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>btreeCompareLess = -1;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>btreeCompareEqual = 0;</code>
 +
| &nbsp;
 +
|-
 +
| <code>btreeCompareGreater = 1;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''Hash constants''' <code> *_Hash* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>stringHashSize = 8;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>listHashBits = 8;</code>
 +
| &nbsp;
 +
|-
 +
| <code>treeHashBits = 3;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>keyHashMinBits = 1;</code>
 +
| &nbsp;
 +
|-
 +
| <code>keyHashMaxBits = 16;</code>
 +
| Maximum of 16 bit hash mask (65535 buckets) due to memory usage
 +
|-
 +
| <code>keyHashMasks:array[keyHashMinBits..keyHashMaxBits] of LongWord = (</code>
 +
| &nbsp;
 +
|-
 +
| <code>$00000001,$00000003,$00000007,$0000000F,</code>
 +
| &nbsp;
 +
|-
 +
| <code>$0000001F,$0000003F,$0000007F,$000000FF,</code>
 +
| &nbsp;
 +
|-
 +
| <code>$000001FF,$000003FF,$000007FF,$00000FFF,</code>
 +
| &nbsp;
 +
|-
 +
| <code>$00001FFF,$00003FFF,$00007FFF,$0000FFFF);</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br /> 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''Delta constants''' <code> *_Delta </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>memoryStreamDelta = $2000;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>memoryStreamShift = 13;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>stringListDelta = $2000;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
  
 
=== Type definitions ===
 
=== Type definitions ===

Revision as of 03:32, 2 June 2017

Return to Unit Reference


Description


Ultibo classes unit

To be documented

Constants



Error constants *_Error
SListIndexError = 'List index out of bounds (%d)';  
SFCreateError = 'Cannot create file %s';  
SFOpenError = 'Cannot open file %s';  


B-Tree constants btree_*
btreeCompareLess = -1;  
btreeCompareEqual = 0;  
btreeCompareGreater = 1;  


Hash constants *_Hash*
stringHashSize = 8;  
 
listHashBits = 8;  
treeHashBits = 3;  
 
keyHashMinBits = 1;  
keyHashMaxBits = 16; Maximum of 16 bit hash mask (65535 buckets) due to memory usage
keyHashMasks:array[keyHashMinBits..keyHashMaxBits] of LongWord = (  
$00000001,$00000003,$00000007,$0000000F,  
$0000001F,$0000003F,$0000007F,$000000FF,  
$000001FF,$000003FF,$000007FF,$00000FFF,  
$00001FFF,$00003FFF,$00007FFF,$0000FFFF);  


Delta constants *_Delta
memoryStreamDelta = $2000;  
memoryStreamShift = 13;  
 
stringListDelta = $2000;  


Type definitions


None defined

Class definitions


To be documented

Public variables


None defined

Function declarations



procedure TimerExEvent(TimerEx:TTimerEx);
Description: To be documented
Note None documented


TThreadEx

procedure TThreadEx.Execution;
Description: To be documented
Note None documented


procedure TThreadEx.AfterExecution;
Description: To be documented
Note None documented


procedure TThreadEx.BeforeExecution;
Description: To be documented
Note None documented


procedure TThreadEx.Execute;
Description: To be documented
Note None documented


procedure TThreadEx.TerminateAndWaitFor;
Description: To be documented
Note None documented


TTimerEx

constructor TTimerEx.Create;
Description: To be documented
Note None documented


destructor TTimerEx.Destroy;
Description: To be documented
Note None documented


procedure TTimerEx.SetEnabled(Value:Boolean);
Description: To be documented
Note None documented


procedure TTimerEx.Timer;
Description: To be documented
Note None documented


procedure TTimerEx.StartTimer;
Description: To be documented
Note None documented


procedure TTimerEx.StopTimer;
Description: To be documented
Note None documented


TObjList

constructor TObjList.Create;
Description: To be documented
Note None documented


destructor TObjList.Destroy;
Description: To be documented
Note None documented


procedure TObjList.DestroyListObjects;
Description: To be documented
Note None documented


procedure TObjList.ClearList;
Description: To be documented
Note None documented


TThreadObjList

constructor TThreadObjList.Create;
Description: To be documented
Note None documented


destructor TThreadObjList.Destroy;
Description: To be documented
Note None documented


procedure TThreadObjList.DestroyListObjects;
Description: To be documented
Note None documented


procedure TThreadObjList.ClearList;
Description: To be documented
Note None documented


TLinkedList

constructor TLinkedList.Create;
Description: To be documented
Note None documented


destructor TLinkedList.Destroy;
Description: To be documented
Note None documented


function TLinkedList.GetCount:Integer;
Description: To be documented
Note None documented


function TLinkedList.Link(AValue:TListObject):Boolean;
Description: Link AValue to Prev,Next Siblings and Adjust First/Last
Note None documented


function TLinkedList.LinkEx(APrev,AValue:TListObject):Boolean;
Description: Link AValue after APrev Sibling and Adjust First/Last/Prev/Next
Note If APrev is nil then Link as first value in list


function TLinkedList.Unlink(AValue:TListObject):Boolean;
Description: Unlink AValue from Prev,Next Siblings and Adjust First/Last
Note None documented


function TLinkedList.Add(AValue:TListObject):Boolean;
Description: Add AValue to List and link with Siblings
Note None documented


function TLinkedList.Remove(AValue:TListObject):Boolean;
Description: Unlink AValue from Siblings and Remove from List
Note None documented


function TLinkedList.Insert(APrev,AValue:TListObject):Boolean;
Description: To be documented
Note None documented


procedure TLinkedList.Clear;
Description: To be documented
Note None documented


TLinkedObjList

destructor TLinkedObjList.Destroy;
Description: To be documented
Note None documented


procedure TLinkedObjList.ClearList;
Description: To be documented
Note None documented


TThreadLinkedObjList

constructor TThreadLinkedObjList.Create;
Description: To be documented
Note None documented


destructor TThreadLinkedObjList.Destroy;
Description: To be documented
Note None documented


procedure TThreadLinkedObjList.ClearList;
Description: To be documented
Note None documented


procedure TThreadLinkedObjList.LockList;
Description: To be documented
Note None documented


procedure TThreadLinkedObjList.UnlockList;
Description: To be documented
Note None documented


TLinkedTree

constructor TLinkedTree.Create;
Description: To be documented
Note None documented


destructor TLinkedTree.Destroy;
Description: To be documented
Note None documented


function TLinkedTree.GetCount:Integer;
Description: To be documented
Note None documented


function TLinkedTree.Link(AValue,AParent:TTreeObject):Boolean;
Description: To be documented
Note None documented


function TLinkedTree.LinkEx(APrev,AValue,AParent:TTreeObject):Boolean;
Description: Link AValue after APrev Sibling and Adjust FirstChild/LastChild/Prev/Next
Note If APrev is nil then Link as first child in parent or first value if Parent is nil


function TLinkedTree.Unlink(AValue:TTreeObject):Boolean;
Description: To be documented
Note None documented


function TLinkedTree.Add(AValue,AParent:TTreeObject):Boolean;
Description: Add AValue to List and Link with Parent and Siblings
Note None documented


function TLinkedTree.Remove(AValue:TTreeObject):Boolean;
Description: Unlink AValue from Parent and Siblings, Remove from List
Note None documented


function TLinkedTree.Insert(APrev,AValue,AParent:TTreeObject):Boolean;
Description: To be documented
Note None documented


procedure TLinkedTree.Move(AValue,AParent:TTreeObject);
Description: To be documented
Note None documented


procedure TLinkedTree.Clear;
Description: To be documented
Note None documented


function TLinkedTree.FirstChild(AParent:TTreeObject):TTreeObject;
Description: To be documented
Note None documented


function TLinkedTree.LastChild(AParent:TTreeObject):TTreeObject;
Description: To be documented
Note None documented


TLinkedObjTree

constructor TLinkedObjTree.Create;
Description: To be documented
Note None documented


destructor TLinkedObjTree.Destroy;
Description: To be documented
Note None documented


procedure TLinkedObjTree.ClearListItems(AParent:TTreeObject);
Description: To be documented
Note None documented


procedure TLinkedObjTree.ClearList;
Description: To be documented
Note None documented


TBtreeObject

procedure TBtreeObject.Clear;
Description: To be documented
Note None documented


TLinkedBtree

constructor TLinkedBtree.Create;
Description: To be documented
Note None documented


destructor TLinkedBtree.Destroy;
Description: To be documented
Note None documented


procedure TLinkedBtree.SetOrder(AOrder:LongWord);
Description: Set a new Order and calculate a new Median value
Note Minimum Order is 5 and minimum Median is 3


function TLinkedBtree.PropogateDrop(AEntry:TBtreeObject):Boolean;
Description: To be documented
Note None documented


function TLinkedBtree.PropogateMerge(AEntry:TBtreeObject):Boolean;
Description: To be documented
Note None documented


function TLinkedBtree.PropogateSplit(AEntry:TBtreeObject):Boolean;
Description: To be documented
Note This is currently not used by insert and must be tested before use


function TLinkedBtree.GetCount(AEntry:TBtreeObject):LongWord;
Description: Get the count of entries in the node of the supplied entry
Note Does not include the blank key


function TLinkedBtree.GetDepth(AEntry:TBtreeObject):LongWord;
Description: Get the depth of the supplied entry in the btree
Note None documented


function TLinkedBtree.GetEnd(AEntry:TBtreeObject):TBtreeObject;
Description: Get the end entry in the node of the supplied entry
Note Includes the blank key which may be the only key


function TLinkedBtree.GetStart(AEntry:TBtreeObject):TBtreeObject;
Description: Get the start entry in the node of the supplied entry
Note Includes the blank key which may be the only key


function TLinkedBtree.GetBlank(AEntry:TBtreeObject):TBtreeObject;
Description: Get the blank entry in the node of the supplied entry
Blank Blank entry is always the last entry in every node


function TLinkedBtree.GetMedian(AEntry:TBtreeObject):TBtreeObject;
Description: Get the median entry in the node of the supplied entry
Note Does not include the blank key


function TLinkedBtree.GetDrop(AEntry:TBtreeObject; var ALeft:Boolean):TBtreeObject;
Description: Get the neighbour with appropriate number of keys to drop
Drop Always drop with the Righthand neighbour if available
Note Only supported by descendant classes with non balanced nodes


function TLinkedBtree.GetMerge(AEntry:TBtreeObject):TBtreeObject;
Description: Get the neighbour with appropriate number of keys to merge
Merge Always merge with the Righthand neighbour if available


function TLinkedBtree.GetBorrow(AEntry:TBtreeObject):TBtreeObject;
Description: Get the neighbour with sufficient keys to borrow one
Borrow Always borrow from the Righthand neighbour if available


function TLinkedBtree.GetTarget(ADrop:TBtreeObject; ALeft:Boolean):TBtreeObject;
Description: Get the actual target within the neighbour that is appropriate to drop
Note Only supported by descendant classes with non balanced nodes


function TLinkedBtree.SetParent(AEntry,AParent:TBtreeObject):Boolean;
Description: Set the parent for all entries in a node and set the child of the parent
Note Includes the blank key which may be the only key


function TLinkedBtree.GetLefthand(AEntry:TBtreeObject):TBtreeObject;
Description: Get the lefthand neighbour (Node) of the supplied entries node
Note None documented


function TLinkedBtree.GetRighthand(AEntry:TBtreeObject):TBtreeObject;
Description: Get the righthand neighbour (Node) of the supplied entries node
Note None documented


function TLinkedBtree.GetLeftmost(AEntry:TBtreeObject):TBtreeObject;
Description: Get the leftmost entry in the tree of the supplied entry
Note None documented


function TLinkedBtree.GetRightmost(AEntry:TBtreeObject):TBtreeObject;
Description: Get the rightmost entry in the tree of the supplied entry
Note Does not include the blank key


function TLinkedBtree.GetSuccessor(AEntry:TBtreeObject):TBtreeObject;
Description: Get the successor (Right) entry of the supplied entry
Note The returned entry may be a blank key or a real key


function TLinkedBtree.GetPredecessor(AEntry:TBtreeObject):TBtreeObject;
Description: Get the predecessor (Left) entry of the supplied entry
Note The returned entry may be a blank key or a real key


function TLinkedBtree.GetPosition(AStart,AEntry:TBtreeObject):TBtreeObject;
Description: Get the position where entry should be inserted into the btree
Note The returned entry will be the entry to the right in insert node. The returned entry may be the blank key or may be a real key.


function TLinkedBtree.Push(AEntry:TBtreeObject):Boolean;
Description: Push the node containing the supplied entry
Push Push can only occur on the root node
Note Will create a new blank as root. All keys will be parented by new blank root.


function TLinkedBtree.Split(AEntry:TBtreeObject):Boolean;
Description: Split the node containing the supplied entry
Split Split can propogate all the way to root since median is promoted
Note Will promote the median entry to the parent. Keys left of median will be parented by median. Keys right of median will retain current parent. Child of median will parent to new blank on left. Median will be attached to the left of the parent.


function TLinkedBtree.Swap(AEntry,ASwap:TBtreeObject; ALeft:Boolean):Boolean;
Description: Swap the supplied entries directly from node to node
Note Entry is always a parent and Swap is always a leaf. No balancing is done as the entry is to be deleted or borrowed.


function TLinkedBtree.Drop(AEntry,ADrop,ATarget:TBtreeObject; ALeft:Boolean):Boolean;
Description: Drop the nodes of the supplied entries into one
Note None documented


function TLinkedBtree.Merge(AEntry,AMerge:TBtreeObject):Boolean;
Description: Merge the nodes of the supplied entries into one
Note None documented


function TLinkedBtree.Borrow(AEntry,ABorrow:TBtreeObject):Boolean;
Description: Borrow an entry from the supplied node to balance the tree
Note None documented


function TLinkedBtree.Link(AEntry,ANext:TBtreeObject):Boolean;
Description: Link the object to Prev/Next in linked list
Note If Next is nil then link as last


function TLinkedBtree.Unlink(AEntry:TBtreeObject):Boolean;
Description: Unlink the object from Prev/Next in linked list
Note None documented


function TLinkedBtree.LinkBlank(AEntry:TBtreeObject):Boolean;
Description: Link the object to Prev/Next in blank key list
Note Always link as last


function TLinkedBtree.UnlinkBlank(AEntry:TBtreeObject):Boolean;
Description: Unlink the object from Prev/Next in blank key list
Note None documented


function TLinkedBtree.Attach(AParent,AEntry,ARight:TBtreeObject):Boolean;
Description: Attach the object to Parent/Left/Right in btree
Note If Right is nil then attach as last. If Parent is nil then attach at root.


function TLinkedBtree.Detach(AEntry:TBtreeObject):Boolean;
Description: Detach the object from Parent/Left/Right in btree
Note None documented


function TLinkedBtree.PushNode(AEntry:TBtreeObject):Boolean;
Description: Called before a node is pushed following insert of an entry
Note None documented


function TLinkedBtree.SplitNode(AEntry:TBtreeObject):Boolean;
Description: Called before a node is split following insert of an entry
Note None documented


function TLinkedBtree.DropNode(AEntry,ADrop,ATarget:TBtreeObject; ALeft:Boolean):Boolean;
Description: Called before a node is dropped following removal of an entry
Note None documented


function TLinkedBtree.MergeNode(AEntry,AMerge:TBtreeObject):Boolean;
Description: Called before a node is merged following removal of an entry
Note None documented


function TLinkedBtree.BorrowEntry(AEntry,ABorrow:TBtreeObject):Boolean;
Description: Called before an entry is borrowed following removal of an entry
Note None documented


function TLinkedBtree.SwapEntry(AEntry,ASwap:TBtreeObject; ALeft:Boolean):Boolean;
Description: Called before an entry is swapped during a merge or borrow
Note None documented


function TLinkedBtree.SetParentEntry(AEntry,AParent:TBtreeObject):Boolean;
Description: Called after an entry is reparented during a push, split, merge, borrow or swap
Note None documented


function TLinkedBtree.CreateBlank:TBtreeObject;
Description: Create a blank key when a node is added (Split/Empty)
Note None documented


function TLinkedBtree.DeleteBlank(ABlank:TBtreeObject):Boolean;
Description: Delete a blank key when a node is removed (Merge)
Note None documented


function TLinkedBtree.AttachBlank(ABlank:TBtreeObject):Boolean;
Description: Called after a blank entry is attached to a node during split or merge
Note None documented


function TLinkedBtree.DetachBlank(ABlank:TBtreeObject):Boolean;
Description: Called before a blank entry is detached from a node during split or merge
Note None documented


function TLinkedBtree.AttachEntry(AEntry:TBtreeObject):Boolean;
Description: Called after a non blank entry is attached to a node during insert or remove
Note None documented


function TLinkedBtree.DetachEntry(AEntry:TBtreeObject):Boolean;
Description: Called before a non blank entry is detached from a node during insert or remove
Note None documented


function TLinkedBtree.RequirePush(AEntry:TBtreeObject):Boolean;
Description: Called after an entry is inserted to determine if a push is required
Entry Entry is the key that was inserted. Or a key in a parent node of the node where the entry was inserted.
Note Only supported by descendant classes with non balanced nodes


function TLinkedBtree.RequireSplit(AEntry:TBtreeObject):Boolean;
Description: Called after an entry is inserted to determine if a split is required
Entry Entry is the key that was inserted. Or a key in a parent node of the node where the entry was inserted.


function TLinkedBtree.RequireDrop(AEntry:TBtreeObject):Boolean;
Description: Called after an entry is removed to determine if a drop is required
Entry Entry is the start key of the node where the entry was removed. Or a key in a parent node of the node where the entry was removed.
Note Only supported by descendant classes with non balanced nodes


function TLinkedBtree.RequireMerge(AEntry:TBtreeObject):Boolean;
Description: Called after an entry is removed to determine if a merge is required
Entry Entry is the start key of the node where the entry was removed. Or a key in a parent node of the node where the entry was removed.


function TLinkedBtree.RequireBorrow(AEntry:TBtreeObject):Boolean;
Description: Called after an entry is removed to determine if a borrow is required
Entry Entry is the start key of the node where the entry was removed. Or a key in a parent node of the node where the entry was removed.


function TLinkedBtree.Compare(AEntry1,AEntry2:TBtreeObject):Integer;
Description: Always returns greater than unless the second entry is a blank key
Note This means keys will end up in added order if no compare is provided


function TLinkedBtree.Add(AParent,AEntry:TBtreeObject):Boolean;
Description: Add an entry to the btree without doing the full insert
Entry Entries must be added in btree order to obtain final order
Note Both real and blank keys can be added. No events are triggered by Add.


function TLinkedBtree.Insert(AEntry:TBtreeObject):Boolean;
Description: Insert an entry in the btree by finding its position
Note Rebalances the tree after inserting the new entry. Blank keys cannot be inserted. Entry must be created by the caller.


function TLinkedBtree.Remove(AEntry:TBtreeObject):Boolean;
Description: Remove an entry from the btree by deleting it
Note Rebalances the tree after deleting the entry. Blank keys cannot be removed. Entry must be destroyed by the caller.


procedure TLinkedBtree.Clear;
Description: Removes all entries from the btree
Note None documented


procedure TLinkedBtree.Empty;
Description: Removes all entries from the btree and adds a blank root key
Note None documented


procedure TLinkedBtree.Rebuild;
Description: Empties the btree and rebuilds from the linked list
Note None documented


TLinkedObjBtree

constructor TLinkedObjBtree.Create;
Description: To be documented
Note None documented


destructor TLinkedObjBtree.Destroy;
Description: To be documented
Note None documented


procedure TLinkedObjBtree.ClearBtree;
Description: Removes and frees all entries in the btree
Note None documented


procedure TLinkedObjBtree.EmptyBtree;
Description: Removes and frees all entries in the btree and adds a blank root key
Note None documented


THashListObject

procedure THashListObject.SetKeyHash(AKeyHash:LongWord);
Description: To be documented
Note None documented


THashLinkedList

constructor THashLinkedList.Create(AKeyBits:Byte);
Description: To be documented
Note None documented


destructor THashLinkedList.Destroy;
Description: To be documented
Note None documented


function THashLinkedList.KeyLink(AValue:THashListObject):Boolean;
Description: Link AValue to Prev,Next Keys and Adjust First
Note None documented


function THashLinkedList.KeyUnlink(AValue:THashListObject):Boolean;
Description: Unlink AValue from Prev,Next Keys and Adjust First
Note None documented


function THashLinkedList.KeyFirst(AKeyHash:LongWord):THashListObject;
Description: To be documented
Note None documented


function THashLinkedList.Add(AValue:TListObject):Boolean;
Description: Add AValue to List and link with Siblings
Note None documented


function THashLinkedList.Remove(AValue:TListObject):Boolean;
Description: Unlink AValue from Siblings and Remove from List
Note None documented


function THashLinkedList.Insert(APrev,AValue:TListObject):Boolean;
Description: To be documented
Note None documented


procedure THashLinkedList.Clear;
Description: To be documented
Note None documented


THashLinkedObjList

constructor THashLinkedObjList.Create(AKeyBits:Byte);
Description: To be documented
Note None documented


destructor THashLinkedObjList.Destroy;
Description: To be documented
Note None documented


procedure THashLinkedObjList.ClearList;
Description: To be documented
Note None documented


THashTreeObject

constructor THashTreeObject.Create(AKeyBits:Byte);
Description: To be documented
Note None documented


destructor THashTreeObject.Destroy;
Description: To be documented
Note None documented


procedure THashTreeObject.SetKeyHash(AKeyHash:LongWord);
Description: To be documented
Note None documented


function THashTreeObject.KeyLink(AValue:THashTreeObject):Boolean;
Description: Link AValue to Prev,Next Keys and Adjust First
Note None documented


function THashTreeObject.KeyUnlink(AValue:THashTreeObject):Boolean;
Description: Unlink AValue from Prev,Next Keys and Adjust First
Note None documented


function THashTreeObject.KeyFirst(AKeyHash:LongWord):THashTreeObject;
Description: To be documented
Note None documented


THashLinkedTree

constructor THashLinkedTree.Create(AKeyBits:Byte);
Description: To be documented
Note None documented


destructor THashLinkedTree.Destroy;
Description: To be documented
Note None documented


function THashLinkedTree.KeyLink(AValue,AParent:THashTreeObject):Boolean;
Description: Link AValue to Prev,Next Keys and Adjust First
Note None documented


function THashLinkedTree.KeyUnlink(AValue,AParent:THashTreeObject):Boolean;
Description: Unlink AValue from Prev,Next Keys and Adjust First
Note None documented


function THashLinkedTree.KeyFirst(AParent:THashTreeObject; AKeyHash:LongWord):THashTreeObject;
Description: To be documented
Note None documented


function THashLinkedTree.Add(AValue,AParent:TTreeObject):Boolean;
Description: Add AValue to List and Link with Parent and Siblings
Note None documented


function THashLinkedTree.Remove(AValue:TTreeObject):Boolean;
Description: Unlink AValue from Parent and Siblings, Remove from List
Note None documented


function THashLinkedTree.Insert(APrev,AValue,AParent:TTreeObject):Boolean;
Description: To be documented
Note None documented


procedure THashLinkedTree.Move(AValue,AParent:TTreeObject);
Description: To be documented
Note None documented


procedure THashLinkedTree.Clear;
Description: To be documented
Note None documented


THashLinkedObjTree

constructor THashLinkedObjTree.Create(AKeyBits:Byte);
Description: To be documented
Note None documented


destructor THashLinkedObjTree.Destroy;
Description: To be documented
Note None documented


procedure THashLinkedObjTree.ClearListItems(AParent:THashTreeObject);
Description: To be documented
Note None documented


procedure THashLinkedObjTree.ClearList;
Description: To be documented
Note None documented


TStringObject

procedure TStringObject.SetValue(const AValue:String);
Description: To be documented
Note None documented


TLinkedStringList

constructor TLinkedStringList.Create;
Description: To be documented
Note None documented


destructor TLinkedStringList.Destroy;
Description: To be documented
Note None documented


function TLinkedStringList.GetItem(AIndex:Integer):TStringObject;
Description: To be documented
Note None documented


function TLinkedStringList.Link(AValue:TStringObject):Boolean;
Description: Link AValue to Prev,Next Siblings and Adjust First/Last
Note None documented


function TLinkedStringList.LinkEx(APrev,AValue:TStringObject):Boolean;
Description: Link AValue after APrev Sibling and Adjust First/Last/Prev/Next
Note If APrev is nil then Link as first value in list


function TLinkedStringList.Unlink(AValue:TStringObject):Boolean;
Description: Unlink AValue from Prev,Next Siblings and Adjust First/Last
Note None documented


procedure TLinkedStringList.ClearList;
Description: To be documented
Note None documented


procedure TLinkedStringList.Changed;
Description: To be documented
Note None documented


procedure TLinkedStringList.Changing;
Description: To be documented
Note None documented


function TLinkedStringList.Get(Index:Integer):String;
Description: To be documented
Note None documented


function TLinkedStringList.GetCount:Integer;
Description: To be documented
Note None documented


function TLinkedStringList.GetObject(Index:Integer):TObject;
Description: To be documented
Note None documented


procedure TLinkedStringList.Put(Index:Integer;const S:String);
Description: To be documented
Note None documented


procedure TLinkedStringList.PutObject(Index:Integer; AObject:TObject);
Description: To be documented
Note None documented


procedure TLinkedStringList.SetUpdateState(Updating:Boolean);
Description: To be documented
Note None documented


function TLinkedStringList.Add(const S:String):Integer;
Description: To be documented
Note None documented


procedure TLinkedStringList.Clear;
Description: To be documented
Note None documented


procedure TLinkedStringList.Delete(Index:Integer);
Description: To be documented
Note None documented


procedure TLinkedStringList.Exchange(Index1,Index2:Integer);
Description: To be documented
Note None documented


function TLinkedStringList.IndexOf(const S:String):Integer;
Description: Uses Counted Index starting from First String Object
Note None documented


procedure TLinkedStringList.Insert(Index:Integer; const S:String);
Description: To be documented
Note None documented


TStringBlock

destructor TStringBlock.Destroy;
Description: To be documented
Note None documented


TLinkedStringListEx

constructor TLinkedStringListEx.Create;
Description: To be documented
Note None documented


destructor TLinkedStringListEx.Destroy;
Description: To be documented
Note None documented


function TLinkedStringListEx.GetBlock(Index:Integer):TStringBlock;
Description: To be documented
Note None documented


function TLinkedStringListEx.AddBlock(Block:TStringBlock; Index:Integer):TStringBlock;
Description: To be documented
Index Starting Index of Block to be Added
Block Current Block containing Index or nil


function TLinkedStringListEx.DeleteBlock(Block:TStringBlock):Boolean;
Description: To be documented
Note None documented


function TLinkedStringListEx.UpdateBlocks(Block:TStringBlock):Boolean;
Description: To be documented
Note None documented


function TLinkedStringListEx.GetItem(Block:TStringBlock; Index:Integer):TStringObjectEx;
Description: To be documented
Note None documented


function TLinkedStringListEx.AddItem(Block:TStringBlock; Index:Integer; Item:TStringObjectEx):Boolean;
Description: To be documented
Note None documented


function TLinkedStringListEx.DeleteItem(Block:TStringBlock;Index:Integer; Item:TStringObjectEx):Boolean;
Description: To be documented
Note None documented


function TLinkedStringListEx.IndexOfItem(Block:TStringBlock; Item:TStringObjectEx):Integer;
Description: To be documented
Note None documented


function TLinkedStringListEx.Get(Index:Integer):String;
Description: To be documented
Note None documented


function TLinkedStringListEx.GetCapacity:Integer;
Description: To be documented
Note None documented


function TLinkedStringListEx.GetObject(Index:Integer):TObject;
Description: To be documented
Note None documented


procedure TLinkedStringListEx.Put(Index:Integer;const S:String);
Description: To be documented
Note None documented


procedure TLinkedStringListEx.PutObject(Index:Integer; AObject:TObject);
Description: To be documented
Note None documented


function TLinkedStringListEx.Add(const S:String):Integer;
Description: To be documented
Note None documented


procedure TLinkedStringListEx.Clear;
Description: To be documented
Note None documented


procedure TLinkedStringListEx.Delete(Index:Integer);
Description: To be documented
Note None documented


procedure TLinkedStringListEx.Exchange(Index1,Index2:Integer);
Description: To be documented
Note None documented


function TLinkedStringListEx.IndexOf(const S:String):Integer;
Description: Uses IndexOfItem within the Block of the matched String Object
Note Could use Counted Index method of TLinkedStringList instead


procedure TLinkedStringListEx.Insert(Index:Integer; const S:String);
Description: To be documented
Note None documented


THashStringObject

procedure THashStringObject.SetHash(AHash:LongWord);
Description: To be documented
Note None documented


procedure THashStringObject.SetValue(const AValue:String);
Description: To be documented
Note None documented


THashLinkedStringList

constructor THashLinkedStringList.Create(AKeyBits:Byte);
Description: To be documented
Note None documented


destructor THashLinkedStringList.Destroy;
Description: To be documented
Note None documented


function THashLinkedStringList.KeyLink(AValue:THashStringObject):Boolean;
Description: Link AValue to Prev,Next Keys and Adjust First
Note None documented


function THashLinkedStringList.KeyUnlink(AValue:THashStringObject):Boolean;
Description: Unlink AValue from Prev,Next Keys and Adjust First
Note None documented


procedure THashLinkedStringList.ClearList;
Description: To be documented
Note None documented


function THashLinkedStringList.KeyFirst(AKeyHash:LongWord):THashStringObject;
Description: To be documented
Note None documented


function THashLinkedStringList.Add(const S:String):Integer;
Description: To be documented
Note None documented


procedure THashLinkedStringList.Delete(Index:Integer);
Description: To be documented
Note None documented


function THashLinkedStringList.IndexOf(const S:String):Integer;
Description: Uses IndexOfItem within the Block of the matched String Object
Note Cannot use Counted Index method due to use of Hash Buckets


procedure THashLinkedStringList.Insert(Index:Integer; const S:String);
Description: To be documented
Note None documented


TIntegerList

constructor TIntegerList.Create;
Description: To be documented
Note None documented


destructor TIntegerList.Destroy;
Description: To be documented
Note None documented


function TIntegerList.GetItem(Idx:Integer):Integer;
Description: To be documented
Note None documented


procedure TIntegerList.SetItem(Idx,Value:Integer);
Description: To be documented
Note None documented


function TIntegerList.GetCount:Integer;
Description: To be documented
Note None documented


function TIntegerList.Add(AValue:Integer):Integer;
Description: To be documented
Note None documented


function TIntegerList.Remove(AValue:Integer):Integer;
Description: To be documented
Note None documented


procedure TIntegerList.Delete(Idx:Integer);
Description: To be documented
Note None documented


function TIntegerList.IndexOf(AValue:Integer):Integer;
Description: To be documented
Note None documented


procedure TIntegerList.Clear;
Description: To be documented
Note None documented


TDateTimeList

constructor TDateTimeList.Create;
Description: To be documented
Note None documented


destructor TDateTimeList.Destroy;
Description: To be documented
Note None documented


function TDateTimeList.GetItem(Idx:Integer):TDateTime;
Description: To be documented
Note None documented


procedure TDateTimeList.SetItem(Idx:Integer; Value:TDateTime);
Description: To be documented
Note None documented


function TDateTimeList.GetCount:Integer;
Description: To be documented
Note None documented


function TDateTimeList.Add(AValue:TDateTime):Integer;
Description: To be documented
Note None documented


function TDateTimeList.Remove(AValue:TDateTime):Integer;
Description: To be documented
Note None documented


procedure TDateTimeList.Delete(Idx:Integer);
Description: To be documented
Note None documented


function TDateTimeList.IndexOf(AValue:TDateTime):Integer;
Description: To be documented
Note None documented


procedure TDateTimeList.Clear;
Description: To be documented
Note None documented


TMemoryBlock

destructor TMemoryBlock.Destroy;
Description: To be documented
Note None documented


TMemoryStreamEx

constructor TMemoryStreamEx.Create;
Description: To be documented
Note None documented


destructor TMemoryStreamEx.Destroy;
Description: To be documented
Note None documented


function TMemoryStreamEx.RoundSize(ASize:LongInt):LongWord;
Description: To be documented
Note None documented


function TMemoryStreamEx.GetBlock(AOffset:LongWord):TMemoryBlock;
Description: To be documented
Note None documented


function TMemoryStreamEx.ReadBlock(ABlock:TMemoryBlock; ABuffer:Pointer; AOffset,ACount:LongWord):LongWord;
Description: To be documented
Note None documented


function TMemoryStreamEx.WriteBlock(ABlock:TMemoryBlock; ABuffer:Pointer; AOffset,ACount:LongWord):LongWord;
Description: To be documented
Note None documented


procedure TMemoryStreamEx.SetCapacity(ACapacity:LongWord);
Description: To be documented
Note None documented


procedure TMemoryStreamEx.SetSize(ASize:LongInt);
Description: To be documented
Note None documented


function TMemoryStreamEx.Read(var ABuffer; ACount:LongInt):LongInt;
Description: To be documented
Note None documented


function TMemoryStreamEx.Write(const ABuffer; ACount:LongInt):LongInt;
Description: To be documented
Note None documented


function TMemoryStreamEx.Seek(AOffset:LongInt; AOrigin:Word):LongInt;
Description: To be documented
Note None documented


procedure TMemoryStreamEx.SaveToStream(AStream:TStream);
Description: To be documented
Note None documented


procedure TMemoryStreamEx.LoadFromStream(AStream:TStream);
Description: To be documented
Note None documented


procedure TMemoryStreamEx.SaveToFile(const AFileName:String);
Description: To be documented
Note None documented


procedure TMemoryStreamEx.LoadFromFile(const AFileName:String);
Description: To be documented
Note None documented


procedure TMemoryStreamEx.Clear;
Description: To be documented
Note None documented


TStreamEx

function TStreamEx.GetPositionEx:Int64;
Description: To be documented
Note None documented


procedure TStreamEx.SetPositionEx(const Pos:Int64);
Description: To be documented
Note None documented


function TStreamEx.GetSizeEx:Int64;
Description: To be documented
Note None documented


procedure TStreamEx.SetSizeEx(const NewSize:Int64);
Description: To be documented
Note None documented


THandleStreamEx

constructor THandleStreamEx.Create(AHandle:Integer);
Description: To be documented
Note None documented


procedure THandleStreamEx.SetSize(NewSize:LongInt);
Description: To be documented
Note None documented


procedure THandleStreamEx.SetSizeEx(const NewSize:Int64);
Description: To be documented
Note None documented


function THandleStreamEx.Read(var Buffer; Count:Longint):Longint;
Description: To be documented
Note None documented


function THandleStreamEx.Write(const Buffer; Count:Longint):Longint;
Description: To be documented
Note None documented


function THandleStreamEx.Seek(Offset:Longint; Origin:Word):Longint;
Description: To be documented
Note None documented


function THandleStreamEx.SeekEx(const Offset:Int64; Origin:Word):Int64;
Description: To be documented
Note None documented


TFileStreamEx

constructor TFileStreamEx.Create(const FileName:String; Mode:Word);
Description: To be documented
Note None documented


destructor TFileStreamEx.Destroy;
Description: To be documented
Note None documented


TStringItemEx

procedure TStringItemEx.SetValue(const AValue:String);
Description: To be documented
Note None documented


TStringListEx

constructor TStringListEx.Create;
Description: To be documented
Note None documented


destructor TStringListEx.Destroy;
Description: To be documented
Note None documented


function TStringListEx.GetBlock(Index:Integer):TStringBlock;
Description: To be documented
Note None documented


function TStringListEx.AddBlock(Block:TStringBlock; Index:Integer):TStringBlock;
Description: To be documented
Index Starting Index of Block to be Added
Block Current Block containing Index or nil


function TStringListEx.DeleteBlock(Block:TStringBlock):Boolean;
Description: To be documented
Note None documented


function TStringListEx.UpdateBlocks(Block:TStringBlock):Boolean;
Description: To be documented
Note None documented


function TStringListEx.GetItem(Block:TStringBlock; Index:Integer):TStringItemEx;
Description: To be documented
Note None documented


function TStringListEx.AddItem(Block:TStringBlock; Index:Integer; Item:TStringItemEx):Boolean;
Description: To be documented
Note None documented


function TStringListEx.DeleteItem(Block:TStringBlock; Index:Integer; Item:TStringItemEx):Boolean;
Description: To be documented
Note None documented


procedure TStringListEx.ClearList;
Description: To be documented
Note None documented


procedure TStringListEx.Changed;
Description: To be documented
Note None documented


procedure TStringListEx.Changing;
Description: To be documented
Note None documented


function TStringListEx.Get(Index:Integer):String;
Description: To be documented
Note None documented


function TStringListEx.GetCapacity:Integer;
Description: To be documented
Note None documented


function TStringListEx.GetCount:Integer;
Description: To be documented
Note None documented


function TStringListEx.GetObject(Index:Integer):TObject;
Description: To be documented
Note None documented


procedure TStringListEx.Put(Index:Integer; const S:String);
Description: To be documented
Note None documented


procedure TStringListEx.PutObject(Index:Integer; AObject:TObject);
Description: To be documented
Note None documented


procedure TStringListEx.SetUpdateState(Updating:Boolean);
Description: To be documented
Note None documented


function TStringListEx.Add(const S:String):Integer;
Description: To be documented
Note None documented


procedure TStringListEx.Clear;
Description: To be documented
Note None documented


procedure TStringListEx.Delete(Index:Integer);
Description: To be documented
Note None documented


procedure TStringListEx.Exchange(Index1,Index2:Integer);
Description: To be documented
Note None documented


function TStringListEx.IndexOf(const S:String):Integer;
Description: Uses Counted Index within the Block of the matched String Object
Note None documented


procedure TStringListEx.Insert(Index:Integer; const S:String);
Description: To be documented
Note None documented


Return to Unit Reference