Skip to content
On this page

class ValueArray

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

See also: Array

Properties

PropertyDescription
AlternativeNameA string that can be used to identify the array in collections. (Inherited from Array)
ItemCountThe 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)
NameThe name of the ValueArray object. (Inherited from Object)
TupleCountThe 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)
TupleSizeThe 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

MethodDescription
AddObserverAdds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
AppendArrayAppends 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)
ClearClears the array and sets the tuple count to 0. Tuple size and name remains the same though. (Inherited from Array)
CompareTuplesCompareTuples 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)
CopyRangeCopyRange 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)
CopyTupleCopyTuple 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)
DeepCopyCopies data from another array. The arrays must have the same underlying data types. (Inherited from Array)
EqualsCompares this array, including all its contents, to another array. (Inherited from Array)
ExtractTuplesExtracts 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)
GetBaseTypeReturns the id of the basic type that the array is based on The ids are listed in the BaseTypes enumeration. (Inherited from Array)
GetClassGet the name of the ValueArray class. (Inherited from Object)
GetMaxItemIdReturns 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)
GetMaxTupleIdReturns 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)
GetRealItemGetRealItem() 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.
IndexedCopyCopies 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)
IsAReturns true if ValueArray is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsEmptyReturns true if the list is empty. (Inherited from Array)
IsNullReturns true if the ValueArray object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the ValueArray object is valid. (Inherited from Object)
NewCopyCreates 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)
NewPackedCopyLike 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)
NonNullReturns true if the ValueArray object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the ValueArray object to the log. (Inherited from Object)
RemoveObserverRemoves a previously added observer object. (Inherited from Object)
SetRealItemSetRealItem() 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

MethodDescription
IsClassAReturns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCastSafeCast 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.

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.

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.

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.

Methods details

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.

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.

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.

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.

DeepCopy

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

Equals

Compares this array, including all its contents, to another 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).

GetBaseType

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

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.

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.

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)