Search

Functions
void	SPI_TOOL_del_list (int indexList)
	Deletes a tool list.
void	SPI_TOOL_free_tool ()
	Releases the selected tool.
void	SPI_TOOL_get_back_list (int indexList)
	Transfers a tool list to the current list to be displayed in the drop-down list.
void	SPI_TOOL_init (int catalogType, int toolType)
	initializes catalog for tool search
void	SPI_TOOL_read_boolean_tool (int keyNb, int *bval)
	Reads a boolean value from a tool.
void	SPI_TOOL_read_integer_tool (int keyNb, int *ival)
	Reads an integer value from a tool.
void	SPI_TOOL_read_name_tool (int toolIndex, std::string &name)
	Reads the name of one of the tools found.
void	SPI_TOOL_read_nb_tool (int *numberOfTools)
	Starts the tool search using the criteria given by the functions SPI_TOOL_write_xxx and return the number of tools resulting from this search.
void	SPI_TOOL_read_nb_tool_panel (int *numberOfTools, int *indexList)
	Starts the tool search using the criteria given by the functions SPI_TOOL_write_xxx and return the number of tools resulting from this search. Each search is stored in a list.
void	SPI_TOOL_read_real_tool (int keyNb, double *rval)
	Reads a real value from a tool.
void	SPI_TOOL_read_string_tool (int keyNb, std::string &sval)
	Reads a string value from a tool.
int	SPI_TOOL_read_tool (const std::string &name)
	Loads a tool structure into memory from the tool name.
void	SPI_TOOL_write_integer (const std::string &criterion, int keyNb, int ival)
	Prepares a search according to an integer parameter (number of teeth, ...)
void	SPI_TOOL_write_real (const std::string &criterion, int keyNb, double rval)
	Prepares a search according to a real parameter (diameter, ...)
void	SPI_TOOL_write_string (const std::string &criterion, int keyNb, const std::string &sval)
	Prepares a search according to a string parameter (reference, ...)

Detailed Description

Tools search

Function Documentation

SPI_TOOL_del_list()

void SPI_TOOL_del_list

(

int

indexList

)

Deletes a tool list.

Version

4.6

Parameters

[out]

indexList

list index

PCALL(SPI_TOOL_del_list,indexList);

SPI_TOOL_free_tool()

void SPI_TOOL_free_tool

(

)

Releases the selected tool.

Version

6.01

PCALL(SPI_TOOL_free_tool);

SPI_TOOL_get_back_list()

void SPI_TOOL_get_back_list

(

int

indexList

)

Transfers a tool list to the current list to be displayed in the drop-down list.

Version

4.6

Parameters

[out]

indexList

list index

PCALL(SPI_TOOL_get_back_list,indexList);

SPI_TOOL_init()

void SPI_TOOL_init	(	int	catalogType,
		int	toolType )

initializes catalog for tool search

Version

4.5

Parameters

[in]	catalogType	1 tools in memory 2 permanent tools 3 prepared tools 4 tools used
[in]	toolType	(OUT_FORET, ...)

PCALL(SPI_TOOL_init,0,OUT_FORET);

SPI_TOOL_read_boolean_tool()

void SPI_TOOL_read_boolean_tool	(	int	keyNb,
		int *	bval )

Reads a boolean value from a tool.

Version

6.01

Parameters

[in]	keyNb	key to read
[out]	bval	value read

ier = ICALL(SPI_TOOL_read_tool,0);
PCALL(SPI_TOOL_read_boolean_tool,BO_TYPE_OUTIL,bval);

SPI_TOOL_read_integer_tool()

void SPI_TOOL_read_integer_tool	(	int	keyNb,
		int *	ival )

Reads an integer value from a tool.

Version

6.01

Parameters

[in]	keyNb	key to read
[out]	ival	value read

ier = ICALL(SPI_TOOL_read_tool,0);
PCALL(SPI_TOOL_read_integer_tool,EO_TYPE_OUTIL,bval);

SPI_TOOL_read_name_tool()

void SPI_TOOL_read_name_tool	(	int	toolIndex,
		std::string &	name )

Reads the name of one of the tools found.

Version

4.5

Parameters

[in]	toolIndex	tool index to read [0..(nb_tool-1)]
[out]	name	tool name

PCALL(SPI_TOOL_read_name_tool,0,tool_name);

SPI_TOOL_read_nb_tool()

void SPI_TOOL_read_nb_tool

(

int *

numberOfTools

)

Starts the tool search using the criteria given by the functions SPI_TOOL_write_xxx
and return the number of tools resulting from this search.

Version

4.5

Parameters

[out]

numberOfTools

number of tools

PCALL(SPI_TOOL_read_nb_tool,nb_tool);

SPI_TOOL_read_nb_tool_panel()

void SPI_TOOL_read_nb_tool_panel	(	int *	numberOfTools,
		int *	indexList )

Starts the tool search using the criteria given by the functions SPI_TOOL_write_xxx
and return the number of tools resulting from this search.
Each search is stored in a list.

Version

4.6

Parameters

[in,out]	indexList	list by default | -1 / storage list index
[out]	numberOfTools	number of tools

Remarks

This function is used to search when the dialog box is displayed.

PCALL(SPI_TOOL_read_nb_tool_panel,nb_tool,indexList);

See also

SPI_TOOL_get_back_list

SPI_TOOL_read_real_tool()

void SPI_TOOL_read_real_tool	(	int	keyNb,
		double *	rval )

Reads a real value from a tool.

Version

6.01

Parameters

[in]	keyNb	key to read
[out]	rval	value read

ier = ICALL(SPI_TOOL_read_tool,0);
PCALL(SPI_TOOL_read_real_tool,RO_DIAMETRE,bval);

SPI_TOOL_read_string_tool()

void SPI_TOOL_read_string_tool	(	int	keyNb,
		std::string &	sval )

Reads a string value from a tool.

Version

6.01

Parameters

[in]	keyNb	key to read
[out]	sval	value read

ier = ICALL(SPI_TOOL_read_tool,0);
PCALL(SPI_TOOL_read_string_tool,SO_NOM_OUTIL,sval);

SPI_TOOL_read_tool()

int SPI_TOOL_read_tool

(

const std::string &

name

)

Loads a tool structure into memory from the tool name.

Version

6.01

Parameters

[in]

name

tool name to read

Returns

SPI_YES if Ok | SPI_NO if error

ier = ICALL(SPI_TOOL_read_tool,toolname);

SPI_TOOL_write_integer()

void SPI_TOOL_write_integer	(	const std::string &	criterion,
		int	keyNb,
		int	ival )

Prepares a search according to an integer parameter (number of teeth, ...)

Version

4.5

Parameters

[in]	criterion	'=' , '<' , '>' , ...
[in]	keyNb	search key (EO_NOMBRE_DENTS, ...)
[in]	ival	integer to search

See also

SPI_TOOL_read_nb_tool

PCALL(SPI_TOOL_write_integer,'=',EO_NOMBRE_DENTS,2);

SPI_TOOL_write_real()

void SPI_TOOL_write_real	(	const std::string &	criterion,
		int	keyNb,
		double	rval )

Prepares a search according to a real parameter (diameter, ...)

Version

4.5

Parameters

[in]	criterion	'=' , '<' , '>' , ...
[in]	keyNb	search key (RO_DIAMETRE, ...)
[in]	rval	real to search

See also

SPI_TOOL_read_nb_tool

PCALL(SPI_TOOL_write_real,'>=,RO_DIAMETRE,20);

SPI_TOOL_write_string()

void SPI_TOOL_write_string	(	const std::string &	criterion,
		int	keyNb,
		const std::string &	sval )

Prepares a search according to a string parameter (reference, ...)

Version

4.5

Parameters

[in]	criterion	'=' , '<' , '>' , ...
[in]	keyNb	search key (SO_REF_OUTIL, ...)
[in]	sval	string to search

See also

SPI_TOOL_read_nb_tool

PCALL(SPI_TOOL_write_string,'=?',SO_REF_OUTIL,'A*');