→ home

→ index of namespace default

→ index of project core

→ index of module core

Class `core.ClassArray`

Synopsis: Array of scriptclass instances.

Base classes:

core.Object

Methods:

add(Class c) : boolean - Add the given scriptclass instance to this array.
alloc(int max) : boolean - Allocate the given number of array elements.
contains(Class c) : boolean - Check whether this array contains a scriptclass instance that equals the given object.
containsObject(Object o) : boolean - Check whether array contains an object that equals the given object.
containsPointer(Object o) : boolean - Check whether array contains the given object address.
delete(int index) : boolean - Delete the given array element.
empty() - Reset number of used elements, numElements, to 0.
free() - Free array elements.
get(int index) : Class - Return the given array element.
getDeref(int index) : Class - Unlink and return the given (deletable) array element.
getMaxElements() : int - Return total number of elements.
getNextFree() : Class - Return next free element.
getNumElements() : int - Return number of used elements.
getTemplate() : Class - Return the template object that is currently being used to allocate new array elements.
indexOfObject(Object o) : int - Return the index of the element that equals the given object.
indexOfPointer(Object o) : int - Return the index of the element that points to the given object.
insert(int index, Class c) : boolean - Insert the given scriptclass instance into the array.
realloc(int max) : boolean - Reallocate array elements.
remove(Class c) : boolean - Delete the first element whose pointer equals the given scriptclass instance.
reverse() - Reverse element order.
setNumElements(int num) - Set number of used elements.
setTemplate(Class sci) - Set the template object that shall be used to allocate new array elements.
swap(int indexA, indexB) : boolean - Swap two array elements.
useAll() - Mark all array elements used, i.e. set numElements = maxElements.

See also:

Class

Method add

Add the given scriptclass instance to this array.

Signature

add	(	Class	c	)
	:	boolean

Arguments

Class c – Scriptclass instance to add. If c is a Value object, try to release the scriptclass instance pointer from the value container.

Returns

boolean

–

true if the scriptclass instance has been added successfully, false otherwise.

Description

The array will be resized if necessary.

See also:

→ top of page

Method alloc

Allocate the given number of array elements.

Signature

alloc	(	int	max	)
	:	boolean

Arguments

int

max

–

Total number of elements.

Returns

boolean

–

true if the allocation succeeded, false otherwise.

Description

The number of used element, numElements, will be reset to 0.

See also:

→ top of page

Method contains

Check whether this array contains a scriptclass instance that equals the given object.

Signature

contains	(	Class	c	)
	:	boolean

Arguments

Class

–

Scriptclass instance to compare to

Returns

boolean

–

true if the given scriptclass instance was found, false otherwise.

→ top of page

Method containsObject

Check whether array contains an object that equals the given object.

Signature

containsObject	(	Object	o	)
	:	boolean

Arguments

Object o – The object to compare with. Object.yacEquals() is used for comparisons.

Returns

boolean

–

true if a matching object was found, false otherwise.

See also:

indexOfObject()

→ top of page

Method containsPointer

Check whether array contains the given object address.

Signature

containsPointer	(	Object	o	)
	:	boolean

Arguments

Object

–

The object (address) to compare with.

Returns

boolean

–

true if a matching object was found, false otherwise.

See also:

indexOfPointer()

→ top of page

Method delete

Delete the given array element.

Signature

delete	(	int	index	)
	:	boolean

Arguments

int

index

–

Which element to delete

Returns

boolean

–

true if the given element has been deleted successfully, false otherwise.

See also:

→ top of page

Method empty

Reset number of used elements, numElements, to 0.

Signature

empty

(

)

See also:

→ top of page

Method free

Free array elements.

Signature

free

(

)

See also:

→ top of page

Method get

Return the given array element.

Signature

get	(	int	index	)
	:	Class

Arguments

int

index

–

Which element to return

Returns

Class

–

Scriptclass instance

Description

Silently return null if "index" is out of bounds.

See also:

getDeref()

→ top of page

Method getDeref

Unlink and return the given (deletable) array element.

Signature

getDeref	(	int	index	)
	:	Class

Arguments

int

index

–

Which element to return

Returns

Class

–

(deletable) Scriptclass instance

See also:

get()

→ top of page

Method getMaxElements

Return total number of elements.

Signature

getMaxElements

(

)

int

Returns

int

–

Total number of elements.

See also:

→ top of page

Method getNextFree

Return next free element.

Signature

getNextFree

(

)

Class

Returns

Class

–

next free Class instance or null if the arraylist is full.

Description

Increase the number of used elements, numElements.

See also:

→ top of page

Method getNumElements

Return number of used elements.

Signature

getNumElements

(

)

int

Returns

int

–

Number of used elements

See also:

→ top of page

Method getTemplate

Return the template object that is currently being used to allocate new array elements.

Signature

getTemplate

(

)

Class

Returns

Class

–

Scriptclass (instance)

See also:

setTemplate()

→ top of page

Method indexOfObject

Return the index of the element that equals the given object.

Signature

indexOfObject	(	Object	o	)
	:	int

Arguments

Object

–

The object to look for

Returns

int

–

Array index or -1 if no matching object was found in this array

See also:

containsObject()

→ top of page

Method indexOfPointer

Return the index of the element that points to the given object.

Signature

indexOfPointer	(	Object	o	)
	:	int

Arguments

Object

–

The object pointer to look for

Returns

int

–

Array index or -1 if the object address was not found in this array

See also:

containsPointer()

→ top of page

Method insert

Insert the given scriptclass instance into the array.

Signature

insert	(	int	index	,
		Class	c
		)
	:	boolean

Arguments

int	index	–	Where to insert the scriptclass instance
Class	c	–	Scriptclass instance to insert. If c is a `Value` object, try to release the scriptclass instance pointer from the value container.

Returns

boolean

–

true if the scriptclassinstance has been inserted successfully, false otherwise.

See also:

→ top of page

Method realloc

Reallocate array elements.

Signature

realloc	(	int	max	)
	:	boolean

Arguments

int

max

–

Total number of elements

Returns

boolean

–

true if the reallocation succeeded, false otherwise.

Description

Discard/add new elements as required.

See also:

→ top of page

Method remove

Delete the first element whose pointer equals the given scriptclass instance.

Signature

remove	(	Class	c	)
	:	boolean

Arguments

Class

–

Scriptclass instance pointer to look for.

Returns

boolean

–

true if the given pointer was found and the corresponding array element has been removed, false otherwise.

→ top of page

Method reverse

Reverse element order.

Signature

reverse

(

)

→ top of page

Method setNumElements

Set number of used elements.

Signature

setNumElements

(

int

num

)

Arguments

int

num

–

New number of used elements.

See also:

→ top of page

Method setTemplate

Set the template object that shall be used to allocate new array elements.

Signature

setTemplate

(

Class

sci

)

Arguments

Class

sci

–

See also:

getTemplate()

→ top of page

Method swap

Swap two array elements.

Signature

swap	(	int	indexA	,
		int	indexB
		)
	:	boolean

Arguments

int	indexA	–	Index of first array element
int	indexB	–	index of second array 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` , `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

Class core.ClassArray

Class `core.ClassArray`