# class ValueArray

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

See also: Array

# Properties

# Methods

# Static methods

# Properties details

# AlternativeName

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

// Setter
void SetAlternativeName( const char * value );

// Getter
spString GetAlternativeName();

// Setter
void SetAlternativeName(string value);

// Getter
string GetAlternativeName();

# Setter
None SetAlternativeName(value: str)

# Getter
str GetAlternativeName()

# 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 cannotexceed INT_MAX.

// Setter
void SetItemCount( unsigned int value );

// Getter
unsigned int GetItemCount();

// Setter
void SetItemCount(uint value);

// Getter
uint GetItemCount();

# Setter
None SetItemCount(value: int)

# Getter
int GetItemCount()

# 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.

// Setter
void SetTupleCount( unsigned int value );

// Getter
unsigned int GetTupleCount();

// Setter
void SetTupleCount(uint value);

// Getter
uint GetTupleCount();

# Setter
None SetTupleCount(value: int)

# Getter
int GetTupleCount()

# 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.

// Setter
void SetTupleSize( unsigned int value );

// Getter
unsigned int GetTupleSize();

// Setter
void SetTupleSize(uint value);

// Getter
uint GetTupleSize();

# Setter
None SetTupleSize(value: int)

# Getter
int GetTupleSize()

# Methods details

# 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.

void AppendArray( spArray source );

void AppendArray(spArray source);

None AppendArray(source: spArray)

# Clear

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

void Clear();

void Clear();

None Clear()

# 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.

int CompareTuples( spArray otherArray , rid tuple_id , rid other_tuple_id );

int CompareTuples(spArray otherArray, rid tuple_id, rid other_tuple_id);

int CompareTuples(otherArray: spArray, tuple_id: int, other_tuple_id: int)

# 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.

void CopyRange( spArray source_array , rid start_dest_id , rid start_src_id , unsigned int count );

void CopyRange(spArray source_array, rid start_dest_id, rid start_src_id, uint count);

None CopyRange(source_array: spArray, start_dest_id: int, start_src_id: int, count: int)

# 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.

void CopyTuple( spArray sourceArray , rid dest_id , rid src_id );

void CopyTuple(spArray sourceArray, rid dest_id, rid src_id);

None CopyTuple(sourceArray: spArray, dest_id: int, src_id: int)

# DeepCopy

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

void DeepCopy( spArray source );

void DeepCopy(spArray source);

None DeepCopy(source: spArray)

# 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).

void ExtractTuples( spArray dest , rid start , unsigned int count );

void ExtractTuples(spArray dest, rid start, uint count);

None ExtractTuples(dest: spArray, start: int, count: int)

# GetBaseType

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

Simplygon::EBaseTypes GetBaseType();

 GetBaseType();

EBaseTypes_* GetBaseType()

# GetClass

Get the name of the ValueArray class.

spString GetClass();

string GetClass();

str GetClass()

# 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.

rid GetMaxItemId();

rid GetMaxItemId();

int GetMaxItemId()

# 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.

rid GetMaxTupleId();

rid GetMaxTupleId();

int GetMaxTupleId()

# 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.

real GetRealItem( rid id );

float GetRealItem(rid id);

float GetRealItem(id: int)

# 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.

void IndexedCopy( spArray source , spRidArray idtable , rid startId );

void IndexedCopy(spArray source, spRidArray idtable, rid startId);

None IndexedCopy(source: spArray, idtable: spRidArray, startId: int)

# IsA

Returns true if ValueArray is a or is a descendant of the class named as the type parameter.

bool IsA( const char * type );

bool IsA(string type);

bool IsA(type: str)

# IsEmpty

Returns true if the list is empty.

bool IsEmpty();

bool IsEmpty();

bool IsEmpty()

# IsNull

Returns true if the ValueArray object is invalid.

bool IsNull();

bool IsNull();

bool IsNull()

# 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.

spArray NewCopy( bool copy_data );

spArray NewCopy(bool copy_data);

spArray NewCopy(copy_data: bool)

# 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.

spArray NewPackedCopy( spRidArray index_array );

spArray NewPackedCopy(spRidArray index_array);

spArray NewPackedCopy(index_array: spRidArray)

# 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.

void SetRealItem( rid id , real value );

void SetRealItem(rid id, float value);

None SetRealItem(id: int, value: float)

# Static methods details

# IsClassA

Returns true if the class is a or is a descendant of the class named as the type parameter.

static bool IsClassA( const char * type );

static bool IsClassA(string type);

@staticmethod
bool IsClassA(type: str)

# 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.

static spValueArray SafeCast( spObject object );

static spValueArray SafeCast(spObject object);

@staticmethod
spValueArray SafeCast(object: spObject)