Register List

INCT_SysState - machine-stand system status interface. At the moment, the interface provides work with the generated list of registers (taking into account the settings file, the program library and the interpreter's parents). To distinguish the generated list of registers from the initial registers of the interpreter, the settings file and the parent interpreters, the generated list of registers is called the base list of registers.

Description of interface methods:

Method	Method Description	Description of use
FindFirstRegister	The function returns the first, found by address, base register (interface INCT_BaseReg). Input parameter: Addr (string) - register address	The function can be used to search for the base register by address when analyzing the text of the G-code for implementing INCT_Interpreter.TransLine.
FindNextRegister	The function returns the next one, starting from FromIdx, found at the address of the base register (interface INCT_BaseReg). Input parameter: FromIdx (integer) - the starting index, Addr (string) - the address of the register	The function can be used to search for the base register by address when analyzing the text of the G-code for implementing INCT_Interpreter.TransLine.
Get_BR_ByIndex	The function returns the base register by index (INCT_BaseReg interface) Input parameter: Index (integer) - register index.	The function can be used to obtain the base register by index when searching the base registers (for example, to obtain the initial values of the tool position axes associated with the base registers).
Get_BR_ByName	The function returns the base case by name (interface INCT_BaseReg) Input parameter: Name (integer) - the name of the register.	The function can be used to search for the base register by name, to determine the index of the register when implementing INCT_Interpreter.DefineRegister.
Get_BR_Count	The function returns the number of base registers.	The function can be used to obtain the number of base registers for subsequent enumeration of base registers (for example, to obtain initial values of tool position axes associated with base registers).

INCT_SysState2 - machine-stand system status interface.

Description of interface methods:

Method	Method Description	Description of use
Get_SpindleState	The function returns the spindle states (INCT_SpindleState interface).	Spindle states are used to store and exchange information between the interpreter and its parent(s).
Get_Reg_ByIndex	The function returns the register by index (INCT_Register interface). Input parameter: Index (integer) - the register index.	The function can be used to search for a register by name or by iterating through the required parameter. For example, to retrieve the values of the register INCT_Register.Values (which are not available in INCT_BaseReg).
Get_Reg_ByName	The function returns the register by name (INCT_Register interface). Input parameter: Name (string) - the register name.
Get_Reg_Count	The function returns the number of basic registers.

INCT_SpindleState - spindle state interface. The spindle state is shared between the interpreter and its parent(s). It is intended for storing and exchanging the spindle state between the interpreter and its parent(s).

Description of interface methods:

Метод	Описание метода
Get_MaxSpeed	The function returns the maximum spindle speed (real number).
Set_MaxSpeed	The method sets the maximum spindle speed. Input parameter: Value (real number) - maximum spindle speed.
Get_RPMSpeed	The function returns the spindle speed (real number) when the constant cutting speed mode is off (Get_CSS = False).
Set_RPMSpeed	The method sets the spindle speed. Input parameter: Value (real number) - spindle speed.
Get_CSSSpeed	The function returns the spindle speed (real number) for the constant cutting speed mode (Get_CSS True).
Set_CSSSpeed	The method sets the spindle speed for the constant cutting speed mode. Input parameter: Value (real number) - spindle speed.
Get_Range	The function returns the spindle speed range number (integer).
Set_Range	The method sets the spindle speed range number. Input parameter: Value (integer) - spindle speed range number.
Get_Direction	The function returns the spindle rotation direction (boolean).
Set_Direction	The method sets the spindle rotation direction. Input parameter: Value (boolean) - spindle rotation direction. True - clockwise False - counterclockwise
Get_CSS	The function returns the constant cutting speed flag of the spindle (boolean).
Set_CSS	The method sets the constant cutting speed flag of the spindle. Input parameter: Value (boolean) - constant cutting speed flag of the spindle. True - constant cutting speed mode is enabled False - constant cutting speed mode is disabled
Get_MaxRPM	The function returns the maximum number of rotations for the constant cutting speed of the spindle (real number) (Get_CSS = True).
Set_MaxRPM	The method sets the maximum number of revolutions for the constant cutting speed of the spindle. Input parameter: Value (real number) - maximum number of revolutions.
Get_Angle	The function returns the angle of the oriented spindle stop (real number).
Set_Angle	The method sets the angle of the oriented spindle stop. Input parameter: Value (real number) - angle of the oriented spindle stop.
Get_Command	The function returns the spindle status (last executed command) (TNCSpindleCommand).
Set_Command	The method sets the spindle status (last executed command). Input parameter: Value (TNCSpindleCommand) - spindle status. scOn - enabled scOff - disabled scOrient - oriented stop
Get_IsChanged	The function returns the flag indicating any change in the INCT_SpindleState parameters, except for the spindle number, since the last spindle command execution (boolean). True - one of the parameters has changed False - parameters have not changed
Set_IsChanged	The method sets the flag indicating any change in the INCT_SpindleState parameter, except for the spindle number, since the last spindle command execution. This is used when inheriting interpreters. The command to turn the spindle on/off/stop is executed by one of the interpreters, usually the last inheritor. Input parameter: Value (boolean) - flag indicating a parameter change.
Get_Num	The function returns the spindle number (integer).
Set_Num	The method sets the spindle number. Input parameter: Value (integer) - spindle number.
Get_IsChangedNum	The function returns the flag indicating a change in the spindle number (boolean).
Set_IsChangedNum	The method sets the flag indicating a change in the spindle number. Input parameter: Value (boolean) - flag indicating a change in the spindle number.

INCT_BaseReg - the interface provides work with the base register.

Description of interface methods:

Method	Method Description	Description of use
SetValue	The method sets a new value to the base register. The base register has three fields for storing a value — a string, a fractional number, an integer. If the new value is not empty, then it is written in a field with a string, converted and written into fields with integer and fractional numbers. Input parameter: Value (string) - new register value.	The function can be used in the interpretation of tokens and semantic structures that affect the value of the register (for example, functions).
Get_Addr	The function returns the address of the base register (string). No input parameters.	Functions can be used to obtain the corresponding parameters of the base register during the initialization, translation or interpretation of the text of the G-code.
Get_Name	The function returns the name of the base register (string). No input parameters.
Get_Id	The function returns the identifier of the base register in the kinematic scheme of the machine (string). No input parameters.
Get_Idx	The function returns the index of the base register in the register list (integer). No input parameters.
Get_Str	The function returns the string value of the base register (string). No input parameters.
Get_Int	The function returns the numeric value of the base register (integer). No input parameters.
Get_Flt	The function returns the numeric value of the base register (integer). No input parameters.