ValueArray class. More...

Inheritance diagram for STSValueArray:

Collaboration diagram for STSValueArray:

Instance Methods

(void) - get:value:

Get a Value from the array. More...

(void) - setAt:value:

Set a Value to a specific array position. More...

(void) - set:

Set a Value to the whole array. More...

(void) - makeNull

Sets the attribute array to Null. More...

(int) - size

Returns the array size.

(void) - setDouble:

Set all the values of this double array. More...

(void) - setDoubleRange:values:

Set a subset of the values of this double array. More...

(void) - setInteger:

Set all the values of this int array. More...

(void) - setIntegerRange:values:

Set a subset of the values of this int array. More...

(void) - setLong:

Set all the values of this long array. More...

(void) - setLongRange:values:

Set a subset of the values of this long array. More...

(void) - setBoolean:

Set all the values of this bool array. More...

(void) - setBooleanRange:values:

Set a subset of the values of this bool array. More...

(void) - setTimestamp:

Set all the values of this timestamp array. More...

(void) - setTimestampRange:values:

Set a subset of the values of this timestamp array. More...

(void) - setOid:

Set all the values of this oid array. More...

(void) - setOidRange:values:

Set a subset of the values of this oid array. More...

(NSArray *) - getDouble

Get all the Values from this double array. More...

(NSArray *) - getDoubleRange:size:

Get a subset of the Values from this double array. More...

(NSArray *) - getInteger

Get all the values from this int array

Exceptions

AppError	If the ValueArray is not available
UnsupportedOperationError	If array DataType is not int.

(NSArray *) - getIntegerRange:size:

Get a subset of the values from this int array. More...

(NSArray *) - getLong

Get all the values from this long array

Exceptions

AppError	If the ValueArray is not available
UnsupportedOperationError	If array DataType is not long.

(NSArray *) - getBoolean

Get all the values from this bool array

Exceptions

AppError	If the ValueArray is not available
UnsupportedOperationError	If array DataType is not bool.

(NSArray *) - getTimestamp

Get all the values from this timestamp array

Exceptions

AppError	If the ValueArray is not available
UnsupportedOperationError	If array DataType is not timestamp.

(NSArray *) - getOid

Get all the values from this oid array

Exceptions

AppError	If the ValueArray is not available
UnsupportedOperationError	If array DataType is not oid.

(void) - close

Closes the ValueArray instance. More...

(BOOL) - isClosed

Check if the ValueArray instance is closed.

Detailed Description

ValueArray class.

It allows for getting and setting ValueArray attribute values.

It is very important to close the ValueArray once no more get or set operations will be performed.

Creation of a new ValueArray: (i) Set all the ValueArray elements using Graph::SetAttributeArray (ii) perform as many get/set operations as you need to the ValueArray instance. Lastly, (iii) Close the ValueArray

Use of an existing ValueArray: (i) Get a ValueArray instance using Graph::GetAttributeArray (ii) perform as many get/set operations as you need to the ValueArray instance. Lastly, (iii) Close the ValueArray

Check out the 'Attributes and values' section in the SPARKSEE User Manual for more details on this.

Author: Sparsity Technologies http://www.sparsity-technologies.com

Method Documentation

- (void) close

Closes the ValueArray instance.

It must be called to ensure the integrity of all data.

- (void) get:	(int)	index
value:	(STSValue *)	value

Get a Value from the array.

AppErrorIf the ValueArray is not available

Parameters

index	[in] Position of the element to get [0..N-1]
value	[out] Value to get the array element

Exceptions

System.ArgumentException	If the index is out of range or the Value not valid
System.ApplicationException	null

- (NSArray*) getDouble

Get all the Values from this double array.

Returns: Returns all the array values

- (NSArray*) getDoubleRange:	(int)	index
size:	(int)	size

Get a subset of the Values from this double array.

Parameters

index	[in] Position of the first element to get [0..N-1]
size	[in] Number of elements to get [1..N]

Returns: Returns the array values in the selected range

- (NSArray*) getIntegerRange:	(int)	index
size:	(int)	size

Get a subset of the values from this int array.

Parameters

index	[in] Position of the first element to get [0..N-1]
size	[in] Number of elements to get [1..N]

Exceptions

WrongArgumentError	If the index or size is out of range
UnsupportedOperationError	If array DataType is not int
AppError	If the ValueArray is not available

- (void) makeNull

Sets the attribute array to Null.

The ValueArray can not be used after this call.

Exceptions

System.ApplicationException null

- (void) set: (STSValue *) value

Set a Value to the whole array.

AppErrorIf the ValueArray is not available

Parameters

value [in] Value to set in all the array elements

Exceptions

System.ArgumentException	If the Value is not valid
System.ApplicationException	null

- (void) setAt:	(int)	index
value:	(STSValue *)	value

Set a Value to a specific array position.

AppErrorIf the ValueArray is not available

Parameters

index	[in] Position of the element to set [0..N-1]
value	[in] Value to set in the array element

Exceptions

System.ArgumentException	If the index is out of range or the Value not valid
System.ApplicationException	null

- (void) setBoolean: (NSArray *) values

Set all the values of this bool array.

AppErrorIf the ValueArray is not available

Parameters

values [in] All the values to set

Exceptions

System.ApplicationException	null
System.ApplicationException	If array DataType is not bool

- (void) setBooleanRange:	(int)	index
values:	(NSArray *)	values

Set a subset of the values of this bool array.

UnsupportedOperationErrorIf array DataType is not bool AppErrorIf the ValueArray is not available

Parameters

index	[in] Position of the first element to set [0..N-1]
values	[in] All the values to set

Exceptions

System.ApplicationException	null
System.ArgumentException	If the index or size is out of range
System.ApplicationException	null

- (void) setDouble: (NSArray *) values

Set all the values of this double array.

AppErrorIf the ValueArray is not available

Parameters

values [in] All the values to set

Exceptions

System.ApplicationException	null
System.ApplicationException	If array DataType is not Double

- (void) setDoubleRange:	(int)	index
values:	(NSArray *)	values

Set a subset of the values of this double array.

UnsupportedOperationErrorIf array DataType is not Double AppErrorIf the ValueArray is not available

Parameters

index	[in] Position of the first element to set [0..N-1]
values	[in] All the values to set

Exceptions

System.ApplicationException	null
System.ArgumentException	If the index or size is out of range
System.ApplicationException	null

- (void) setInteger: (NSArray *) values

Set all the values of this int array.

AppErrorIf the ValueArray is not available

Parameters

values [in] All the values to set

Exceptions

System.ApplicationException	null
System.ApplicationException	If array DataType is not int

- (void) setIntegerRange:	(int)	index
values:	(NSArray *)	values

Set a subset of the values of this int array.

UnsupportedOperationErrorIf array DataType is not int AppErrorIf the ValueArray is not available

Parameters

index	[in] Position of the first element to set [0..N-1]
values	[in] All the values to set

Exceptions

System.ApplicationException	null
System.ArgumentException	If the index or size is out of range
System.ApplicationException	null

- (void) setLong: (NSArray *) values

Set all the values of this long array.

AppErrorIf the ValueArray is not available

Parameters

values [in] All the values to set

Exceptions

System.ApplicationException	null
System.ApplicationException	If array DataType is not long

- (void) setLongRange:	(int)	index
values:	(NSArray *)	values

Set a subset of the values of this long array.

UnsupportedOperationErrorIf array DataType is not long AppErrorIf the ValueArray is not available

Parameters

index	[in] Position of the first element to set [0..N-1]
values	[in] All the values to set

Exceptions

System.ApplicationException	null
System.ArgumentException	If the index or size is out of range
System.ApplicationException	null

- (void) setOid: (NSArray *) values

Set all the values of this oid array.

AppErrorIf the ValueArray is not available

Parameters

values [in] All the values to set

Exceptions

System.ApplicationException	null
System.ApplicationException	If array DataType is not oid

- (void) setOidRange:	(int)	index
values:	(NSArray *)	values

Set a subset of the values of this oid array.

UnsupportedOperationErrorIf array DataType is not oid AppErrorIf the ValueArray is not available

Parameters

index	[in] Position of the first element to set [0..N-1]
values	[in] All the values to set

Exceptions

System.ApplicationException	null
System.ArgumentException	If the index or size is out of range
System.ApplicationException	null

- (void) setTimestamp: (NSArray *) values

Set all the values of this timestamp array.

AppErrorIf the ValueArray is not available

Parameters

values [in] All the values to set

Exceptions

System.ApplicationException	null
System.ApplicationException	If array DataType is not timestamp

- (void) setTimestampRange:	(int)	index
values:	(NSArray *)	values

Set a subset of the values of this timestamp array.

UnsupportedOperationErrorIf array DataType is not timestamp AppErrorIf the ValueArray is not available

Parameters

index	[in] Position of the first element to set [0..N-1]
values	[in] All the values to set

Exceptions

System.ApplicationException	null
System.ArgumentException	If the index or size is out of range
System.ApplicationException	null

The documentation for this class was generated from the following file:

Sparksee.h