Variables for Control Texts (CAM)

In all control texts that are used to configure the postprocessor you have access to a huge number of variables. Some of these come directly from the options dialogs of the CAM plug-in or the postprocessor, others are computed during export by the postprocessor and can subsequently be used for the output. All variables (if applicable) contain values in the currently specified unit of the postprocessor. The display of numbers (decimal separator, decimal places, etc.) of numerical variable content as well as the query and assignment of variables is realized by means of Statements in Texts.

The following list contains all variables that are provided by the CAM plug-in and the postprocessor to be used inside the control texts of the postprocessor.

General CAM Variables

The general variables remain unchanged during the whole export process, unless they are explicitly changed inside a control text, e.g. {=Q99 {#~Q99~+1}}. However, only changes of the Q/T-parameters are saved permanently. The general variables originate either from the dialog "General Parameters" of the CAM plug-in or are initialized as described here.

~ToolChangeCommands~

~MachinePosX~

~MachinePosY~

~HighVel~

~LibraryName~

~GlobalComment~

~CAMProjectName~

~CAMProjectPath~

~Q0~ to ~Q99~

~Q0:~ to ~Q99:~

~T0~ to ~T9~

~T0:~ to ~T9:~

Postprocessor Setting Variables

These postprocessor variables remain unchanged during the whole export process, unless they are explicitly changed inside a control text, e.g. {=Q199 {#~Q199~+1}}. However, only changes of the Q/T-parameters are saved permanently. The postprocessor variables originate from the "Edit Postprocessor" dialog.

~PrgName~

~FileName~

~Title~

~Info~

~Units~

~MAWidth~

~MAHeight~

~MADirection~

~MAOverlapping~

~Comment~

~SingleQuadrant~

~Q100~ to ~Q199~

~Q100:~ to ~Q199:~

~T10~ to ~T19~

~T10:~ to ~T19:~

Postprocessor Chain Variables

The postprocessor chain variables are initialized before the execution of a Postprocessor Chain and remain unchanged during the entire execution of a postprocessor chain - i.e. over several export processes (exception ~PPChainIndex~). These variables can be used to reuse values determined by a postprocessor in a postprocessor following in the chain.

~PPChainIndex~

~PPChainP0X~ to ~PPChainP9X~

~PPChainP0Y~ to ~PPChainP9Y~

~PPChainValue0~ to ~PPChainValue9~

~PPChainCount0~ to ~PPChainCount9~

~PPChainFlag0~ to ~PPChainFlag9~

~PPChainText0~ to ~PPChainText9~

Tool Variables

The tool variables change each time a tool change occurs (exception for ~MillingRadiusComp~ refer to (*)). They originate from "Tool List" dialog of the CAM plug-in. If a tool variable is used inside a control text for which it is not possible to retrieve a tool (for example the control text for program start) then the tool variables are initialized with the default tool or (if the user didn't define a default tool) with tool no. 0. You can change Q/T-parameters inside a control text explicitly, e.g. {=Q199 {#~Q199~+1}}. These changes of Q/T-parameters are saved permanently for the respective tool.

~ToolName~

~ToolIndex~

~ToolComment~

~MachineToolNo~

~ZClearance~

~ZEngage~

~InfeedDepth~

~InfeedOffset~

~InfeedNumberOfIncrements~

~InfeedIncrementValue~

~ZEngage~ and the four ~Infeed[..]~ variables are used to calculate the working variables ~ZWorking~ and ~Z0~/~Z1~ (refer to ~SpecialMode~ and ~ToolControl7~).
You should explicitly use the four ~Infeed[..]~ variables only in the control texts of cycles (attributes) or points (markings).

~MovingVel~

~LoweringVel~

~AltMovingVel~

~Acceleration~

~ToolRadius~

~ToolDiameter~

~ToolLength~

~SpecialMode~

~UserControl~

~ToolControl0~

~ToolControl1~

~ToolControl2~

~ToolControl3~

~ToolControl4~

~ToolControl5~

~ToolControl6~

~ToolControl7~

~MillingSpindleRate~

~MillingSpindleDir~

~MillingRadiusComp~

~MillingDelay1~

~MillingDelay2~

~MillingAllowanceDepth~

~MillingAllowanceSide~

~MillingExtraParam1~

~MillingExtraParam2~

~WaterJetStartAbrasive~

~WaterJetStartPressure~

~WaterJetStartTime~

~WaterJetCuttingAbrasive~

~WaterJetCuttingPressure~

~WaterJetCuttingAngleThreshold~

~WaterJetCuttingAngleDelay~

~WaterJetCuttingOffDelay~

~LaserStartPower~

~LaserStartPulseFrequency~

~LaserStartPulseDuration~

~LaserStartTime~

~LaserCuttingPower~

~LaserCuttingPulseFrequency~

~LaserCuttingPulseDuration~

~LaserCuttingOffDelay~

~CuttingPower~

~CuttingCutterPressure~

~CuttingOffset~

~CuttingAngleThreshold~

~CuttingOscillation~

~CuttingQuality~

~CuttingStartAngle~

~CuttingDelay~

~ToolParam1~

~ToolParam2~

~ToolParam3~

~ToolParam4~

~ToolParam5~

~ToolParam6~

~ToolParam7~

~ToolParam8~

~Q200~ to ~Q399~

~Q200:~ to ~Q399:~

~T20~ to ~T39~

~T20:~ to ~T39:~

Working Variables

The working variables change at different times during the export or are only available (i.e. contain meaningful data) inside certain control texts respectively. Please pay attention to the green numbers in parentheses and the corresponding explanations at the end of this section.

When the control text for tool change is called the tool is always located at safety height (~ZClearance~). At the end of the control text for tool change the tool always has to be moved back at rapid speed to safety height.

If the the control text for contour start is called and ~UpdateXYPosition~ is true (1) then the tool is always located at safety height, otherwise it is located inside the material (or with distance ~ZEngage~ on top of it). When the control text for contour end is called and ~UpdateXYPosition~ is false (0) the tool is moved to safety height at rapid speed (before that it can optionally be retracted from the current infeed depth ~Z1~ to working height ~ZWorking~). If ~UpdateXYPosition~ is true (1) here, the tool is already at safety height.

~LineNumber~

~MachineToolMode~

~ZWorking~

~Z0~

~Z1~

~ZWorking~ and ~Z0~/~Z1~ are calculated using ~InfeedDepth~, ~InfeedOffset~, and ~InfeedNumberOfIncrements~/~InfeedIncrementValue~. In case of infeed depth (~ToolControl7~ is 0) ~InfeedDepth~ is subtracted from the working variables ~ZWorking~ and ~Z0~/~Z1~. In the case of operation height (~ToolControl7~ is 1), this happens analogously, but ~InfeedDepth~ and ~InfeedOffset~ have inverted signs here.
If ~SpecialMode~ contains zero or ~ToolControl7~ is 1 then ~Z0~ always equals ~Z1~.

~ZIncrementIndex~

~UpdateXYPosition~

~X1~/~Y1~

~UpdateCutterRotationOnly~

~CutterRotation~

~ContourXYLength~

~FirstContourElement~

~LastContourElement~

~EngravingFirst~

~EngravingSecond~

~EngravingLast~

~ClosedContour~

~ContourIndex~

~LastContour~

~ContourDirection~

~RealCircle~

~MergeWithContour~

~UseAuxPoint~

~MovingVelRequired~

~StartOfCycleSequence~

~EndOfCycleSequence~

~PrevCycleBlockName~

~StartOfPointSequence~

~EndOfPointSequence~

~MALength~

~ContourSubprogramActive~

~CSLB~

~FrameXMin~

~FrameYMin~

~FrameZMin~

~FrameXMax~

~FrameYMax~

~FrameZMax~

~P0X~ to ~P5X~,

~P0Y~ to ~P5Y~,

~P0~ to ~P9~,

~Cmd1~ and ~Cmd2~,

~PStartX~ and ~PStartY~,

~PEndX~ and ~PEndY~,

~FlagStart~ and ~FlagEnd~,

~Flag0~ to ~Flag4~,

~Count0~ to ~Count4~,

~Value0~ to ~Value4~

~ExportAbortCode~ und ~ExportAbortText~

 (1) The variable ~ExportAbortCode~ is initialized with zero. If an integer other than zero is assigned to this variable in any control text (e.g. {=ExportAbortCode {#1}}), the export is stopped without creating a file. A message then appears that displays both the value of the variable ~ExportAbortCode~ and the text content of the variable ~ExportAbortText~ (this is initialized with an empty text). Therefore, the text content of the variable ~ExportAbortText~ should always be changed together with ~ExportAbortCode~ in the same control text (e.g. {=ExportAbortText {$Incorrect tool parameter}}). If required, the text to be displayed can contain line breaks. To do this, insert the character string \n at the desired positions (e.g. {=ExportAbortText {$Incorrect tool parameter.\nPlease check the tool list.}}).

~ExportNotification~

 (1) The variable ~ExportNotification~ is initialzed with an empty text. If the variable contains a text after the export, this is briefly displayed as a notification on the CAD6 drawing area or is available via the Manage > Notifications command. The text content of the variable can be set in any control text (e.g. {=ExportNotification {$A cycle was exported.}}). The texts set in this way in a control text are automatically appended to one another and displayed together at the end. If only a single text is to be displayed as a notification at the end, it must begin with the character string \0 (e.g. {=ExportNotification {$\0There was at least one tool change.}}). The character string \n creates a line break.

Object Variables

The object variables described here usually contain only meaningful data during the export of the respective object type, i.e., they can be only used inside the corresponding object control text. However, there are exceptions: The variables ~AuxX~ and ~AuxY~ possibly contain meaningful data also during contour start/end (refer to ~UseAuxPoint~), this is also true for the variables ~PrevX~/~PrevY~ and ~XIncr~/~YIncr~ (see below). In addition to that object property variables are also valid in the control text for tool change (see below). The variables ~X0~/~Y0~ and ~X1~/~Y1~ are also used as working variables during the contour start and contain in the control text for contour end the current contour end point.

If the control texts for the object types line, circular arc, and Bézier curve are called then the tool is always located at the current infeed depth ~Z0~/~Z1~ (i.e. already inside the material). The moving to the start-point at rapid speed and at clearance height (~ZClearance~) and the lowering or infeeding is done by the control text for contour start (at this time the tool is located at clearance height). In the same way the tool is lifted again and moved to clearance height by the control texts for contour end. So the control texts for the object types line, circular arc, and Bézier curve contain only infeed commands that always apply to the current infeed depth ~Z0~/~Z1~. Within these control texts a tool is never explicitly lifted or moved to clearance height.

That is NOT true for the object types cycle (attribute) and point (marking) because they are not related to the control texts for contour start/end (because they obviously are no contours). The following applies to control texts of the object types cycle (attribute) and point (marking): First of all the tool has to be moved to the respective insertion point at clearance height (at this time the tool is located at clearance height) at rapid speed, then the actual cycle or the corresponding section with blocks (lines) of the control text for point (marking) is carried out (lowering/infeeding, drilling, thread cutting, etc.), and in the end the tool always has to be moved back to clearance height.

Object Type Line:

~X0~

~Y0~

~X1~

~Y1~

~dX~

~dY~

~Len~

~Angle0~

~Angle1~

~Angle2~

~Angle3~

~Angle4~

~NoXMove~

~NoYMove~

~DiagonalMove~

Object Type Circular Arc:

~X0~

~Y0~

~X1~

~Y1~

~X2~

~Y2~

~XM~

~YM~

~XMRel~

~YMRel~

~Radius~

~Angle0~

~Angle1~

~Angle2~

~Direction~

~Len~

~Angle3~

~Angle4~

Object Type Bézier Curve:

~X0~

~Y0~

~X1~

~Y1~

~X2~

~Y2~

~X3~

~Y3~

~dX~

~dY~

~Len~

~Angle0~

~Angle1~

~Angle2~

~Angle3~

~Angle4~

Object Type Cycle (Attribute):

If the current CAM block instance contains a control attribute named "MERGE-WITH-CONTOUR" (please refer to chapter CAM Block Types and Cycle/Control Attributes) then the variables ~AuxX~ and ~AuxY~ are not changed and all other geometric variables remain unchanged as well. At the time of merging these geometric variables contain the current values the respective object type of the contour. In case the current CAM block instance contains a control attribute named "CONTOUR-SUBPROGRAM" all geometric variables are not updated as well.

~AuxX~

~AuxY~

~X0~/~X1~

~Y0~/~Y1~

~CycleCommands~

~CycleBlockName~

~CycleURL~

~Len~

~Angle0~

~Angle1~

~dX~

~dY~

~Angle2~

Object Type Point (Marking):

~X0~/~X1~

~Y0~/~Y1~

~Len~

~Angle0~

~Angle1~

Valid in Control Texts of All Object Types as well as control texts for contour start/end:

~PrevX~

~PrevY~

~XIncr~

~YIncr~

During contour start/end these variables contain the last valid end-/insertions-point or the resulting incremental coordinates respectively.

Valid in Control Texts of All Object Types as well as control text for contour start/end and tool change:

Each of the following variables contains a current object property (after resolving all transmissions for the export, refer to General Parameters and Layers, Pens, and Transmission). The content is a copy of the content of the corresponding member of the structure MKI_XPROPERTY. For names the corresponding index from this structure is used to retrieve the name of the line pattern, pen, or layer.

~LineWidth~

~LineTypeName~

~LineTypeScale~

~LineMode~

~LineColor~

~LineAlpha~

~FillMode~

~FillColor~

~FillAlpha~

~PenName~

~LayerName~

~PageIndex~

~UseFlag~

Database Variables and Drawing Variables

In case the current object has been assigned to the active database its record cells can be accessed by entering the corresponding column titles as variable names, for example ~ObjectComment~. Please make sure that there is no name conflict between the column titles and the variable names stated above. Database variables may be used inside control texts for contour start and contour end as well as inside all control text for objects. Database variables are only available if in the postprocessor settings in the dialog "Object Control" the option "Apply active database on export" is active.

Of course you can also state database requests as described in the CAD6 Reference (refer to Variables) in any control text. In addition to that you can use customizable drawing and fixed variables (refer to Variables) in all control texts, e.g. for the file name of the drawing (~%z0~) or the current date (~%d2~).

Local attributes, outline attributes, and point attributes

You can access local attributes as well as outline and point attributes of objects, e.g. lines, curves, surfaces or instances (except cycle or control attributes) in all relevant control texts by using the attribute name as the variable name, for example ~Z-Depth~. Please note that the maximum text length is limited to 500 characters per variable. So if an attribute contains longer text, it will be cut off automatically.

These variables are generated dynamically by the postprocessor for each object listed. This means that they only exist if the corresponding local attributes or contour and point attributes are actually defined in the respective object. Therefore, you should use the non-existence statement in control texts:

{!Z-Depth {$}

{$

G01 Z{+~Z-Depth~} F{#~LoweringVel~}{?~ToolControl1~{$ M08}}

}}

Otherwise, the text (***UNDEFINED***) appears in the exported NC file at the relevant point if the variable does not exist.