ValueArray class. More...

Public Member Functions
	set (self, index, value)
	Set a Value to a specific array position.
	get_integer (self)
	Get all the values from this int array.
	get_long (self)
	Get all the values from this long array.
	set_timestamp (self, values)
	Set all the values of this timestamp array.
	set_oid (self, values)
	Set all the values of this oid array.
	get_oid (self)
	Get all the values from this oid array.
	get (self, index, value)
	Get a Value from the array.
	get_timestamp (self)
	Get all the values from this timestamp array.
	get_double_range (self, index, size)
	Get a subset of the values from this double array.
	get_integer_range (self, index, size)
	Get a subset of the values from this integer array.
	get_boolean (self)
	Get all the values from this bool array.
	set_boolean (self, values)
	Set all the values of this bool array.
	set_double_range (self, index, values)
	Set a subset of the values from this double array.
	size (self)
	Returns the array size.
	get_long_range (self, index, size)
	Get a subset of the values from this long array.
	set_timestamp_range (self, index, values)
	Set a subset of the values from this timestamp array.
	make_null (self)
	Sets the attribute array to Null.
	set_integer_range (self, index, values)
	Set a subset of the values from this integer array.
	get_oid_range (self, index, size)
	Get a subset of the values from this oid array.
	set_boolean_range (self, index, values)
	Set a subset of the values from this boolean array.
	set_oid_range (self, index, values)
	Set a subset of the values from this oid array.
	get_double (self)
	Get all the values from this double array.
	set_long (self, values)
	Set all the values of this long array.
	set_double (self, values)
	Set all the values of this double array.
	set_integer (self, values)
	Set all the values of this int array.
	set_long_range (self, index, values)
	Set a subset of the values from this long array.
	set (self, value)
	Set a Value to the whole array.
	get_boolean_range (self, index, size)
	Get a subset of the values from this boolean array.
	get_timestamp_range (self, index, size)
	Get a subset of the values from this timestamp array.

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

Member Function Documentation

◆ get()

sparksee.ValueArray.get	(	self,
		index,
		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

ValueError	If the index is out of range or the Value not valid
RuntimeError	null

◆ get_boolean()

sparksee.ValueArray.get_boolean ( self )

Get all the values from this bool array.

UnsupportedOperationErrorIf array DataType is not bool

Returns: All the array values

Exceptions

RuntimeError	If the ValueArray is not available
RuntimeError	null

◆ get_boolean_range()

sparksee.ValueArray.get_boolean_range	(	self,
		index,
		size )

Get a subset of the values from this boolean array.

Returns all the requested values

Parameters

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

◆ get_double()

sparksee.ValueArray.get_double ( self )

Get all the values from this double array.

UnsupportedOperationErrorIf array DataType is not Double

Returns: All the array values

Exceptions

RuntimeError	If the ValueArray is not available
RuntimeError	null

◆ get_double_range()

sparksee.ValueArray.get_double_range	(	self,
		index,
		size )

Get a subset of the values from this double array.

Returns all the requested values

Parameters

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

◆ get_integer()

sparksee.ValueArray.get_integer ( self )

Get all the values from this int array.

UnsupportedOperationErrorIf array DataType is not int

Returns: All the array values

Exceptions

RuntimeError	If the ValueArray is not available
RuntimeError	null

◆ get_integer_range()

sparksee.ValueArray.get_integer_range	(	self,
		index,
		size )

Get a subset of the values from this integer array.

Returns all the requested values

Parameters

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

◆ get_long()

sparksee.ValueArray.get_long ( self )

Get all the values from this long array.

UnsupportedOperationErrorIf array DataType is not long

Returns: All the array values

Exceptions

RuntimeError	If the ValueArray is not available
RuntimeError	null

◆ get_long_range()

sparksee.ValueArray.get_long_range	(	self,
		index,
		size )

Get a subset of the values from this long array.

Returns all the requested values

Parameters

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

◆ get_oid()

sparksee.ValueArray.get_oid ( self )

Get all the values from this oid array.

UnsupportedOperationErrorIf array DataType is not oid

Returns: All the array values

Exceptions

RuntimeError	If the ValueArray is not available
RuntimeError	null

◆ get_oid_range()

sparksee.ValueArray.get_oid_range	(	self,
		index,
		size )

Get a subset of the values from this oid array.

Returns all the requested values

Parameters

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

◆ get_timestamp()

sparksee.ValueArray.get_timestamp ( self )

Get all the values from this timestamp array.

UnsupportedOperationErrorIf array DataType is not timestamp

Returns: All the array values

Exceptions

RuntimeError	If the ValueArray is not available
RuntimeError	null

◆ get_timestamp_range()

sparksee.ValueArray.get_timestamp_range	(	self,
		index,
		size )

Get a subset of the values from this timestamp array.

Returns all the requested values

Parameters

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

◆ make_null()

sparksee.ValueArray.make_null ( self )

Sets the attribute array to Null.

The ValueArray can not be used after this call.

Exceptions

RuntimeError null

◆ set() [1/2]

sparksee.ValueArray.set	(	self,
		index,
		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

ValueError	If the index is out of range or the Value not valid
RuntimeError	null

◆ set() [2/2]

sparksee.ValueArray.set	(		self,
			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

ValueError	If the Value is not valid
RuntimeError	null

◆ set_boolean()

sparksee.ValueArray.set_boolean	(		self,
			values )

Set all the values of this bool array.

AppErrorIf the ValueArray is not available

Parameters

values [in] All the values to set

Exceptions

RuntimeError	null
RuntimeError	If array DataType is not bool

◆ set_boolean_range()

sparksee.ValueArray.set_boolean_range	(	self,
		index,
		values )

Set a subset of the values from this boolean array.

Parameters

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

◆ set_double()

sparksee.ValueArray.set_double	(		self,
			values )

Set all the values of this double array.

AppErrorIf the ValueArray is not available

Parameters

values [in] All the values to set

Exceptions

RuntimeError	null
RuntimeError	If array DataType is not Double

◆ set_double_range()

sparksee.ValueArray.set_double_range	(	self,
		index,
		values )

Set a subset of the values from this double array.

Parameters

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

◆ set_integer()

sparksee.ValueArray.set_integer	(		self,
			values )

Set all the values of this int array.

AppErrorIf the ValueArray is not available

Parameters

values [in] All the values to set

Exceptions

RuntimeError	null
RuntimeError	If array DataType is not int

◆ set_integer_range()

sparksee.ValueArray.set_integer_range	(	self,
		index,
		values )

Set a subset of the values from this integer array.

Parameters

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

◆ set_long()

sparksee.ValueArray.set_long	(		self,
			values )

Set all the values of this long array.

AppErrorIf the ValueArray is not available

Parameters

values [in] All the values to set

Exceptions

RuntimeError	null
RuntimeError	If array DataType is not long

◆ set_long_range()

sparksee.ValueArray.set_long_range	(	self,
		index,
		values )

Set a subset of the values from this long array.

Parameters

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

◆ set_oid()

sparksee.ValueArray.set_oid	(		self,
			values )

Set all the values of this oid array.

AppErrorIf the ValueArray is not available

Parameters

values [in] All the values to set

Exceptions

RuntimeError	null
RuntimeError	If array DataType is not oid

◆ set_oid_range()

sparksee.ValueArray.set_oid_range	(	self,
		index,
		values )

Set a subset of the values from this oid array.

Parameters

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

◆ set_timestamp()

sparksee.ValueArray.set_timestamp	(		self,
			values )

Set all the values of this timestamp array.

AppErrorIf the ValueArray is not available

Parameters

values [in] All the values to set

Exceptions

RuntimeError	null
RuntimeError	If array DataType is not timestamp

◆ set_timestamp_range()

sparksee.ValueArray.set_timestamp_range	(	self,
		index,
		values )

Set a subset of the values from this timestamp array.

Parameters

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

◆ size()

sparksee.ValueArray.size ( self )

Returns the array size.

Returns: The number of elements in the array.

Public Member Functions

Detailed Description

Member Function Documentation

◆ get()

◆ get_boolean()

◆ get_boolean_range()

◆ get_double()

◆ get_double_range()

◆ get_integer()

◆ get_integer_range()

◆ get_long()

◆ get_long_range()

◆ get_oid()

◆ get_oid_range()

◆ get_timestamp()

◆ get_timestamp_range()

◆ make_null()

◆ set() [1/2]

◆ set() [2/2]

◆ set_boolean()

◆ set_boolean_range()

◆ set_double()

◆ set_double_range()

◆ set_integer()

◆ set_integer_range()

◆ set_long()

◆ set_long_range()

◆ set_oid()

◆ set_oid_range()

◆ set_timestamp()

◆ set_timestamp_range()

◆ size()