FSDK.UInt32Array Class Reference

Public Member Functions
	Add (new_element)
	Add an element at the tail. Potentially growing the array. More...
	constructor ()
	Constructor.
	Find (data, start)
	Find an element from specified position to last. More...
	GetAt (index)
	This method retrieves an element specified by an index number. More...
	GetSize ()
	Get the number of elements in the array. More...
	InsertAt (index, new_element, count)
	Inset one or more continuous element at specified position. More...
	InsertAt (start_index, new_array)
	Inset an array at specified position. More...
	RemoveAll ()
	Clean up the array. More...
	RemoveAt (index, count)
	Remove a number of elements at specified position. More...
	SetAt (index, new_element)
	This method overwrites an element specified by an index number. More...
	SetAtGrow (index, new_element)
	Set an element value at specified position. Potentially growing the array. More...

Member Function Documentation

Add()

FSDK.UInt32Array.Add (   new_element )

inline

Add an element at the tail. Potentially growing the array.

Parameters

[in]

new_element

The input element.

Returns

true means success, while false means failure (such as memory error).

Find()

FSDK.UInt32Array.Find (   data,   start  )

inline

Find an element from specified position to last.

Parameters

[in]	data	The input element.
[in]	start	Specifies the zero-based index of start element to find.

Returns

An index of the found element. -1 means found none.

GetAt()

FSDK.UInt32Array.GetAt (   index )

inline

This method retrieves an element specified by an index number.

Parameters

[in]

index

Specifies the zero-based index of the element.

Returns

An element.

GetSize()

FSDK.UInt32Array.GetSize ( )

inline

Get the number of elements in the array.

Returns

The number of elements in the array.Get the upper bound in the array, actually the maximum valid index.

The upper bound.Change the allocated size and the grow amount.

Parameters

[in]	new_size	The new size in elements expected.
[in]	grow_by	The grow amount in elements expected. This can be -1 for the grow amount unchanged.

Returns

true means success, while false means failure (such as parameter or memory error).

InsertAt() [1/2]

FSDK.UInt32Array.InsertAt (   index,   new_element,   count  )

inline

Inset one or more continuous element at specified position.

Parameters

[in]	index	Specifies the zero-based index in the array.
[in]	new_element	Specifies the element value to insert.
[in]	count	Specifies the count of the element to insert.

Returns

true means success, while false means failure (such as parameter or memory error).

InsertAt() [2/2]

FSDK.UInt32Array.InsertAt (   start_index,   new_array  )

inline

Inset an array at specified position.

Parameters

[in]	start_index	Specifies the zero-based index of start element to insert at.
[in]	new_array	The input array.

Returns

true means success, while false means failure (such as parameter or memory error).

RemoveAll()

FSDK.UInt32Array.RemoveAll ( )

inline

Clean up the array.

Returns

None.

RemoveAt()

FSDK.UInt32Array.RemoveAt (   index,   count  )

inline

Remove a number of elements at specified position.

Parameters

[in]	index	Specifies the zero-based index in the array.
[in]	count	Specifies the count of element to remove.

Returns

true means success, while false means failure (such as parameter or memory error).

SetAt()

FSDK.UInt32Array.SetAt (   index,   new_element  )

inline

This method overwrites an element specified by an index number.

Parameters

[in]	index	Specifies the zero-based index of the element.
[in]	new_element	An element.

Returns

true means success, while false means failure.

SetAtGrow()

FSDK.UInt32Array.SetAtGrow (   index,   new_element  )

inline

Set an element value at specified position. Potentially growing the array.

Parameters

[in]	index	Specifies the zero-based index of element in the array.
[in]	new_element	The input element.

Returns

true means success, while false means failure.