GPP2 System Flags

GPP2 has several system variables, also known as "system flags", that can be used by the EX2 Program to affect the way GPP2 operates. They are set or modified by the EX2 program, and later read internally by the GPP2 engine.

Some of these system flags are also dynamically set by the GPP2 engine throughout the execution. Others are only initialized with the default value and later set by the EX2 application.

The default format for each system flag is shown in parenthesis after the variable name. The format is quite meaningless, since all that matters is the value (true or false).

System Flag/Variable	Default value	Set by GPP2	Use and comments
A_RESET_AXIS	FALSE_	No	If set to TRUE_, GPP2 will reset the primary axis, A.
B_RESET_AXIS	FALSE_	No	If set to TRUE_, GPP2 will reset the secondary axis, B.
CONNECT_FORCED	FALSE_	Yes	Indicate if a connection is forced or not.
CUT_FILE (format 6)	FALSE_	Yes (for a very short period until the file is cut)	If set to TRUE_, GPP2 will cut the output tape (file) and start a new one. In the process, it will call the END OF TAPE and BEGINNING OF TAPE blocks with the proper qualifiers (beforecut and aftercut, respectively). After the tape cut, the flag is reset to FALSE_ again. GPP2 automatically sets the variable when the tape needs to be cut because of excessive length, as defined in the DF2 file.
FORCE_CONNECT_IF_INPLACE	FALSE_	No	If set to TRUE_, a regular GPP2 connection is forced in an "In-Place Connection" situation. The CONNECT IN PLACE block is not invoked.
FORCE_LOCALE_DECIMAL	FALSE_	No	Set to TRUE_ in order to read the decimal point character from the local PC regional settings. Relevant for NC Report posts (not used in regular posts, where the DF2 setting is quite sufficient).
MINMAX_SPINDLE	FALSE	No	Defines the actual point being described by all the min and max variables (X_MIN, X_MAX, etc.). When set to TRUE_, all these variables describe the min and max values of the spindle center point, ignoring the tool itself. When set to FALSE_ (the default!), these variables describe the tool tip point min and max locations.
MINMAX_VS_MACH	TRUE	No	Affects the reference point of all the min and max variables (X_MIN, X_MAX, etc.). When set to TRUE_ (the default!), all these variables refer to the machine zero point (machine table center). When FALSE_, all these variables refer to the REF UCS zero point.
MOVE_TO_SAFE	-	Yes (in response to the EX2 program setting it first)	Used to instruct GPP2 to move to the safe position. This is useful at the end of the run, or in conjunction with a tool change. In order to instruct GPP2 to move, the EX2 program has to set the GPP2 system flag, MOVE_TO_SAFE, telling GPP2 which axes to move. MOVE_TO_SAFE must be set to a string that contains one or more of the axis letters, X, Y, Z, A and B. Uppercase or lower case letters may be used.
OFST_TOOL_CENTER	FALSE_	No	If set to TRUE_, GPP2 will offset the tool output coordinates from the tool tip to the tool center, by moving them along the tool axis. The offset is defined the tool radius, as appears in the TOOL_RAD variable. This works properly for ball tools, but is risky for other tool shapes. The only coordinates affected are X/Y/Z_CURPOS and X/Y/Z_CENTER. Other coordinates, such as the procedure origin, are not affected. Note: OFST_TOOL_CENTER should be set at the STARTUP block.
OUTPUT_AS_CYCLE (format 6)	FALSE_	No	If a cycle output is required instead of the regular one, this flag should be set as TRUE_. This will suspend the regular output. The machine simulator will get the regular motions.
OUTPUT_SUSPEND (format 6)	FALSE_	No	If set to TRUE_, GPP2 will suspend all output statements (OUTPUT, PRINT1, etc.). When output is suspended, the new-line-is block is not executed at all.
REQUEST_RECONFIG (format 6)	FALSE_	No	If set to TRUE_, GPP2 will start a machine re-configuration process and invoke the RECONFIG MACHINE block. See a detailed description regarding machine reconfiguration and 6X machines.
SET_REF_BY_ORIGIN (format 6)	FALSE_	Yes (in response to the EX2 program setting it first)	When set to TRUE_ in the ORIGIN CHANGE block, GPP2 will modify the REF UCS to be the origin UCS defined in that block. See the section on using Multiple Part Setups. GPP2 will then reset the flag back to FALSE_. This system flag is only checked in the ORIGIN CHANGE block.
TEMPLATE_SETUP (format 0)	As defined in DF2 file	No	Name of template file for NC Setup report (not including the .mht extension). The EX2 program may override the default value in the STARTUP block (only).
TEMPLATE_TOOLS (format 0)	As defined in DF2 file	No	Name of template file for Tools report (not including the .mht extension). The EX2 program may override the default value in the STARTUP block (only).
TOOL_NUM_OFFSET	0	No	This offset number is added to every tool number coming from Cimatron. It affects the TOOL_NUM variable in every TOOL CHANGE block (as well as in the Tools report).
TOOL_REPORT_SORT	0 (TOOLS_REPORT_ORDER_BY_USE)	No	Affects the order of tools in the tool report. Set to one of these values in the STARTUP block. Tools will be listed as follows: 0 – By tool use order, as today (default). 1 – By tool magazine number (by TOOL_NUM). 2 – By tool name (by TOOL_NAME).
TRACE_EXECUTE (format 6)	FALSE_	No	If set to TRUE_, GPP2 will start a detailed trace of each command execution. See the GPP2 language reference manual for details.
TRACE_LINENO (format 6)	FALSE_	No	If set to TRUE_, GPP2 will start tracing the G-code output by preceding each output line with the line number of the (first) EX2 command that created the line. See GPP2 Language Reference Manual for details.
TRACE_SINGLESTEP (format 6)	FALSE_	No	If set to on, GPP2 will enter step-by-step debugging mode, where the execution of each command is shown on the screen, and GPP2 pauses after each command. TRACE_EXECUTE must also be TRUE_ in order to use this mode. See the GPP2 Language Reference Manual for details.
TRACE_TPBLOCK (format 6)	FALSE_	No	If set to TRUE_, GPP2 will start tracing the G-code output by preceding each output line with the toolpath block number. See GPP2 Language Reference Manual for details.

Some functionality may be dependent on the product package. Contact your Reseller if you require a license.