→ home
 
→ index of namespace default
 
→ index of project core
 
→ index of module core

Class core.PointerArray

Synopsis: An heterogenous array of objects. 

  Base classes:
  Methods: Description:


A "deleteme" flag is stored with each element.
Object class types may be arbitrarily mixed.

See also:  


 
→ top of page
Method add
Add the given object to the arraylist.
Signature
add(Objecto)
 :boolean
Arguments
Objecto–The object to add to the arraylist. If o is a Value object, the contained (deletable) object will be released from the Value container.
Returns
boolean–true if the object has been added successfully, false otherwise.
Description

The array will be resized as required.
See also:  


 
→ top of page
Method alloc
Allocate the given number of array elements.
Signature
alloc(intmax)
 :boolean
Arguments
intmax–Total number of elements to allocate.
Returns
boolean–true if the allocation succeeded, false otherwise.
Description

The number of used elements, numElements, will be reset to 0.
See also:  


 
→ top of page
Method containsObject
Check whether array contains an object that equals the given object.
Signature
containsObject(Objecto)
 :boolean
Arguments
Objecto–The object to compare with. Object.yacEquals() is used for comparisons.
Returns
boolean–true if a matching object was found, false otherwise.
See also:  


 
→ top of page
Method containsPointer
Check whether array contains the given object address.
Signature
containsPointer(Objecto)
 :boolean
Arguments
Objecto–The object (address) to compare with.
Returns
boolean–true if a matching object was found, false otherwise.
See also:  


 
→ top of page
Method delete
Delete the element at the given index.
Signature
delete(intindex)
Arguments
intindex–Which element to delete
See also:  


 
→ top of page
Method empty
Reset the number of used elements, numElements, to 0.
Signature
empty()
Description

This will reset the number of used elements, numElements, back to 0.
See also:  


 
→ top of page
Method free
Free array elements.
Signature
free()
See also:  


 
→ top of page
Method get
Return a reference to the given array element.
Signature
get(intindex)
 :Object
Arguments
intindex–Which element to return
Returns
Object–Reference to array element.
Description

This will silently return null if "index" is out of bounds.
See also:  


 
→ top of page
Method getDeref
Return a (deletable) reference to the given array element.
Signature
getDeref(intindex)
 :Object
Arguments
intindex–Which element to return
Returns
Object–(deletable) reference to array element
Description

This will silently return null if "index" is out of bounds.
See also:  


 
→ top of page
Method getFirst
Return first array element.
Signature
getFirst():Object
Returns
Object–First array element or null if the array is empty. Objects are returned as non-deletable references.

 
→ top of page
Method getLast
Return last used array element.
Signature
getLast():Object
Returns
Object–Last used array element (numElements - 1) or null if the array is empty. Objects are returned as non-deletable references.

 
→ top of page
Method getMaxElements
Return the total number of elements.
Signature
getMaxElements():int
Returns
int–Total number of elements.
See also:  


 
→ top of page
Method getNextFree
Return a reference to the next free array element.
Signature
getNextFree():Object
Returns
Object–Reference to next free element.
Description

This will increase the number of used elements, numElements.
See also:  


 
→ top of page
Method getNumElements
Return the number of used elements.
Signature
getNumElements():int
Returns
int–Number of used elements
See also:  


 
→ top of page
Method getString
Return a string representation of this array.
Signature
getString():String
Returns
String–new String instance holding a string representation of this array.

 
→ top of page
Method indexOfObject
Return the index of the element that equals the given object.
Signature
indexOfObject(Objecto)
 :int
Arguments
Objecto–The object to look for
Returns
int–Array index or -1 if no matching object was found in this array
See also:  


 
→ top of page
Method indexOfPointer
Return the index of the element that points to the given object.
Signature
indexOfPointer(Objecto)
 :int
Arguments
Objecto–The object pointer to look for
Returns
int–Array index or -1 if the object address was not found in this array
See also:  


 
→ top of page
Method insert
Insert the given object into the arraylist.
Signature
insert(intindex,
  Objecto 
  )  
 :boolean
Arguments
intindex–Where to insert the object
Objecto–The object to add. If "o" is a Value object, the contained (deletable) object will be released from the Value container.
Returns
boolean–true if the object has been inserted successfully, false otherwise.
Description

The array will be resized as required.
See also:  


 
→ top of page
Method realloc
Resize array.
Signature
realloc(intmax)
 :boolean
Arguments
intmax–New total number of elements.
Returns
boolean–true if the reallocation succeeded, false otherwise.
Description

Element will be discarded/added as required.
See also:  


 
→ top of page
Method remove
Remove the given object from the arraylist.
Signature
remove(Objecto)
 :boolean
Arguments
Objecto–The object to remove.
Returns
boolean–true if the object has been removed successfully, false otherwise.
Description

The array will be searched for an entry matching the given object address.
See also:  


 
→ top of page
Method reverse
Reverse element order.
Signature
reverse()

 
→ top of page
Method setNumElements
Set the number of used elements.
Signature
setNumElements(intnum)
Arguments
intnum–New number of used elements
Description

This will not reallocate the array.
See also:  


 
→ top of page
Method swap
Swap two array elements.
Signature
swap(intindexA,
  intindexB 
  )  
 :boolean
Arguments
intindexA–Index of first element
intindexB–Index of second element
Returns
boolean–true if the elements have been swapped successfully, false otherwise.

 
→ top of page
Method useAll
Mark all array elements used, i.e. set numElements = maxElements.
Signature
useAll()

 
→ top of page
 
Project Modules:core 
Project Classes:Boolean , Buffer , Byte , Class , ClassArray , Condition , Configuration , Double , Envelope , Event , Exception , File , Float , FloatArray , FloatArray128 , FloatArray16 , FloatArray32 , FloatArray64 , FloatArray8 , Function , HashTable , IntArray , IntArray128 , IntArray16 , IntArray32 , IntArray64 , IntArray8 , Integer , List , ListNode , Long , Mailbox , Mutex , Object , ObjectArray , PakFile , PointerArray , Pool , Script , SharedBuffer , Short , Stack , StdErrStream , StdInStream , StdOutStream , Stream , String , String128 , String16 , String32 , String64 , String8 , StringArray , StringIterator , Thread , Time , TKS , TreeNode , UnsignedByte , UnsignedInteger , UnsignedLong , UnsignedShort , Value , ValueArray , Variable 
Project Functions:ceil , exit , floor , GetCurrentThread , getenv , lcchar , mathAbsMaxf , mathAbsMinf , mathAbsMini , mathAbsMini , mathClampf , mathDistancePointPlane2d , mathLerpf , mathMaxf , mathMaxi , mathMinf , mathMini , mathPowerf , mathPoweri , mathSmoothStepf , mathWrapf , milliSeconds , psystem , putenv , srand , system , ucchar 
All Namespaces:default , ui 
All Projects:core , debugtext , tkfreetype2 , tkmath , tkmidi , tkopengl , tkportaudio , tksdl , tkui , tkunit 

auto-generated by "DOG", the TkScript document generator. Sat, 31/Dec/2011 16:12:18