# `class` ValueArray

ValueArray adds methods to arrays to generically add, set and get tuples, through real values.

# Properties

Property	Description
AlternativeName	A string that can be used to identify the array in collections. (Inherited from Array)
ItemCount	The number of individual items in the array. Warning! Do not confuse this count with the count of tuples, they are only the same if TupleSize is equal to 1, i.e. when the tuples are exactly one component each. Also note that the item count should be a multiple of TupleSize. Note that the total number of items cannot exceed INT_MAX. (Inherited from Array)
Name	The name of the ValueArray object. (Inherited from Object)
TupleCount	The tuple count, meaning how many tuples are in the array. If resized to larger array, the new tuples will not be set to anything. (Inherited from Array)
TupleSize	The tuple size, meaning how many items of the underlying data type is in a tuple. The tuple size must be set before the array is populated. (Inherited from Array)

# Methods

Method	Description
AddObserver	Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
AppendArray	Appends an array to this array. The array must be a descendant of ValueArray. For best performance, append arrays of the same basic type. (Inherited from Array)
Clear	Clears the array and sets the tuple count to 0. Tuple size and name remains the same though. (Inherited from Array)
CompareTuples	CompareTuples compares a tuple in this array with a tuple in another array. Returns 0 if the tuples are identical, 1 if an element in this array tuple in ascending order is larger and -1 if smaller. (Inherited from Array)
CopyRange	CopyRange copies a range of tuples from a source array into this array. The arrays must have the same tuple size and base type. This array must be resized to hold the tuples before copying. The basetypes are listed in EBaseTypes. (Inherited from Array)
CopyTuple	CopyTuple copies one tuple in a source array to a tuple in this array. Both the dest_id and the source_id must exist in the arrays. This array can be used as the source array to copy within the array. (Inherited from Array)
DeepCopy	Copies data from another array. The arrays must have the same underlying data types. (Inherited from Array)
Equals	Compares this array, including all its contents, to another array. (Inherited from Array)
ExtractTuples	Extracts tuples from the array. Note that the destination array must have the same classtype and have the same tuple size as the source array. (If both arrays are decendants of ValueArray, they can be of different types, but the conversion is slow). (Inherited from Array)
GetBaseType	Returns the id of the basic type that the array is based on The ids are listed in the BaseTypes enumeration. (Inherited from Array)
GetClass	Get the name of the ValueArray class. (Inherited from Object)
GetMaxItemId	Returns the id of the last item that is in the array. The id returned is equal to (ItemCount - 1). Warning! Do not confuse this id with the id of a tuple, they are only the same if TupleSize is equal to one, i.e. when the tuples are exactly one component each. (Inherited from Array)
GetMaxTupleId	Returns the id of the tuple last in the list. If the array is empty, the value is unspecified. Note: GetMaxTupleId() always returns (GetTupleCount()-1) as a signed id. (Inherited from Array)
GetRealItem	GetRealItem() retrieves the item at position id. The id is the id of the item, not the tuple the item belongs to. GetRealItem() converts the value from the actual underlying data type to a real.
IndexedCopy	Copies tuples from a source array through an id table. The id table dictates the order in which the tuples are to be copied to this array. E.g. If the first item in the id table has the value 14, then the tuple with id 14 in the source array will be copied to the first tuple in this array. Note: All ids in the id table must be valid ids of tuples in the source array. The id table is assumed to have a tuple size of 1. The source array and this array must have the same underlying data type, and have the same tuple size. The array must be large enough to hold the copied data. (Inherited from Array)
IsA	Returns true if ValueArray is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsEmpty	Returns true if the list is empty. (Inherited from Array)
IsNull	Returns true if the ValueArray object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the ValueArray object is valid. (Inherited from Object)
NewCopy	Creates a new array with the same underlying data type, size and tuple settings as this array. To also copy the actual data, set copy_data to true. (Inherited from Array)
NewPackedCopy	Like NewCopy, NewPackedCopy creates an array with the same underlying data and tuple settings as the source array. However, NewPackedCopy only copies unique tuples, and if the index_array parameter is set, this index array will contain the same number of tuples as the source array, and with the ids of a specific tuples within the new copy of the array. (Inherited from Array)
NonNull	Returns true if the ValueArray object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the ValueArray object to the log. (Inherited from Object)
RemoveObserver	Removes a previously added observer object. (Inherited from Object)
SetRealItem	SetRealItem() sets the item at position id. The id is the id of the item, not the tuple the item belongs to. SetRealItem() converts the value from real to the actual underlying data type.

# Static methods

Method	Description
IsClassA	Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCast	SafeCast makes sure the input object is of a class that can be cast into spValueArray, and if this is the case, returns the object cast into spValueArray. (Inherited from Object)

# Properties details

# AlternativeName

A string that can be used to identify the array in collections.

Type	Name	Min	Max	Description
`const char *`	value			The new alternative name.

Type	Name	Min	Max	Description
`string`	value			The new alternative name.

Name	Type	Min	Max	Description
value	`str`			The new alternative name.

# ItemCount

The number of individual items in the array. Warning! Do not confuse this count with the count of tuples, they are only the same if TupleSize is equal to 1, i.e. when the tuples are exactly one component each. Also note that the item count should be a multiple of TupleSize. Note that the total number of items cannot exceed INT_MAX.

Type	Name	Min	Max	Description
`unsigned int`	value	1	INT_MAX	The desired item count.

Type	Name	Min	Max	Description
`uint`	value	1	INT_MAX	The desired item count.

Name	Type	Min	Max	Description
value	`int`	1	INT_MAX	The desired item count.

# Name

The name of the ValueArray object. (Inherited from Object)

Type	Name	Min	Max	Description
`const char *`	name			New name of the object.

Type	Name	Min	Max	Description
`string`	name			New name of the object.

Name	Type	Min	Max	Description
name	`str`			New name of the object.

# TupleCount

The tuple count, meaning how many tuples are in the array. If resized to larger array, the new tuples will not be set to anything.

Type	Name	Min	Max	Description
`unsigned int`	value	1	INT_MAX	The desired tuple count.

Type	Name	Min	Max	Description
`uint`	value	1	INT_MAX	The desired tuple count.

Name	Type	Min	Max	Description
value	`int`	1	INT_MAX	The desired tuple count.

# TupleSize

The tuple size, meaning how many items of the underlying data type is in a tuple. The tuple size must be set before the array is populated.

Type	Name	Min	Max	Description
`unsigned int`	value	1	1024	The desired tuple size.

Type	Name	Min	Max	Description
`uint`	value	1	1024	The desired tuple size.

Name	Type	Min	Max	Description
value	`int`	1	1024	The desired tuple size.

# Methods details

# AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

Type	Name	Min	Max	Description
`Observer`	observer			Observer is the object that will receive events.

Type	Name	Min	Max	Description
`Observer`	observer			Observer is the object that will receive events.

Name	Type	Min	Max	Description
observer	`Observer`			Observer is the object that will receive events.

# AppendArray

Appends an array to this array. The array must be a descendant of ValueArray. For best performance, append arrays of the same basic type.

Type	Name	Min	Max	Description
`Array`	source			The array to append to this array.

Type	Name	Min	Max	Description
`Array`	source			The array to append to this array.

Name	Type	Min	Max	Description
source	`Array`			The array to append to this array.

# Clear

Clears the array and sets the tuple count to 0. Tuple size and name remains the same though.

# CompareTuples

CompareTuples compares a tuple in this array with a tuple in another array. Returns 0 if the tuples are identical, 1 if an element in this array tuple in ascending order is larger and -1 if smaller.

Type	Name	Min	Max	Description
`Array`	otherArray			The other array to compare with.
`rid`	tupleId	0	MaxTupleId	The tuple from this array to use for comparison.
`rid`	otherTupleId	0		The tuple from the other array to use for comparison.

Type	Name	Min	Max	Description
`Array`	otherArray			The other array to compare with.
`int`	tupleId	0	MaxTupleId	The tuple from this array to use for comparison.
`int`	otherTupleId	0		The tuple from the other array to use for comparison.

Name	Type	Min	Max	Description
otherArray	`Array`			The other array to compare with.
tupleId	`int`	0	MaxTupleId	The tuple from this array to use for comparison.
otherTupleId	`int`	0		The tuple from the other array to use for comparison.

# CopyRange

CopyRange copies a range of tuples from a source array into this array. The arrays must have the same tuple size and base type. This array must be resized to hold the tuples before copying. The basetypes are listed in EBaseTypes.

Type	Name	Description
`Array`	sourceArray	The source array to copy from.
`rid`	startDestId	The first destination tuple id.
`rid`	startSrcId	The first source tuple id.
`unsigned int`	count	The number of tuples to copy.

Type	Name	Description
`Array`	sourceArray	The source array to copy from.
`int`	startDestId	The first destination tuple id.
`int`	startSrcId	The first source tuple id.
`uint`	count	The number of tuples to copy.

Name	Type	Description
sourceArray	`Array`	The source array to copy from.
startDestId	`int`	The first destination tuple id.
startSrcId	`int`	The first source tuple id.
count	`int`	The number of tuples to copy.

# CopyTuple

CopyTuple copies one tuple in a source array to a tuple in this array. Both the dest_id and the source_id must exist in the arrays. This array can be used as the source array to copy within the array.

Type	Name	Min	Max	Description
`Array`	sourceArray			The source array to copy from.
`rid`	destId	0	MaxTupleId	The tuple index in this array to copy into.
`rid`	srcId	0		The tuple index in the source array to copy from.

Type	Name	Min	Max	Description
`Array`	sourceArray			The source array to copy from.
`int`	destId	0	MaxTupleId	The tuple index in this array to copy into.
`int`	srcId	0		The tuple index in the source array to copy from.

Name	Type	Min	Max	Description
sourceArray	`Array`			The source array to copy from.
destId	`int`	0	MaxTupleId	The tuple index in this array to copy into.
srcId	`int`	0		The tuple index in the source array to copy from.

# DeepCopy

Copies data from another array. The arrays must have the same underlying data types.

Type	Name	Min	Max	Description
`Array`	source			The source array to copy from.

Type	Name	Min	Max	Description
`Array`	source			The source array to copy from.

Name	Type	Min	Max	Description
source	`Array`			The source array to copy from.

# Equals

Compares this array, including all its contents, to another array.

Type	Name	Min	Max	Description
`Array`	other			The other array to compare against.

Type	Name	Min	Max	Description
`Array`	other			The other array to compare against.

Name	Type	Min	Max	Description
other	`Array`			The other array to compare against.

# ExtractTuples

Extracts tuples from the array. Note that the destination array must have the same classtype and have the same tuple size as the source array. (If both arrays are decendants of ValueArray, they can be of different types, but the conversion is slow).

Type	Name	Min	Max	Description
`Array`	dest			The array that will store the extracted tuples.
`rid`	start	0	MaxTupleId	This array tuple index where the extraction starts.
`unsigned int`	count		INT_MAX	The number of tuples to extract.

Type	Name	Min	Max	Description
`Array`	dest			The array that will store the extracted tuples.
`int`	start	0	MaxTupleId	This array tuple index where the extraction starts.
`uint`	count		INT_MAX	The number of tuples to extract.

Name	Type	Min	Max	Description
dest	`Array`			The array that will store the extracted tuples.
start	`int`	0	MaxTupleId	This array tuple index where the extraction starts.
count	`int`		INT_MAX	The number of tuples to extract.

# GetBaseType

Returns the id of the basic type that the array is based on The ids are listed in the BaseTypes enumeration.

Key	Value	Comment
TYPES_ID_VOID	0
TYPES_ID_BOOL	1
TYPES_ID_CHAR	2
TYPES_ID_UCHAR	3
TYPES_ID_SHORT	4
TYPES_ID_USHORT	5
TYPES_ID_INT	6
TYPES_ID_UINT	7
TYPES_ID_LONG	8
TYPES_ID_ULONG	9
TYPES_ID_FLOAT	10
TYPES_ID_DOUBLE	11
TYPES_ID_REAL	12
TYPES_ID_RID	13
TYPES_ID_RCHAR	14
TYPES_ID_RHANDLE	15
TYPES_ID_STRING	16
TYPES_ID_OBJECT	17

Key	Value	Comment
TYPES_ID_VOID	0
TYPES_ID_BOOL	1
TYPES_ID_CHAR	2
TYPES_ID_UCHAR	3
TYPES_ID_SHORT	4
TYPES_ID_USHORT	5
TYPES_ID_INT	6
TYPES_ID_UINT	7
TYPES_ID_LONG	8
TYPES_ID_ULONG	9
TYPES_ID_FLOAT	10
TYPES_ID_DOUBLE	11
TYPES_ID_REAL	12
TYPES_ID_RID	13
TYPES_ID_RCHAR	14
TYPES_ID_RHANDLE	15
TYPES_ID_STRING	16
TYPES_ID_OBJECT	17

Key	Value	Comment
EBaseTypes_TYPES_ID_VOID	0
EBaseTypes_TYPES_ID_BOOL	1
EBaseTypes_TYPES_ID_CHAR	2
EBaseTypes_TYPES_ID_UCHAR	3
EBaseTypes_TYPES_ID_SHORT	4
EBaseTypes_TYPES_ID_USHORT	5
EBaseTypes_TYPES_ID_INT	6
EBaseTypes_TYPES_ID_UINT	7
EBaseTypes_TYPES_ID_LONG	8
EBaseTypes_TYPES_ID_ULONG	9
EBaseTypes_TYPES_ID_FLOAT	10
EBaseTypes_TYPES_ID_DOUBLE	11
EBaseTypes_TYPES_ID_REAL	12
EBaseTypes_TYPES_ID_RID	13
EBaseTypes_TYPES_ID_RCHAR	14
EBaseTypes_TYPES_ID_RHANDLE	15
EBaseTypes_TYPES_ID_STRING	16
EBaseTypes_TYPES_ID_OBJECT	17

# GetClass

Get the name of the ValueArray class. (Inherited from Object)

# GetMaxItemId

Returns the id of the last item that is in the array. The id returned is equal to (ItemCount - 1). Warning! Do not confuse this id with the id of a tuple, they are only the same if TupleSize is equal to one, i.e. when the tuples are exactly one component each.

# GetMaxTupleId

Returns the id of the tuple last in the list. If the array is empty, the value is unspecified. Note: GetMaxTupleId() always returns (GetTupleCount()-1) as a signed id.

# GetRealItem

GetRealItem() retrieves the item at position id. The id is the id of the item, not the tuple the item belongs to. GetRealItem() converts the value from the actual underlying data type to a real.

Type	Name	Min	Max	Description
`rid`	id	0	MaxItemId	The item to get.

Type	Name	Min	Max	Description
`int`	id	0	MaxItemId	The item to get.

Name	Type	Min	Max	Description
id	`int`	0	MaxItemId	The item to get.

# IndexedCopy

Copies tuples from a source array through an id table. The id table dictates the order in which the tuples are to be copied to this array. E.g. If the first item in the id table has the value 14, then the tuple with id 14 in the source array will be copied to the first tuple in this array. Note: All ids in the id table must be valid ids of tuples in the source array. The id table is assumed to have a tuple size of 1. The source array and this array must have the same underlying data type, and have the same tuple size. The array must be large enough to hold the copied data.

Type	Name	Description
`Array`	source	The array from which to copy tuples.
RidArray	idtable	The array with the tuple indices to copy.
`rid`	startId	The first tuple that will receive the copied values.

Type	Name	Description
`Array`	source	The array from which to copy tuples.
RidArray	idtable	The array with the tuple indices to copy.
`int`	startId	The first tuple that will receive the copied values.

# IsA

Returns true if ValueArray is a or is a descendant of the class named as the type parameter. (Inherited from Object)

# IsEmpty

Returns true if the list is empty.

# IsNull

Returns true if the ValueArray object is invalid. (Inherited from Object)

# IsSameObjectAs

Returns true if the ValueArray object is valid. (Inherited from Object)

# NewCopy

Creates a new array with the same underlying data type, size and tuple settings as this array. To also copy the actual data, set copy_data to true.

# NewPackedCopy

Like NewCopy, NewPackedCopy creates an array with the same underlying data and tuple settings as the source array. However, NewPackedCopy only copies unique tuples, and if the index_array parameter is set, this index array will contain the same number of tuples as the source array, and with the ids of a specific tuples within the new copy of the array.

# NonNull

Returns true if the ValueArray object is valid. (Inherited from Object)

# PrintInfo

Prints the content/info of the ValueArray object to the log. (Inherited from Object)

# RemoveObserver

Removes a previously added observer object. (Inherited from Object)

# SetRealItem

SetRealItem() sets the item at position id. The id is the id of the item, not the tuple the item belongs to. SetRealItem() converts the value from real to the actual underlying data type.

# Static methods details

# IsClassA

Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)

# SafeCast

SafeCast makes sure the input object is of a class that can be cast into spValueArray, and if this is the case, returns the object cast into spValueArray. (Inherited from Object)

← UnsignedShortArray FieldData →

Type	Name	Min	Max	Description
`rid`	id	0	MaxItemId	The item to set.
`real`	value			The real value to set the item to.

# class ValueArray