Miscellaneous

Functions
void	SPI_GEN_get_integer_information (int key, int *answer)
	Requests system or environment information by the key intermediary (EEN_COLOR_NUMBER, EEN_LAYER_NUMBER ...)
void	SPI_GEN_get_information (int key, std::string &answer)
	Requests system or environment information by the key intermediary (SSY_DATE, SSY_HOUR, SEN_PART_NAME ...)
int	SPI_GEN_get_type_plane (int planeNb)
	Reads the type of plane.
void	SPI_GEN_get_date_hour_format (std::string &strDate, std::string &strHour, int format, int sep, int year, int mLet, int dLet, int flagSec)
	Requests the current date and time in the desired format.
void	SPI_GEN_read_message (int verNb, int messNb, std::string &mess)
	Reads the message contained in the file MSG_PROC.DAT.
void	SPI_GEN_call_box_error (const std::string &mess)
	Displays an error message dialog.
void	SPI_GEN_call_box_warning (const std::string &mess)
	Displays a warning dialog.
int	SPI_GEN_exit_all ()
	Completely stops PASCAL execution.
int	SPI_GEN_close_debug_window ()
	Closes debug window.
int	SPI_GEN_exit ()
	Stops PASCAL execution.
void	SPI_GEN_new_part ()
	Resets the part (=NEW)
void	SPI_GEN_write_next_file (const std::string &fileName)
	Writes the name of SPI file to be autorun after the end of the current SPI.
int	SPI_GEN_read_name_layer (int layerNb, std::string &familyName, std::string &layerName)
	Reads the family name and the layer name by its numerical value.
int	SPI_GEN_write_name_layer (int idx, const std::string &name)
	writes the name of a layer defined by its index
int	SPI_GEN_Color_RGB_to_Integer (int r, int g, int b)
	Converts RGB color to an integer value.
void	SPI_GEN_read_docxls_message (int messNb, std::string &mess)
	Reads the message contained in file MSG_DOCX.DAT.
void	SPI_GEN_read_msgmess (int verNb, int messNb, std::string &mess)
	Reads the message contained in file MSG_MESS.DAT.
void	SPI_GEN_read_panmess (int verNb, int messNb, std::string &mess)
	Reads the message contained in file MSG_PANE.DAT.
void	SPI_GEN_read_user_message (int mesNb, std::string &mess)
	Reads the message contained in file open with SPI_GEN_load_user_msgfile.
int	SPI_GEN_load_user_msgfile (const std::string &dir, const std::string &name)
	Opens a user message file.
void	SPI_GEN_call_browser (const std::string &sAdr, const std::string &sFile)
	Calls an application to open the file.
void	SPI_GEN_call_system (const std::string &cmd)
	Calls and executes the system command in DOS window.
void	SPI_GEN_call_program (const std::string &adr, const std::string &prog, const std::string &param)
	Calls and executes a program without opening a DOS window. useful for executables, not for DOS commands or BATCH commands.
void	SPI_GEN_call_program_show (const std::string &adr, const std::string &prog, const std::string &param, int show)
	Calls and executes a program without opening a DOS window, with visibility choice mode useful for executables, not for DOS commands or BATCH commands.
void	SPI_GEN_call_program_show_wait (const std::string &adr, const std::string &prog, const std::string &param, int show)
	Calls and executes a program without opening a DOS window, with visibility choice mode and wait for end of program useful for executables, not for DOS commands or BATCH commands.
void	SPI_GEN_call_program_wait (const std::string &adr, const std::string &prog, const std::string &param)
	Calls and executes a program without opening a DOS window and wait for end of program useful for executables, not for DOS commands or BATCH commands.
int	SPI_GEN_export_rtf_ncfile (const std::string &sAdr, const std::string &sFile)
	Creates an RTF file with informations about operation list and iso file.
int	SPI_GEN_set_information (int key, const std::string &value)
	Modifies GO2cam working directories or PartName.
void	SPI_GEN_set_integer_information (int key, int value)
	Writes system information in GO2cam according to the key (EEN_COLOR_NUMBER, EEN_LAYER_NUMBER, ...)
void	SPI_GEN_get_real_information (int key, double *answer)
	Requests GO2cam information via a key.
void	SPI_GEN_set_real_information (int key, double value)
	Write GO2cam information via a key.
int	SPI_GEN_select_information (int typTec, int index)
	Selects a tool or machine structure index for SPI_GEN_get.
int	SPI_GEN_test_option_validity (int option)
	Tests if an option is available in current licence.
int	SPI_GEN_test_bit_validity (int bitNumber)
	Tests if a bit is active in current licence.
int	SPI_GEN_test_specif_bit_validity (int bitNumber)
	Tests if a specific bit is active in current licence.
void	SPI_GEN_get_system_variable (const std::string &varName, std::string &contents)
	Reads the contents of a Windows system variable.
void	SPI_GEN_calculate_numerical_value (const std::string &string, double *value, int *error)
	Calculates the numerical value from a mathematical string.
int	SPI_GEN_get_information_part (int ind, std::string &answer)
	Retrieves informations from the part ( See "Info version" in GO2cam)
int	SPI_GEN_write_information_part (int ind, const std::string &answer)
	Writes information in the part.
int	SPI_GEN_get_angle_plane (int planeNb, double *ang1, double *ang2)
	Reads machining plane angles.
void	SPI_GEN_prepare_reexecution (int reexecType)
	Prepares the part reexecution. The reexecution is done just after the macro in Pascal In VB, Delphi ... it runs directly.
int	SPI_GEN_read_current_module ()
	Reads current running module.
int	SPI_GEN_show_solids ()
	Displays solids (works only with layout design module)
int	SPI_GEN_hide_solids ()
	Hides solids (works only with layout design module)
void	SPI_GEN_show_meshs (int show)
	Displays meshs.
void	SPI_GEN_cancel_current_function ()
	Stops current excuting function in GO2cam.
void	SPI_GEN_format_CnFileName_oem (std::string &sVal)
	get cn filename with oem format (necessary when use of SDENT_SPECIAL_PROGRAM_NC
void	SPI_GEN_get_integer_oem (int id, int *iVal)
	Reads integers informations by a key in OEM.
void	SPI_GEN_get_real_oem (int id, double *rVal)
	Reads reals informations by a key in OEM.
void	SPI_GEN_get_string_oem (int id, std::string &sVal)
	Reads string informations by a key in OEM.
void	SPI_GEN_set_string_oem (int id, const std::string &sVal)
	Writes string informations by a key in OEM.
int	SPI_GEN_select_element_oem (int eltNb)
	Selects a tooth element for getting values (Tooth ..)
void	SPI_GEN_get_partori_oem (double *ori)
	Reads OEM current stock position.
int	SPI_GEN_select_part_oem (int stockNb)
	Selects a stock for reading specifics values.
void	SPI_GEN_set_NC_format (const std::string &Sformat)
	Sets up NC format éditor used by post-processor.
void	SPI_GEN_export_file_information_oem (const std::string &dirName)
	Exports info file for an OEM.
void	SPI_GEN_get_nb_elements_on_stock_oem (int *number)
	Reads number of teeth elements.
int	SPI_GEN_get_polyline_element_oem (int iCase, int ptmaxNb, int *listTeethTabIdx)
	Reads points of tooth polygon.
int	SPI_GEN_get_list_elements_group_oem (int *listTeethTabIdx)
	Reads the list of teeth from the same group as the current tooth.
int	SPI_GEN_get_list_teeth_oem (int *listTeethTabIdx)
	Reads the list of teeth from the same group as the current tooth.
int	SPI_GEN_get_list_stocks_oem (int *listStockTabIdx)
	Read stocks list.
int	SPI_GEN_get_list_connectors_oem (int *listConnectorsTabIdx)
	Reads connector list.
int	SPI_GEN_get_list_dent_oem (int *listTeethTabIdx)
	Reads the list of teeth from the same group as the current tooth.
int	SPI_GEN_get_list_brut_oem (int *listStockTabIdx)
	Reads stocks list.
int	SPI_GEN_get_list_connecteurs_oem (int *listConnectorsTabIdx)
	Reads connectors list.
int	SPI_GEN_get_adr_elmt_array (int pos, int tabNb)
	Reads an integer element of the array.
int	SPI_GEN_clear_user_curve_oem (int toothDbIdx)
	Removes all user curves from a tooth.
int	SPI_GEN_add_user_curve_oem (int toothDbIdx, int curveDbIdx)
	Adds a user curve on a tooth.
int	SPI_GEN_get_real_machine_position_oem (int iPosition, double *position)
	Get the XYZ coordinates of the i-th position.
void	SPI_GEN_get_mass_unit (int *unit)
	Get mass unit.
void	SPI_GEN_set_mass_unit (int unit)
	Set mass unit.
void	SPI_GEN_get_angle_unit (int *unit, int *decimalNb)
	Get unit angle.
void	SPI_GEN_set_angle_unit (int unit, int decimalNb)
	Set unit angle.
void	SPI_GEN_get_length_unit (double *factorToMM, int *decimalNb, int *bFractional)
	Get length unit.
void	SPI_GEN_set_length_unit (double factorToMM, int decimalNb, int bFractional)
	Set length unit.
void	SPI_GEN_set_machining_unit (int meter, int decimalNb)
	Set machining units.

Detailed Description

Miscellaneous

Function Documentation

SPI_GEN_add_user_curve_oem()

int SPI_GEN_add_user_curve_oem	(	int	toothDbIdx,
		int	curveDbIdx )

Adds a user curve on a tooth.

Version

6.04.201

Parameters

[in]	toothDbIdx	position of the tooth in database
[in]	curveDbIdx	position of the curve in database

Returns

0 or error

SPI_GEN_calculate_numerical_value()

void SPI_GEN_calculate_numerical_value	(	const std::string &	string,
		double *	value,
		int *	error )

Calculates the numerical value from a mathematical string.

Version

4.4

Parameters

[in]	string	mathematical string
[out]	value	Calculated value
[out]	error	0 Ok or error number 1 divide by 0 2 negatif value in sqrt 3 value not between -1 and 1 4 value = PIC/2.0 in TAN-function 5 overflow 6 underflow 7 syntax error 8 stack error 9 negatif value in log

Remarks

Mathematical keywords list :

SQR Square root
SIN Sinus
COS Cosinus
TAN Tangent
ASIN ArcSinus
ACOS ArcCosinus
ATAN ArcTangent
^ Power
ABS Absolute value
int Integer value
MAX Maximum
MIN Minimum
MOD Modulo
EXP Exponential
LN Neperian logarithm
LOG Decimal logarithm
RND Random
SGN Sign
ROUND Rounding
TRUNC Integer Part

Logical operators :

AND Logical AND
OR Logical OR
XOR Exclusif logical OR
NOT Logical NOT

Binary operatoirs :

== Equality

Angular unit :

D Degre
' Minute
\ Seconde

. Decimal separator
E Decimal power
PI Pi (3.14...)

PCALL(SPI_GEN_calculate_numerical_value,'2*COS(PI/4)',rval,ier);

SPI_GEN_call_box_error()

void SPI_GEN_call_box_error

(

const std::string &

mess

)

Displays an error message dialog.

Version

4.4

Parameters

[in]

mess

Message to display

Remarks

Blocking dialog box

PCALL(SPI_GEN_call_box_error,'Hello');

SPI_GEN_call_box_warning()

void SPI_GEN_call_box_warning

(

const std::string &

mess

)

Displays a warning dialog.

Version

4.4

Parameters

[in]

mess

Message to display

Remarks

Blocking dialog box

PCALL(SPI_GEN_call_box_warning,'Hello');

SPI_GEN_call_browser()

void SPI_GEN_call_browser	(	const std::string &	sAdr,
		const std::string &	sFile )

Calls an application to open the file.

Version

6.04

Parameters

[in]	sAdr	file directory
[in]	sFile	file name

SPI_GEN_call_program()

void SPI_GEN_call_program	(	const std::string &	adr,
		const std::string &	prog,
		const std::string &	param )

Calls and executes a program without opening a DOS window.
useful for executables, not for DOS commands or BATCH commands.

Version

4.4

Parameters

[in]	adr	address of the executable, empty if in the GO2cam root directory
[in]	prog	executable file name
[in]	param	executable parameters

PCALL(SPI_GEN_call_program,'c:\temp','TOTO.EXE','');

SPI_GEN_call_program_show()

void SPI_GEN_call_program_show	(	const std::string &	adr,
		const std::string &	prog,
		const std::string &	param,
		int	show )

Calls and executes a program without opening a DOS window, with visibility choice mode
useful for executables, not for DOS commands or BATCH commands.

Version

6.02

Parameters

[in]	adr	address of the executable, empty if in the GO2cam root directory
[in]	prog	executable file name
[in]	param	executable parameters
[in]	show	window executable visibility ESY_HIDE_DIALOG hide executable ESY_SHOW_MAXIMISED_DIALOG show maximized executable ESY_MINIMIZE_DIALOG minimize dialog in task bar ESY_SHOW_DIALOG show nomral executable

PCALL(SPI_GEN_call_program,'c:\temp','TOTO.EXE','',ESY_SHOW_DIALOG);

SPI_GEN_call_program_show_wait()

void SPI_GEN_call_program_show_wait	(	const std::string &	adr,
		const std::string &	prog,
		const std::string &	param,
		int	show )

Calls and executes a program without opening a DOS window, with visibility choice mode
and wait for end of program
useful for executables, not for DOS commands or BATCH commands.

Version

6.07

Parameters

[in]	adr	address of the executable, empty if in the GO2cam root directory
[in]	prog	executable file name
[in]	param	executable parameters
[in]	show	window executable visibility ESY_HIDE_DIALOG hide executable ESY_SHOW_MAXIMISED_DIALOG show maximized executable ESY_MINIMIZE_DIALOG minimize dialog in task bar ESY_SHOW_DIALOG show nomral executable

PCALL(SPI_GEN_call_program,'c:\temp','TOTO.EXE','',ESY_SHOW_DIALOG);

SPI_GEN_call_program_wait()

void SPI_GEN_call_program_wait	(	const std::string &	adr,
		const std::string &	prog,
		const std::string &	param )

Calls and executes a program without opening a DOS window and wait for end of program
useful for executables, not for DOS commands or BATCH commands.

Version

6.07

Parameters

[in]	adr	address of the executable, empty if in the GO2cam root directory
[in]	prog	executable file name
[in]	param	executable parameters

PCALL(SPI_GEN_call_program_wait,'c:\temp','TOTO.EXE','');

SPI_GEN_call_system()

void SPI_GEN_call_system

(

const std::string &

cmd

)

Calls and executes the system command in DOS window.

Parameters

[in]

cmd

system command to execute

PCALL(SPI_GEN_call_system,'c:\temp\TOTO.BAT');

SPI_GEN_cancel_current_function()

void SPI_GEN_cancel_current_function

(

)

Stops current excuting function in GO2cam.

Version

5.10

Remarks

This API must be used before and after calling GO2cam monitor function
like manual part positioning

Pascal example
PCALL(SPI_GEN_cancel_current_function);
ier := IPCALL(SPI_FIL_call_manual_positioning);
PCALL(SPI_GEN_cancel_current_function);
 
VB Example
call GOE.SPI_GEN_cancel_current_function
ier GOE.SPI_FIL_call_manual_positioning
call GOE.SPI_GEN_cancel_current_function

SPI_GEN_clear_user_curve_oem()

int SPI_GEN_clear_user_curve_oem

(

int

toothDbIdx

)

Removes all user curves from a tooth.

Version

6.04.201

Parameters

[in]

toothDbIdx

position of the tooth in database -1 => clear All curves in All teeth

Returns

0 or error

SPI_GEN_close_debug_window()

int SPI_GEN_close_debug_window

(

)

Closes debug window.

Version

4.6

Returns

0

SPI_GEN_Color_RGB_to_Integer()

int SPI_GEN_Color_RGB_to_Integer	(	int	r,
		int	g,
		int	b )

Converts RGB color to an integer value.

Version

6.05

Returns

integer representation of the color

SPI_GEN_exit()

int SPI_GEN_exit

(

)

Stops PASCAL execution.

PCALL(SPI_GEN_exit);

Returns

0

SPI_GEN_exit_all()

int SPI_GEN_exit_all

(

)

Completely stops PASCAL execution.

PCALL(SPI_GEN_exit_all);

Returns

-1

SPI_GEN_export_file_information_oem()

void SPI_GEN_export_file_information_oem

(

const std::string &

dirName

)

Exports info file for an OEM.

Version

5.10

Parameters

[in]

dirName

file directory

SPI_GEN_export_rtf_ncfile()

int SPI_GEN_export_rtf_ncfile	(	const std::string &	sAdr,
		const std::string &	sFile )

Creates an RTF file with informations about operation list and iso file.

Version

6.01

Parameters

[in]	sAdr	file adress
[in]	sFile	file name

Returns

SPI_YES if Ok | SPI_NO if error

PCALL(SPI_GEN_export_rtf_ncfile,'iso','ruban.rtf');

SPI_GEN_format_CnFileName_oem()

void SPI_GEN_format_CnFileName_oem

(

std::string &

sVal

)

get cn filename with oem format (necessary when use of SDENT_SPECIAL_PROGRAM_NC

Version

6.10

Parameters

[out]

sVal

cn filename

PCALL(SPI_GEN_format_CnFileName_oem,sname);

SPI_GEN_get_adr_elmt_array()

int SPI_GEN_get_adr_elmt_array	(	int	pos,
		int	tabNb )

Reads an integer element of the array.

Version

6.2

Parameters

[in]	pos	position in array
[in]	tabNb	array number

Returns

value read

Remarks

Use table reading functions

See also

SPI_LOC_read_one_in_array SPI_LOC_read_number_in_array

SPI_GEN_get_angle_plane()

int SPI_GEN_get_angle_plane	(	int	planeNb,
		double *	ang1,
		double *	ang2 )

Reads machining plane angles.

Version

4.4

Parameters

[in]	planeNb	Index of the GO2cam plane
[out]	ang1	1er angle of plane
[out]	ang2	2eme angle of plane

Returns

SPI_YES | SPI_NO

Remarks

Angles are in Radian

ier := ICALL(SPI_GEN_get_angle_plane,3,ang1,ang2);

SPI_GEN_get_angle_unit()

void SPI_GEN_get_angle_unit	(	int *	unit,
		int *	decimalNb )

Get unit angle.

Version

6.10

Parameters

[out]	unit	unit angle among the values : SPI_ANGLE_DEGRE SPI_ANGLE_DMS SPI_ANGLE_RADIAN SPI_ANGLE_GRADE
[out]	decimalNb	number of decimals

SPI_GEN_get_date_hour_format()

void SPI_GEN_get_date_hour_format	(	std::string &	strDate,
		std::string &	strHour,
		int	format,
		int	sep,
		int	year,
		int	mLet,
		int	dLet,
		int	flagSec )

Requests the current date and time in the desired format.

Version

6.3

Parameters

[in]	format	1: european format JJ/MM/AA HH:MN 2: anglosaxon format MM/JJ/AA HH:MN AM(PM) 3: universel format AA/MM/JJ HH:MN:SS 4: japanese format AAxMMxJJx HH:MN:SS 5: file format r AA-MM-JJ_HH-MN
[in]	sep	1: separator '/' pour la date (JJ/MM/AA) 2: separator '-' pour la date (JJ-MM-AA) 3: separator ' ' pour la date (JJ MM AA)
[in]	year	1: year on 2 digits (97) (00) 2: year on 4 digits (1997) (2000)
[in]	mLet	1: month with figures (07) 2: month with letters (July)
[in]	dLet	1: day with figures (15) 2: day with letters+figures (monday 23)
[in]	flagSec	0: without seconds 1: with seconds
[out]	strDate	date with format
[out]	strHour	hour with format

PCALL(SPI_GEN_get_date_hour_format,sdate,shour,3,1,2,1,1,0);

SPI_GEN_get_information()

void SPI_GEN_get_information	(	int	key,
		std::string &	answer )

Requests system or environment information by
the key intermediary (SSY_DATE, SSY_HOUR, SEN_PART_NAME ...)

Version

4.4

Parameters

[in]	key	keyword Availables keywords are : - SSY_* : System keyword (SSY_LOG_NAME ..) - SEN_* : Environnement keyword (SEN_PART_DIRECTORY ...) - SM_* ,SMT_* : Material and Machine keywords See the file RES_ISPI.DAT SEN_PART_NAME : Part name SEN_PROCESS_NAME : Process name SEN_ORIGIN_CAD_NAME : Origin CAD file name SEN_PART_DIRECTORY : part directory SEN_PROCESS_DIRECTORY : process directory SEN_PROCESS_SPECIF_DIRECTORY : custom processus directory SEN_TOOL_DIRECTORY : tool directory SEN_FORM_DIRECTORY : tool shape directory SEN_TECHNO_DIRECTORY : technologies directory SEN_MATERIAL_DIRECTORY: material directory SEN_MACHINE_DIRECTORY : machine directory SEN_PPSTD_DIRECTORY : Standard post-processor directory SEN_PP_DIRECTORY : Custom post-processor directory SEN_HELP_DIRECTORY : Help directory SEN_DOC_MODEL_DIRECTORY:Modeles documents directory SEN_DOCUMENT_DIRECTORY :Filled documments directory SEN_TMP_DIRECTORY : Temporary directory SEN_USER_DIRECTORY : User directory SEN_ICON_DIRECTORY : icone directory SEN_FONT_DIRECTORY : Font directory SEN_INI_DIRECTORY : INI files directory SEN_ISO_DIRECTORY : G code files directory SEN_OLE_DIRECTORY : OLE for DM directory SEN_EXE_DIRECTORY : GO2cam directory SEN_SYMBOL_DIRECTORY : symbole directory SEN_MULTIPART_DIRECTORY:multi part directory SEN_OEM_DIRECTORY : OEM directory SEN_IMPORT_DIRECTORY : import directory SEN_TODO_DIRECTORY : import directory for dental SEN_OPELIST_DIRECTORY : Opelist directory SEN_VERSION_NUMBER : GO2cam version number SEN_REVISION_NUMBER : GO2cam release number SEN_DONGLE_NUMBER : Dongle number SEN_CLASS_OPELIST : oplist grade valid SEN_PDM_NAME : current PDM name use by CFX SSY_DATE : Current date SSY_HOUR : Current Hour SSY_DATE_HOUR : Current date + hour SSY_LOG_NAME : loggin name SSY_HOST_NAME : computer name
[out]	answer	answer to the request

PCALL(SPI_GEN_get_information,SSY_DATE,str_date);

SPI_GEN_get_information_part()

int SPI_GEN_get_information_part	(	int	ind,
		std::string &	answer )

Retrieves informations from the part ( See "Info version" in GO2cam)

Version

4.4

Parameters

[in]	ind	line index to read
[out]	answer	comment read from the part

Returns

SPI_YES if Ok | SPI_NO if error

PCALL(SPI_GEN_get_information_part,1,ligne);

SPI_GEN_get_integer_information()

void SPI_GEN_get_integer_information	(	int	key,
		int *	answer )

Requests system or environment information by
the key intermediary (EEN_COLOR_NUMBER, EEN_LAYER_NUMBER ...)

Version

4.4

Parameters

[in]	key	request keywords Availables keywords are : - EEN_* : Environnement keywords (EEN_COLOR_NUMBER ...) - EM_* ,EMT_* : Material and Machine keywords See the file RES_ISPI.DAT EEN_COLOR_NUMBER : Current color EEN_LAYER_NUMBER : Current layer EEN_PLANE_NUMBER : Current Plane EEN_COLOR_MAX : Maximum color numberleur EEN_SUBPROGRAM_NUMBER : free sub programm number BEN_VERSION_TYPE Version type DPP_FRAISAGE, DPP_EROSION EEN_TOOL_DB : TDB_FILE / TDB_GEDIX BEN_EXTERNAL_S_F_CALC : SPI_YES / SPI_NO EEN_LANG : current language 2=english, 3=french EEN_LATHE_STOCK_PANE_NUMBER : number of pane on stock lathe EEN_STOCK_TYPE : Type of stock : 0 : Manual lathe 1 : Lathe cylinder 2 : Lathe 4 sides 3 : Lathe 6 sides 11 : Lathe / milling 12 : Solid milling 13 : Box milling 14 : Cylinder milling -1 : no stock EEN_CYCLE_OPTIMIZATION : 1=tool,2=plane,3=without (V6.01.206) EEN_PROFIL_CANCELLATION: profil cancellation after use (V6.01.206) BEN_ROTARY_AXIS_POSITION_HOLE : Get state of rotary axis positioning in hole selection EEN_EDGE_DISPLAY : Get mode edge display : 1=None, 2=Fast, 3=Realistic
[out]	answer	answer to the request

PCALL(SPI_GEN_get_integer_information,EEN_LAYER_NUMBER,ilayer);

SPI_GEN_get_integer_oem()

void SPI_GEN_get_integer_oem	(	int	id,
		int *	iVal )

Reads integers informations by a key in OEM.

Version

5.10

Parameters

[in]	id	integer ident EDENT_NUMERO EDENT_IS_MACHINED EDENT_INDBDD EDENT_TYPOLOGY EDENT_SUB_TYPOLOGY EDENT_TYPE_CONNECTIC EDENT_NUMBER_PROGRAM_NC EDENT_INDEX_PROGRAM_NC EPART_IS_BLOCK : (deprecated) EPART_IS_CYLINDER : (deprecated) EPART_IS_ROTAXIS : (deprecated) EPART_POSITION : position number for multi pin or premilled EPART_NB_POSITION : number of available positions EPART_NB_PART : number of stocks to machine
[out]	iVal	integer value

PCALL(SPI_GEN_get_integer_oem,EDENT_NUMERO,ival1);

SPI_GEN_get_length_unit()

void SPI_GEN_get_length_unit	(	double *	factorToMM,
		int *	decimalNb,
		int *	bFractional )

Get length unit.

Version

6.10

Parameters

[out]	factorToMM	: conversion factor to millimeter
[out]	decimalNb	: number of decimals
[out]	bFractional	: SPI_YES / SPI_NO to tell if imperial dimension uses fraction

SPI_GEN_get_list_brut_oem()

int SPI_GEN_get_list_brut_oem

(

int *

listStockTabIdx

)

Reads stocks list.

Version

5.10.205

Attention

This function is deprecated. See SPI_GEN_get_list_stocks_oem

Parameters

[out]

listStockTabIdx

allocated table index containing the list of stocks

Remarks

Use table reading functions

Returns

SPI_YES | SPI_NO

See also

SPI_GEN_get_list_stocks_oem

SPI_LOC_read_one_in_array SPI_LOC_read_number_in_array

SPI_GEN_get_list_connecteurs_oem()

int SPI_GEN_get_list_connecteurs_oem

(

int *

listConnectorsTabIdx

)

Reads connectors list.

Version

5.10.205

Attention

This function is deprecated. See SPI_GEN_get_list_connectors_oem

Parameters

[out]

listConnectorsTabIdx

allocated array index containing the list of connectors

Remarks

Use table reading functions

Returns

SPI_YES | SPI_NO

See also

SPI_GEN_get_list_connectors_oem

SPI_LOC_read_one_in_array SPI_LOC_read_number_in_array

SPI_GEN_get_list_connectors_oem()

int SPI_GEN_get_list_connectors_oem

(

int *

listConnectorsTabIdx

)

Reads connector list.

Version

6.08.200

Parameters

[out]

listConnectorsTabIdx

allocated array index containing the list of connectors

Remarks

Use table reading functions

Returns

SPI_YES | SPI_NO

See also

SPI_LOC_read_one_in_array SPI_LOC_read_number_in_array

SPI_GEN_get_list_dent_oem()

int SPI_GEN_get_list_dent_oem

(

int *

listTeethTabIdx

)

Reads the list of teeth from the same group as the current tooth.

Version

5.10.205

Attention

This function is deprecated. See SPI_GEN_get_list_teeth_oem

Parameters

[out]

listTeethTabIdx

index of the allocated table containing the list of teeth

Remarks

Use table reading functions

Returns

SPI_YES | SPI_NO

See also

SPI_GEN_get_list_teeth_oem

SPI_LOC_read_one_in_array SPI_LOC_read_number_in_array

SPI_GEN_get_list_elements_group_oem()

int SPI_GEN_get_list_elements_group_oem

(

int *

listTeethTabIdx

)

Reads the list of teeth from the same group as the current tooth.

Version

5.10.205

Parameters

[out]

listTeethTabIdx

index of the allocated table containing the list of teeth

Remarks

Use table reading functions

Returns

SPI_YES | SPI_NO

See also

SPI_LOC_read_one_in_array SPI_LOC_read_number_in_array

SPI_GEN_get_list_stocks_oem()

int SPI_GEN_get_list_stocks_oem

(

int *

listStockTabIdx

)

Read stocks list.

Version

6.08.200

Parameters

[out]

listStockTabIdx

allocated table index containing the list of stocks

Remarks

Use table reading functions

Returns

SPI_YES | SPI_NO

See also

SPI_LOC_read_one_in_array SPI_LOC_read_number_in_array

SPI_GEN_get_list_teeth_oem()

int SPI_GEN_get_list_teeth_oem

(

int *

listTeethTabIdx

)

Reads the list of teeth from the same group as the current tooth.

Version

6.08.200

Parameters

[out]

listTeethTabIdx

index of the allocated table containing the list of teeth

Remarks

Use table reading functions

Returns

SPI_YES | SPI_NO

See also

SPI_LOC_read_one_in_array SPI_LOC_read_number_in_array

SPI_GEN_get_mass_unit()

void SPI_GEN_get_mass_unit

(

int *

unit

)

Get mass unit.

Version

6.10

Parameters

[out]

unit

unit among following values : SPI_MASS_MICROGRAM SPI_MASS_MILIGRAM SPI_MASS_CENTIGRAM SPI_MASS_DECIGRAM SPI_MASS_GRAM SPI_MASS_DECAGRAM SPI_MASS_HECTOGRAM SPI_MASS_KILOGRAM SPI_MASS_TONNE SPI_MASS_OUNCE SPI_MASS_POUND

SPI_GEN_get_nb_elements_on_stock_oem()

void SPI_GEN_get_nb_elements_on_stock_oem

(

int *

number

)

Reads number of teeth elements.

Version

5.10.205

Parameters

[out]

number

number of teeth

SPI_GEN_get_partori_oem()

void SPI_GEN_get_partori_oem

(

double *

ori

)

Reads OEM current stock position.

Version

6.02

Parameters

[out]

ori

stock coordinates

PCALL(SPI_GEN_get_partori_oem,ptori);

SPI_GEN_get_polyline_element_oem()

int SPI_GEN_get_polyline_element_oem	(	int	iCase,
		int	ptmaxNb,
		int *	listTeethTabIdx )

Reads points of tooth polygon.

Version

5.10.205

Parameters

[in]

iCase

1:polygon offset 11: same with draw 2: polygon offset teeth group 12: same with draw

1:polygon offset

Parameters

[in]	ptmaxNb	maximum number of points
[out]	listTeethTabIdx	index of the allocated table containing the list of points

Remarks

Use table reading functions (SPI_LOC_TYPTR3)

Returns

SPI_YES | SPI_NO

See also

SPI_LOC_read_one_in_array SPI_LOC_read_number_in_array

SPI_GEN_get_real_information()

void SPI_GEN_get_real_information	(	int	key,
		double *	answer )

Requests GO2cam information via a key.

Version

5.6.213

Parameters

[in]	key	request keywords Availables keywords are : REN_* : Environnement keywords (REN_LATHE_STOCK_RADIUS) RM_* ,RMT_* : Material and Machine keywords See the file RES_ISPI.DAT REN_LATHE_STOCK_RADIUS : Lathe stock radius given by user REN_LATHE_STOCK_RADIUS_MINI : Internal radius of stock (5.11.229)
[out]	answer	answer to the request

PCALL(SPI_GEN_get_real_information,REN_LATHE_STOCK_RADIUS,radius);

SPI_GEN_get_real_machine_position_oem()

int SPI_GEN_get_real_machine_position_oem	(	int	iPosition,
		double *	position )

Get the XYZ coordinates of the i-th position.

Version

6.08.201

Parameters

[in]	iPosition	the machine position
[out]	position	the XYZ coordiante

Remarks

the returned position is the theorical position + the offset

Returns

0 or error

SPI_GEN_get_real_oem()

void SPI_GEN_get_real_oem	(	int	id,
		double *	rVal )

Reads reals informations by a key in OEM.

Version

5.10

Parameters

[in]	id	integer ident RDENT_THICKNESS RDENT_AREA : Offset curve surface of the tooth RDENT_OFFSET : (>=6.10) offset value of the tooth RPART_THICKNESS RPART_WIDTH RPART_LENGTH RPART_DIAMETER RPART_PRICE RPART_AREA : Surface of original stock RPART_FACTOR RPART_STOCK_USED RPART_STOCK_REMAINING : (>=6.10) % of remaining stock
[out]	rVal	real value

PCALL(SPI_GEN_get_real_oem,RPART_THICKNESS,rval1);

SPI_GEN_get_string_oem()

void SPI_GEN_get_string_oem	(	int	id,
		std::string &	sVal )

Reads string informations by a key in OEM.

Version

5.10

Parameters

[in]	id	integer ident SDENT_FILE_NAME SDENT_FILE_ADR SDENT_ALL_MATERIAL : Material list to IRIS SDENT_ALL_MACHINE : Machine list to IRIS SDENT_MACHINE_ADR SDENT_ALL_POSITION : Position list to IRIS SDENT_PATIENT SDENT_LABORATORY SDENT_TOOTH_NUMBER SDENT_UNIT_NUMBER SDENT_COLOR SDENT_CAD_SOFTWARE SDENT_COMMENT SDENT_MOUNTING SDENT_SPECIAL_PROGRAM_NC SPART_FILE_NAME SPART_CSV_FILE_NAME SPART_STOCK_BATCH SPART_STOCK_BRAND SPART_STOCK_COLOR SPART_STOCK_COMMENT SPART_STOCK_ID : (>=6.10) SPART_STOCK_NAME: (>=6.10)
[out]	sVal	string info

PCALL(SPI_GEN_get_string_oem,SPART_FILE_NAME,sval1);

SPI_GEN_get_system_variable()

void SPI_GEN_get_system_variable	(	const std::string &	varName,
		std::string &	contents )

Reads the contents of a Windows system variable.

Version

4.4

Parameters

[in]	varName	variable name
[out]	contents	content of the variable

PCALL(SPI_GEN_get_system_variable,'PATH',str_path);

SPI_GEN_get_type_plane()

int SPI_GEN_get_type_plane

(

int

planeNb

)

Reads the type of plane.

Version

4.4

Parameters

[in]

planeNb

index of the GO2cam plane

Returns

type of plane

Type of plane :

• 0 plane by points
• 1 plane developpe
• 2 plane cut
• 3 plane specific
• 4 plane of Frenet
• 5 plane angle
• 6 plane machining
• 8 plane revolution (turning)
• 9 plane return (turning)
• 10 plane rework (turning)
• 13 plane Axial Revolution
• 14 plane Radial Revolution
• 15 Plane Axe B
• 16 plane Radial Hole
• 17 plane Axis B Hole
• 18 plane Face
• 19 plane Top
• 20 plane Side

typ_plan := ICALL(SPI_GEN_get_type_plane,3);

SPI_GEN_hide_solids()

int SPI_GEN_hide_solids

(

)

Hides solids (works only with layout design module)

Version

5.5

Returns

SPI_NO/SPI_YES

Pascal example
imodule := ICALL(SPI_GEN_hide_solids);
 
VB Example
Iret = GOE.SPI_GEN_hide_solids

SPI_GEN_load_user_msgfile()

int SPI_GEN_load_user_msgfile	(	const std::string &	dir,
		const std::string &	name )

Opens a user message file.

Version

6.05

Parameters

[in]	dir	directory
[in]	name	file name

Returns

SPI_YES / SPI_NO

Remarks

The file must be UTF-8 with BOM with same format as GO2cam msg files
version|0|nomsg|message (0 is family)
The file will be automaticaly closed at end of spi, process, ....

ierr := ICALL(SPI_GEN_load_msgfile,mydir,myfile);

See also

SPI_GEN_read_user_message

SPI_GEN_new_part()

void SPI_GEN_new_part

(

)

Resets the part (=NEW)

Version

4.4

PCALL(SPI_GEN_new_part);

SPI_GEN_prepare_reexecution()

void SPI_GEN_prepare_reexecution

(

int

reexecType

)

Prepares the part reexecution. The reexecution is done just after the macro in Pascal
In VB, Delphi ... it runs directly.

Version

4.4

Parameters

[in]

reexecType

1 total reexecution 2 partial reexecution geometry 3 partial reexecution machining cycles

Remarks

Type_reexec+10 performs redraw after reexecution

PCALL(SPI_GEN_prepare_reexecution,1);

SPI_GEN_read_current_module()

int SPI_GEN_read_current_module

(

)

Reads current running module.

Version

5.5

Returns

1 : milling
2 : lathe
3 : EDM
4 : swiss turn
5 : vertical lathe
6 : Modele
7 : drawing
8 : Symbols geometry creation
9 : Robot
10: Symbols machining creation
11: Kinematic
12: Multi-parts machining
15: OEM (V5.10)
16: GO2operator
17: Kinematic component
18: Milling with turning head
SPI_NO if unknow module

Pascal example
imodule := ICALL(SPI_GEN_read_current_module);
 
VB Example
Iret = GOE.SPI_GEN_read_current_module

SPI_GEN_read_docxls_message()

void SPI_GEN_read_docxls_message	(	int	messNb,
		std::string &	mess )

Reads the message contained in file MSG_DOCX.DAT.

Parameters

[in]	messNb	message number
[out]	mess	message read (CH80)

Remarks

The chain must be initialized by default, because if the message does not exist the chain is returned
The string must be allocated at 80 characters

PCALL(SPI_GEN_read_docxls_message,12,msg);

SPI_GEN_read_message()

void SPI_GEN_read_message	(	int	verNb,
		int	messNb,
		std::string &	mess )

Reads the message contained in the file MSG_PROC.DAT.

Parameters

[in]	verNb	message version number
[in]	messNb	message number
[out]	mess	message read (CH80) (empty if not found)

Remarks

mess must be initialised ( mess[0] := chr(0) )

PCALL(SPI_GEN_read_message,0,12,msg);

SPI_GEN_read_msgmess()

void SPI_GEN_read_msgmess	(	int	verNb,
		int	messNb,
		std::string &	mess )

Reads the message contained in file MSG_MESS.DAT.

Parameters

[in]	verNb	message version number Values for Nover : 0 : GENERAL 1 : LATHE 2 : WIRE EDM 4 : 3D 6 : MILLING 9 : GDAO 10 : PPG 11 : OUTIL 12 : OP LIST
[in]	messNb	message number
[out]	mess	message read (CH255)

Remarks

The chain must be initialized by default because if the message does not exist the chain is returned
The string must be allocated to 255 characters

PCALL(SPI_GEN_read_msgmess,0,12,msg);

SPI_GEN_read_name_layer()

int SPI_GEN_read_name_layer	(	int	layerNb,
		std::string &	familyName,
		std::string &	layerName )

Reads the family name and the layer name by its numerical value.

Parameters

[in]	layerNb	layer number
[out]	familyName	layer group name
[out]	layerName	layer name

Returns

SPI_YES if Ok | SPI_NO if error

Remarks

If the name is not found, the 2 strings are initialized to ""

ier := ICALL(SPI_GEN_read_name_layer,1,Fname,Lname);

SPI_GEN_read_panmess()

void SPI_GEN_read_panmess	(	int	verNb,
		int	messNb,
		std::string &	mess )

Reads the message contained in file MSG_PANE.DAT.

Parameters

[in]	verNb	message version number
[in]	messNb	message number
[out]	mess	message read (CH255)

Remarks

The chain must be initialized by default because if the message does not exist the chain is returned
The string must be allocated to 255 characters

PCALL(SPI_GEN_read_msgmess,0,12,msg);

SPI_GEN_read_user_message()

void SPI_GEN_read_user_message	(	int	mesNb,
		std::string &	mess )

Reads the message contained in file open with SPI_GEN_load_user_msgfile.

Version

6.05

Parameters

[in]	mesNb	message number
[out]	mess	message read (CH80)

Remarks

The chain must be initialized by default because if the message does not exist the chain is returned
The string must be allocated to 80 characters

PCALL(SPI_GEN_read_user_message,12,msg);

SPI_GEN_select_element_oem()

int SPI_GEN_select_element_oem

(

int

eltNb

)

Selects a tooth element for getting values (Tooth ..)

Version

5.10.205

Parameters

[in]

eltNb

element number (1..n)

Returns

SPI_YES if Ok | SPI_NO if error

SPI_GEN_select_information()

int SPI_GEN_select_information	(	int	typTec,
		int	index )

Selects a tool or machine structure index for SPI_GEN_get.

Version

6.02

Parameters

[in]	typTec	TEC_ATTACHE tool holder TEC_TOURELLE machine turret TEC_OUTFIX machine fixed tool TEC_JAUGE machine gauge
[in]	index

Returns

SPI_YES if Ok | SPI_NO if error

ier := ICALL(SPI_GEN_select_information,TEC_TOURELLE,1);

SPI_GEN_select_part_oem()

int SPI_GEN_select_part_oem

(

int

stockNb

)

Selects a stock for reading specifics values.

Version

6.02

Parameters

[in]

stockNb

stock number (1..n)

Returns

SPI_YES if Ok | SPI_NO if error

SPI_GEN_set_angle_unit()

void SPI_GEN_set_angle_unit	(	int	unit,
		int	decimalNb )

Set unit angle.

Version

6.10

Parameters

[in]	unit	unit angle among the values : SPI_ANGLE_DEGRE SPI_ANGLE_DMS SPI_ANGLE_RADIAN SPI_ANGLE_GRADE
[in]	decimalNb

SPI_GEN_set_information()

int SPI_GEN_set_information	(	int	key,
		const std::string &	value )

Modifies GO2cam working directories or PartName.

Version

5.6

Parameters

[in]	key	keyword See the file RES_ISPI.DAT SEN_PART_DIRECTORY : part directory SEN_PROCESS_DIRECTORY : process directory SEN_PROCESS_SPECIF_DIRECTORY : custom processus directory SEN_TOOL_DIRECTORY : tool directory SEN_FORM_DIRECTORY : tool shape directory SEN_TECHNO_DIRECTORY : technologies directory SEN_MATERIAL_DIRECTORY: material directory SEN_MACHINE_DIRECTORY : machine directory SEN_PPSTD_DIRECTORY : Standard post-processor directory SEN_PP_DIRECTORY : Custom post-processor directory SEN_DOCUMENT_DIRECTORY :Filled documments directory SEN_ISO_DIRECTORY : G code files directory SEN_OLE_DIRECTORY : OLE for DM directory SEN_PART_NAME : Part name
[in]	value	value to assign

Returns

SPI_YES si Ok | SPI_NO if error

SPI_GEN_set_integer_information()

void SPI_GEN_set_integer_information	(	int	key,
		int	value )

Writes system information in GO2cam according to the key (EEN_COLOR_NUMBER, EEN_LAYER_NUMBER, ...)

Version

6.01.206

Parameters

[in]	key	request keywords Availables keywords are : EEN_* : Environnement keywords (EEN_COLOR_NUMBER ...) EEN_COLOR_NUMBER : Current color EEN_LAYER_NUMBER : Current layer EEN_PLANE_NUMBER : Current Plane EEN_CYCLE_OPTIMIZATION : 1=tool,2=plane,3=without EEN_PROFIL_CANCELLATION: profil cancellation after use BEN_ROTARY_AXIS_POSITION_HOLE : change a state of rotary axis positioning in hole selection EEN_EDGE_DISPLAY : Mode edge display : 1=None, 2=Fast, 3=Realistic
[in]	value	integer value of the key

PCALL(SPI_GEN_set_integer_information,EEN_LAYER_NUMBER,10);

SPI_GEN_set_length_unit()

void SPI_GEN_set_length_unit	(	double	factorToMM,
		int	decimalNb,
		int	bFractional )

Set length unit.

Version

6.10

Parameters

[in]	factorToMM	: conversion factor to millimeter
[in]	decimalNb	: number of decimals
[in]	bFractional	: SPI_YES / SPI_NO to tell if imperial dimension uses fraction

SPI_GEN_set_machining_unit()

void SPI_GEN_set_machining_unit	(	int	meter,
		int	decimalNb )

Set machining units.

Version

6.10

Parameters

[in]	meter	: SPI_YES / SPI_NO (imperial)
[in]	decimalNb	: number of decimals used only if unit change

SPI_GEN_set_mass_unit()

void SPI_GEN_set_mass_unit

(

int

unit

)

Set mass unit.

Version

6.10

Parameters

[in]

unit

unit among following values : SPI_MASS_MICROGRAM SPI_MASS_MILIGRAM SPI_MASS_CENTIGRAM SPI_MASS_DECIGRAM SPI_MASS_GRAM SPI_MASS_DECAGRAM SPI_MASS_HECTOGRAM SPI_MASS_KILOGRAM SPI_MASS_TONNE SPI_MASS_OUNCE SPI_MASS_POUND

SPI_GEN_set_NC_format()

void SPI_GEN_set_NC_format

(

const std::string &

Sformat

)

Sets up NC format éditor used by post-processor.

Version

6.08

Parameters

[in]

Sformat

label to identify format

SPI_GEN_set_real_information()

void SPI_GEN_set_real_information	(	int	key,
		double	value )

Write GO2cam information via a key.

Version

6.10.213

Parameters

[in]	key	request keywords Availables keywords are : REN_* : Environnement keywords (REN_STOCK_BAR_LENGTH) RM_* ,RMT_* : Material and Machine keywords See the file RES_ISPI.DAT
[in]	value	real value of the key

PCALL(SPI_GEN_set_real_information,REN_STOCK_BAR_LENGTH,length);

SPI_GEN_set_string_oem()

void SPI_GEN_set_string_oem	(	int	id,
		const std::string &	sVal )

Writes string informations by a key in OEM.

Version

6.09

Parameters

[in]	id	integer ident SDENT_SPECIAL_PROGRAM_NC
[out]	sVal	string info

PCALL(SPI_GEN_set_string_oem,SDENT_SPECIAL_PROGRAM_NC,sval1);

SPI_GEN_show_meshs()

void SPI_GEN_show_meshs

(

int

show

)

Displays meshs.

Version

6.10

Parameters

[in]

show

integer 0 => hide, 1 => show

Pascal example
PCALL(SPI_GEN_show_meshs,1);
 
VB Example
GOE.SPI_GEN_show_meshs(1);

SPI_GEN_show_solids()

int SPI_GEN_show_solids

(

)

Displays solids (works only with layout design module)

Version

5.5

Returns

SPI_NO/SPI_YES

Pascal example
imodule := ICALL(SPI_GEN_show_solids);
 
VB Example
Iret = GOE.SPI_GEN_show_solids

SPI_GEN_test_bit_validity()

int SPI_GEN_test_bit_validity

(

int

bitNumber

)

Tests if a bit is active in current licence.

Version

6.09

Parameters

[in]

bitNumber

bit number to test

Returns

SPI_YES if Ok | SPI_NO if unvalid option

valid := ICALL(SPI_GEN_test_bit_validity,45);

SPI_GEN_test_option_validity()

int SPI_GEN_test_option_validity

(

int

option

)

Tests if an option is available in current licence.

Version

6.03

Parameters

[in]

option

option to test 1 => MTE

Returns

SPI_YES if Ok | SPI_NO if unvalid option

valid := ICALL(SPI_GEN_test_option_validity,1);

SPI_GEN_test_specif_bit_validity()

int SPI_GEN_test_specif_bit_validity

(

int

bitNumber

)

Tests if a specific bit is active in current licence.

Version

6.09

Parameters

[in]

bitNumber

specific bit number to test

Returns

SPI_YES if Ok | SPI_NO if unvalid option

valid := ICALL(SPI_GEN_test_bit_validity,45);

SPI_GEN_write_information_part()

int SPI_GEN_write_information_part	(	int	ind,
		const std::string &	answer )

Writes information in the part.

Version

4.7

Parameters

[in]	ind	line index to write (If ind does not exist => add)
[in]	answer	comment to write

Returns

SPI_YES if Ok | SPI_NO if error

PCALL(SPI_GEN_write_information_part,1,ligne);

SPI_GEN_write_name_layer()

int SPI_GEN_write_name_layer	(	int	idx,
		const std::string &	name )

writes the name of a layer defined by its index

Version

5.7

Parameters

[in]	idx	layer number
[in]	name	layer name

Returns

SPI_YES if Ok | SPI_NO if error

Pascal :
ier,idx        : INTEGER;
layer_name     : TC80;
ier := ICALL(SPI_GEN_write_name_layer,idx,layer_name);
 
Visual Basic
Dim ier as Integer
Dim idx as Integer
Dim layer_name as String
ier = GOE.SPI_GEN_write_name_layer(idx,layer_name)

SPI_GEN_write_next_file()

void SPI_GEN_write_next_file

(

const std::string &

fileName

)

Writes the name of SPI file to be autorun after the end of the
current SPI.

Version

4.4

Parameters

[in]

fileName

SPI file name (ie:'TEST.SPI' )

PCALL(SPI_GEN_write_next_file,'MACRO.SPI');