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

Class core.ObjectArray


SynopsisA homogenous array of objects. 

  Base classes:
  Methods: Description:


A template object is used to allocate new objects.

See also:  


 
 top of page
Method add
Add the given object value to this arraylist.
Signature
add(Objecto)
 :boolean
Arguments
ObjectoIf o is of type Value, try to release the object from the value container, add an object reference otherwise.
Returns
booleantrue if the Object has been added, false otherwise.
Description

The array will be reallocated if necessary.
See also:  


 
 top of page
Method alloc
Allocate the given number of array elements.
Signature
alloc(intmax)
 :boolean
Arguments
intmaxNew total number of elements.
Returns
booleantrue if the elements have been allocated successfully, false otherwise.
Description

All previous elements will be discarded. 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
ObjectoThe object to compare with. Object.yacEquals() is used for comparisons.
Returns
booleantrue 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
ObjectoThe object (address) to compare with.
Returns
booleantrue if a matching object was found, false otherwise.
See also:  


 
 top of page
Method delete
Delete the array element at the given index.
Signature
delete(intindex)
 :boolean
Arguments
intindexWhich element to delete
Returns
booleantrue if the element was deleted, false otherwise.
See also:  


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

 
 top of page
Method free
Free all array elements
Signature
free()

 
 top of page
Method get
Return a reference to array element at the given index.
Signature
get(intindex)
 :Object
Arguments
intindexArray index
Returns
ObjectObject reference or null
Description

Silently return null if "index" exceeds the array bounds.
See also:  


 
 top of page
Method getDeref
Return a deletable reference to array elements at the given index.
Signature
getDeref(intindex)
 :Object
Arguments
intindexArray index
Returns
ObjectArray element or null
Description

Silently return null if "index" exceeds the array bounds.
See also:  


 
 top of page
Method getFirst
Return first array element.
Signature
getFirst():Object
Returns
ObjectFirst 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
ObjectLast 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
intTotal number of elements
See also:  


 
 top of page
Method getNextFree
Return a reference to the next free object.
Signature
getNextFree():Object
Returns
ObjectNext free object or null if the array is full.
Description

Increase numElements.
See also:  


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


 
 top of page
Method getString
Return a string representation of this ObjectArray.
Signature
getString():String
Returns
Stringnew String instance that holds a string representation of this ObjectArray

 
 top of page
Method getTemplate
Return the template object that is currently being used for allocations of new objects.
Signature
getTemplate():Object
Returns
ObjectTemplate object to use for allocations
See also:  


 
 top of page
Method indexOfObject
Return the index of the element that equals the given object.
Signature
indexOfObject(Objecto)
 :int
Arguments
ObjectoThe object to look for
Returns
intArray 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
ObjectoThe object pointer to look for
Returns
intArray index or -1 if the object address was not found in this array
See also:  


 
 top of page
Method insert
Insert the given object before the given index.
Signature
insert(intindex,
  Objecto 
  )  
 :boolean
Arguments
intindexWhere to insert the object
ObjectoObject to insert. Similar to add, Value object receive a special treatment.
Returns
booleantrue if the Object was inserted successfully, false otherwise
Description

The array will be reallocated if necessary.
See also:  


 
 top of page
Method realloc
Reallocate array.
Signature
realloc(intmax)
 :boolean
Arguments
intmaxNew total number of elements
Returns
booleantrue if the reallocation succeeded, false otherwise
Description

Discard/add empty elements as required.
See also:  


 
 top of page
Method remove
Delete the first element whose object pointer equals the given pointer.
Signature
remove(Objecto)
 :boolean
Arguments
ObjectoObject (pointer)
Returns
booleantrue if an element matching the given Object address was found and deleted, false otherwise.
See also:  


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

 
 top of page
Method setNumElements
Set the number of used array elements.
Signature
setNumElements(intnum)
Arguments
intnumNew number of elements
See also:  


 
 top of page
Method setTemplate
Set the template object to use for allocation of new array objects.
Signature
setTemplate(Objecttemplate)
Arguments
ObjecttemplateTemplate object to use for allocations
See also:  


 
 top of page
Method swap
Swap two array elements
Signature
swap(intindexA,
  intindexB 
  )  
 :boolean
Arguments
intindexAIndex of first element
intindexBIndex of second element
Returns
booleantrue 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 , DummyStream , 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 , mathClampi , mathDistancePointPlane2d , mathLerpf , mathMaxf , mathMaxi , mathMinf , mathMini , mathPowerf , mathPoweri , mathSmoothStepf , mathWrapf , mathWrapi , 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. Mon, 28/Dec/2015 13:15:54