Tables

Fonctions
int	SPI_GEN_str_array_new (const std::string &arrayName)
	Définit une nouvelle table de chaîne.
int	SPI_GEN_str_array_select (const std::string &arrayName)
	Sélectionne une table à partir de son nom.
int	SPI_GEN_str_array_new_col (const std::string &colName)
	Definit une nouvelle colonne dans la table courante.
int	SPI_GEN_str_array_new_lin (const std::string &cellContent)
	Ecrit une nouvelle cellule dans la colonne courante.
int	SPI_GEN_str_array_free ()
	Désalloue la table courante.
int	SPI_GEN_str_array_compact ()
	Elimine les lignes identiques dans la table courante.
int	SPI_GEN_str_array_simple_sort (const std::string &colName, int sortType, int sortOrder)
	Compacte et trie une colonne de la table connue par son son nom suivant un type de trie souhaité
int	SPI_GEN_str_array_sort (int *colSortArray, int *sortTypeArray, int *sortOrderArray, int equalityColNb)
	Compacte et trie la table courante suivant un numéro de colonne En cas d'égalité de 2 membres, la comparaison s'effectue sur les autres colonnes designées.
int	SPI_GEN_str_array_read (const std::string &colName, int linNb, std::string &msg)
	Lit la valeur d'une cellule de la table courante.
int	SPI_GEN_str_array_modify (const std::string &colName, int linNb, const std::string &msg)
	Modifie le contenu d'une cellule de la table courante.
int	SPI_GEN_str_array_col_width (const std::string &colName, int *width)
	Donne la largeur d'une colonne de la table courante.
int	SPI_GEN_str_array_to_file (const std::string &dirName, const std::string &fileName, char separator)
	Crée un fichier ascii à partir de la table courante.
int	SPI_GEN_str_array_to_editor ()
	Affiche la table courante dans l'éditeur de texte.

Description détaillée

Gestion de table

Documentation des fonctions

SPI_GEN_str_array_col_width()

int SPI_GEN_str_array_col_width	(	const std::string &	colName,
		int *	width )

Donne la largeur d'une colonne de la table courante.

Paramètres

[in]	colName	nom de la colonne de la table courante
[out]	width	largeur de la colonne

Renvoie

SPI_YES si Ok | SPI_NO si erreur

ier := ICALL(SPI_GEN_str_array_col_width,'COL1',width);

SPI_GEN_str_array_compact()

int SPI_GEN_str_array_compact

(

)

Elimine les lignes identiques dans la table courante.

Version

4.4

Renvoie

SPI_YES si Ok | SPI_NO si erreur

Remarques

Pour les lignes compactées, la fonction SPI_GEN_str_array_read renvoie SPI_NO, pour prévenir qu'il ne faut pas les traiter

ier := ICALL(SPI_GEN_str_array_compact);

SPI_GEN_str_array_free()

int SPI_GEN_str_array_free

(

)

Désalloue la table courante.

Version

4.4

Renvoie

SPI_YES si Ok | SPI_NO si erreur

ier := ICALL(SPI_GEN_str_array_free);

SPI_GEN_str_array_modify()

int SPI_GEN_str_array_modify	(	const std::string &	colName,
		int	linNb,
		const std::string &	msg )

Modifie le contenu d'une cellule de la table courante.

Version

4.4

Paramètres

[in]	colName	nom de la colonne de la table courante
[in]	linNb	numéro de la ligne de la colonne designée
[in]	msg	contenu de la cellule

Renvoie

SPI_YES si Ok | SPI_NO si erreur

ier := ICALL(SPI_GEN_str_array_modify,'COL1',1,'text');

Voir également

SPI_GEN_str_array_read

SPI_GEN_str_array_new()

int SPI_GEN_str_array_new

(

const std::string &

arrayName

)

Définit une nouvelle table de chaîne.

Version

4.4

Paramètres

[in]

arrayName

nom de la table (identificateur)

Renvoie

SPI_YES si Ok | SPI_NO si erreur

Remarques

Ne pas oublier de sélectionner et de libérer les tables occupées

ier := ICALL(SPI_GEN_str_array_new,'TABLE');

Voir également

SPI_GEN_str_array_free, SPI_GEN_str_array_select

SPI_GEN_str_array_new_col()

int SPI_GEN_str_array_new_col

(

const std::string &

colName

)

Definit une nouvelle colonne dans la table courante.

Version

4.4

Paramètres

[in]

colName

nom de la colonne

Renvoie

SPI_YES si Ok | SPI_NO si erreur

ier := ICALL(SPI_GEN_str_array_new_col,'COL1');

SPI_GEN_str_array_new_lin()

int SPI_GEN_str_array_new_lin

(

const std::string &

cellContent

)

Ecrit une nouvelle cellule dans la colonne courante.

Version

4.4

Paramètres

[in]

cellContent

chaîne à copier dans la cellule

Renvoie

SPI_YES si Ok | SPI_NO si erreur

ier := ICALL(SPI_GEN_str_array_new_lin,'LIN1');

SPI_GEN_str_array_read()

int SPI_GEN_str_array_read	(	const std::string &	colName,
		int	linNb,
		std::string &	msg )

Lit la valeur d'une cellule de la table courante.

Version

4.4

Paramètres

[in]	colName	nom de la colonne de la table courante
[in]	linNb	numéro de la ligne de la colonne désignée
[out]	msg	contenu de la cellule

Renvoie

SPI_YES si Ok | SPI_NO si erreur

ier := ICALL(SPI_GEN_str_array_read,'COL1',1,msg);

Voir également

SPI_GEN_str_array_modify

SPI_GEN_str_array_select()

int SPI_GEN_str_array_select

(

const std::string &

arrayName

)

Sélectionne une table à partir de son nom.

Version

4.4

Paramètres

[in]

arrayName

nom de la table

Renvoie

SPI_YES si Ok | SPI_NO si erreur

ier := ICALL(SPI_GEN_str_array_select,'TABLE');

SPI_GEN_str_array_simple_sort()

int SPI_GEN_str_array_simple_sort	(	const std::string &	colName,
		int	sortType,
		int	sortOrder )

Compacte et trie une colonne de la table connue par son son nom suivant un type de trie souhaité

Version

4.4

Paramètres

[in]	colName	nom de la colonne à trier
[in]	sortType	type de la colonne designée SPI_SORT_LIKE_CHARACTER SPI_SORT_LIKE_INTEGER SPI_SORT_LIKE_DOUBLEFLOAT SPI_SORT_LIKE_DATE
[in]	sortOrder	sens du tri SPI_SORT_NORMAL_ORDER SPI_SORT_REVERSE_ORDER

Renvoie

SPI_YES si Ok | SPI_NO si erreur

ier := ICALL(SPI_GEN_str_array_simple_sort,'COL1',SPI_SORT_LIKE_INTEGER,
SPI_SORT_NORMAL_ORDER);

Voir également

SPI_GEN_str_array_sort

SPI_GEN_str_array_sort()

int SPI_GEN_str_array_sort	(	int *	colSortArray,
		int *	sortTypeArray,
		int *	sortOrderArray,
		int	equalityColNb )

Compacte et trie la table courante suivant un numéro de colonne
En cas d'égalité de 2 membres, la comparaison s'effectue sur les autres colonnes designées.

Version

4.4

Paramètres

[in]	colSortArray	tableau des numéros de colonnes à tester pour le tri (colonne prioritaire en début de tableau)
[in]	sortTypeArray	tableau des types des colonnes SPI_SORT_LIKE_CHARACTER SPI_SORT_LIKE_INTEGER SPI_SORT_LIKE_DOUBLEFLOAT SPI_SORT_LIKE_DATE
[in]	sortOrderArray	tableau des sens de tri SPI_SORT_NORMAL_ORDER SPI_SORT_REVERSE_ORDER
[in]	equalityColNb	nombre de colonnes définies pour les test d'égalité

Renvoie

SPI_YES si Ok | SPI_NO si erreur

Remarques

Pour trier, toutes les cellules d'une colonne sont testées membre à membre
Le numéro de colonne est donnée dans colSortArray[0],
son type est donne dans sortTypeArray[0] et
le sens du tri sur cette colonne est donnee dans sortOrderArray[0]
Si 2 cellules sont identiques, les cellules voisines des 2 même lignes
sont alors comparées, si l'égalité persiste, d'autres
cellules des 2 mêmes lignes sont prises, etc...
L'ordre de prise en compte des colonnes est donné dans :
colSortArray[1], colSortArray[2] ... colSortArray[equalityColNb-1]
Pour chacune de ces colonnes, leur type et le sens du tri est précisé
dans sortTypeArray et sortOrderArray

ier := ICALL(SPI_GEN_str_array_sort,tab_col_sort,tab_typ_sort,tab_sens_sort,3);

Voir également

SPI_GEN_str_array_simple_sort

SPI_GEN_str_array_to_editor()

int SPI_GEN_str_array_to_editor

(

)

Affiche la table courante dans l'éditeur de texte.

Version

4.4

Renvoie

SPI_YES si Ok | SPI_NO si erreur

ier := ICALL(SPI_GEN_str_array_to_editor);

SPI_GEN_str_array_to_file()

int SPI_GEN_str_array_to_file	(	const std::string &	dirName,
		const std::string &	fileName,
		char	separator )

Crée un fichier ascii à partir de la table courante.

Version

4.4

Paramètres

[in]	dirName	adresse du fichier
[in]	fileName	nom du fichier
[in]	separator	caractère de séparation des colonnes Ex ' ' ou ';' ou '/' ou '\t' (tabulation)

Renvoie

SPI_YES si Ok | SPI_NO si erreur

Remarques

La largeur des colonnes est calculée en fonction du membre le plus large de chacune des colonnes afin d'avoir une bonne lisibilité de la table

ier := ICALL(SPI_GEN_str_array_to_file,'c:\temp','TOTO.CSV',';');