Arrays

Functions
void	SPI_LOC_ClearTab ()
	Deallocates all arrays in memory.
int	SPI_LOC_find_first_array ()
	Finds the first free array and return its number.
int	SPI_LOC_read_one_in_array (int pos, void *adr, int ind)
	Reads a field in an array.
int	SPI_LOC_read_one_int_in_array (int pos, int *ival, int ind)
	Reads an integer in an array.
int	SPI_LOC_read_one_real_in_array (int pos, double *rval, int ind)
	Reads a real in an array.
int	SPI_LOC_read_one_TR3_in_array (int pos, double *rval, int ind)
	Reads an array of 3 reals in an array.
int	SPI_LOC_read_one_TR9_in_array (int pos, double *rval, int ind)
	Reads an array of 9 reals in an array.
int	SPI_LOC_read_one_TC255_in_array (int pos, std::string &sval, int ind)
	Reads a string in an array.
int	SPI_LOC_read_number_in_array (int ind)
	Reads the number of fields in an array.
int	SPI_LOC_alloc_array (int typ, int nb, int ind)
	Allocates an array at a given size.
int	SPI_LOC_write_one_in_array (int pos, const void *adr, int ind)
	Writes a field in an array.
int	SPI_LOC_write_one_int_in_array (int pos, int ival, int ind)
	Writes an integer in an array.
int	SPI_LOC_write_one_real_in_array (int pos, double rval, int ind)
	Writes a real in an array.
int	SPI_LOC_write_one_TR3_in_array (int pos, const double *rval, int ind)
	Writes an array of 3 reals in an array.
int	SPI_LOC_write_one_TR9_in_array (int pos, double *rval, int ind)
	Writes an array of 9 reals in an array.
int	SPI_LOC_write_one_TC255_in_array (int pos, const std::string &sval, int ind)
	Writes a string in an array.
int	SPI_LOC_free_array (int ind)
	Deallocates an array.
int	SPI_LOC_realloc_array (int nnb, int ind)
	Reallocates an array to a given size.
int	SPI_LOC_write_multi_in_array (int pos, int n, void *adr, int ind)
	Writes several values ​​in an array.
int	SPI_LOC_read_multi_in_array (int pos, int n, void *adr, int ind)
	Reads several values ​​in an array.

Detailed Description

Arrays management

Function Documentation

SPI_LOC_alloc_array()

int SPI_LOC_alloc_array	(	int	typ,
		int	nb,
		int	ind )

Allocates an array at a given size.

Parameters

[in]	ind	array index to allocate
[in]	typ	type of field to allocate (see doc Global)
[in]	nb	number of fields to allocate

Returns

SPI_YES if OK | SPI_NO if ind> = MAXAOC or allocation impossible...

Remarks

1) ALWAYS test the error at the output of the function
2) ALWAYS free the array before reallocating it

list of types available

• SPI_LOC_TYPINT: integer
• SPI_LOC_TYPDOU: double
• SPI_LOC_TYPCHR: character
• SPI_LOC_TYPC20: chain of 20 characters
• SPI_LOC_TYPC40: chain of 40 characters
• SPI_LOC_TYPC80: chain of 80 characters
• SPI_LOC_TYPC255: chain of 255 characters
• SPI_LOC_TYPTR3: Tables of 3 doubles (Point)
• SPI_LOC_TYPTR9: Tables of 9 doubles (canonical forms)

iloc := ICALL(SPI_LOC_find_first_array);
ier := ICALL(SPI_LOC_alloc_array,SPI_LOC_TYPINT,10,iloc);

SPI_LOC_ClearTab()

void SPI_LOC_ClearTab

(

)

Deallocates all arrays in memory.

Version

6.04

SPI_LOC_find_first_array()

int SPI_LOC_find_first_array

(

)

Finds the first free array and return its number.

Returns

array index | -1 if all occupied

iloc := ICALL(SPI_LOC_find_first_array);

SPI_LOC_free_array()

int SPI_LOC_free_array

(

int

ind

)

Deallocates an array.

Parameters

[in]

ind

index of the array to deallocate

Returns

SPI_YES if Ok | SPI_NO if error

ier := ICALL(SPI_LOC_free_array,iloc);

SPI_LOC_read_multi_in_array()

int SPI_LOC_read_multi_in_array	(	int	pos,
		int	n,
		void *	adr,
		int	ind )

Reads several values ​​in an array.

Parameters

[in]	pos	position in array
[in]	n	number of fields always >= 1
[in]	ind	index of the array in which to read
[out]	adr	address of the table of fields to read

Returns

SPI_YES if Ok | SPI_NO if error

ier := ICALL(SPI_LOC_read_multi_in_array,1,3,pt,iloc);

SPI_LOC_read_number_in_array()

int SPI_LOC_read_number_in_array

(

int

ind

)

Reads the number of fields in an array.

Parameters

[in]

ind

table index

Returns

number of fields in the array

nb := ICALL(SPI_LOC_read_number_in_array,iloc);

SPI_LOC_read_one_in_array()

int SPI_LOC_read_one_in_array	(	int	pos,
		void *	adr,
		int	ind )

Reads a field in an array.

Parameters

[in]	pos	position in array
[in]	ind	index of the array in which to read
[out]	adr	address of the value read

Returns

SPI_YES if Ok | SPI_NO if error

ier := ICALL(SPI_LOC_read_one_in_array,1,ival,iloc);

SPI_LOC_read_one_int_in_array()

int SPI_LOC_read_one_int_in_array	(	int	pos,
		int *	ival,
		int	ind )

Reads an integer in an array.

Version

6.04

Parameters

[in]	pos	position in array
[in]	ind	index of the array in which to read
[out]	ival	integer value read

Returns

SPI_YES si Ok | SPI_NO si erreur

ier := ICALL(SPI_LOC_read_one_int_in_array,1,ival,iloc);

SPI_LOC_read_one_real_in_array()

int SPI_LOC_read_one_real_in_array	(	int	pos,
		double *	rval,
		int	ind )

Reads a real in an array.

Version

6.04

Parameters

[in]	pos	position in array
[in]	ind	index of the array in which to read
[out]	rval	real value read

Returns

SPI_YES : Ok | SPI_NO : error

ier := ICALL(SPI_LOC_read_one_real_in_array,1,rval,iloc);

SPI_LOC_read_one_TC255_in_array()

int SPI_LOC_read_one_TC255_in_array	(	int	pos,
		std::string &	sval,
		int	ind )

Reads a string in an array.

Version

6.04

Parameters

[in]	pos	position in array
[in]	ind	index of the array in which to read
[out]	sval	string read

Returns

SPI_YES : Ok | SPI_NO : error

ier := ICALL(SPI_LOC_read_one_TC255_in_array,1,sval,iloc);

SPI_LOC_read_one_TR3_in_array()

int SPI_LOC_read_one_TR3_in_array	(	int	pos,
		double *	rval,
		int	ind )

Reads an array of 3 reals in an array.

Version

6.04

Parameters

[in]	pos	position in array
[in]	ind	index of the array in which to read
[out]	rval	array read

Returns

SPI_YES : Ok | SPI_NO : error

ier := ICALL(SPI_LOC_read_one_TR3_in_array,1,ival,iloc);

SPI_LOC_read_one_TR9_in_array()

int SPI_LOC_read_one_TR9_in_array	(	int	pos,
		double *	rval,
		int	ind )

Reads an array of 9 reals in an array.

Version

6.04

Parameters

[in]	pos	position in array
[in]	ind	index of the array in which to read
[out]	rval	array read

Returns

SPI_YES : Ok | SPI_NO : error

ier := ICALL(SPI_LOC_read_one_TR9_in_array,1,ival,iloc);

SPI_LOC_realloc_array()

int SPI_LOC_realloc_array	(	int	nnb,
		int	ind )

Reallocates an array to a given size.

Parameters

[in]	ind	table index to reallocate
[in]	nnb	total number of array fields

Returns

SPI_YES if OK | SPI_NO if ind> = MAXAOC or reallocation impossible ...

ier := ICALL(SPI_LOC_realloc_array,12,iloc);

SPI_LOC_write_multi_in_array()

int SPI_LOC_write_multi_in_array	(	int	pos,
		int	n,
		void *	adr,
		int	ind )

Writes several values ​​in an array.

Parameters

[in]	pos	position in array
[in]	n	number of fields always >= 1
[in]	adr	address of the table of fields to write
[in]	ind	index of the array in which to write

Returns

SPI_YES if Ok | SPI_NO if error

ier := ICALL(SPI_LOC_write_multi_in_array,1,3,pt,iloc);

SPI_LOC_write_one_in_array()

int SPI_LOC_write_one_in_array	(	int	pos,
		const void *	adr,
		int	ind )

Writes a field in an array.

Parameters

[in]	pos	position in array
[in]	adr	address of the variable to write
[in]	ind	index of the array in which to write

Returns

SPI_YES if Ok | SPI_NO if error

Remarks

Always use an address variable to write a value

ier := ICALL(SPI_LOC_write_one_in_array,1,ival,iloc);

SPI_LOC_write_one_int_in_array()

int SPI_LOC_write_one_int_in_array	(	int	pos,
		int	ival,
		int	ind )

Writes an integer in an array.

Version

6.04

Parameters

[in]	pos	position in array
[in]	ival	integer to write
[in]	ind	index of the array in which to write

Returns

SPI_YES : Ok | SPI_NO : error

ier := ICALL(SPI_LOC_write_one_int_in_array,1,ival,iloc);

SPI_LOC_write_one_real_in_array()

int SPI_LOC_write_one_real_in_array	(	int	pos,
		double	rval,
		int	ind )

Writes a real in an array.

Version

6.04

Parameters

[in]	pos	position in array
[in]	rval	real to write
[in]	ind	index of the array in which to write

Returns

SPI_YES : Ok | SPI_NO : error

ier := ICALL(SPI_LOC_write_one_real_in_array,1,rval,iloc);

SPI_LOC_write_one_TC255_in_array()

int SPI_LOC_write_one_TC255_in_array	(	int	pos,
		const std::string &	sval,
		int	ind )

Writes a string in an array.

Version

6.04

Parameters

[in]	pos	position in array
[in]	sval	string to write
[in]	ind	index of the array in which to write

Returns

SPI_YES : Ok | SPI_NO : error

ier := ICALL(SPI_LOC_write_one_TC255_in_array,1,ival,iloc);

SPI_LOC_write_one_TR3_in_array()

int SPI_LOC_write_one_TR3_in_array	(	int	pos,
		const double *	rval,
		int	ind )

Writes an array of 3 reals in an array.

Version

6.04

Parameters

[in]	pos	position in array
[in]	rval	array of 3 reals to write
[in]	ind	index of the array in which to write

Returns

SPI_YES : Ok | SPI_NO : error

ier := ICALL(SPI_LOC_write_one_TR3_in_array,1,ival,iloc);

SPI_LOC_write_one_TR9_in_array()

int SPI_LOC_write_one_TR9_in_array	(	int	pos,
		double *	rval,
		int	ind )

Writes an array of 9 reals in an array.

Version

6.04

Parameters

[in]	pos	position in array
[in]	rval	array of 9 reals to write
[in]	ind	index of the array in which to write

Returns

SPI_YES : Ok | SPI_NO : error

ier := ICALL(SPI_LOC_write_one_TR9_in_array,1,ival,iloc);