Overview

The CtlType enumeration identifies the different kinds of STEP-NC elements that can appear on the process stack kept by the Adaptive class.

Applications can use this for fine-grained decisions beyond what a event provides, such as distinguishing between a move event that is a linear move, an arc move, or a helix move.

Use the get_active_type() and get_frame_type() functions to find the type of elements in the process stack.

CtlType Definition

class CtlType(IntEnum):
    UNKNOWN
    PROJECT
    EXEC
    EXEC_ASSIGN
    EXEC_IF
    EXEC_NONSEQ
    EXEC_PARALLEL
    EXEC_SELECT
    EXEC_WHILE
    EXEC_WORKPLAN
    EXEC_WORKSTEP
    EXEC_NCFUN
    EXEC_OP_COMBO
    
    OP
    OP_MILL
    OP_TURN
    OP_DRILL
    OP_BORE
    OP_BACK_BORE
    OP_TAP
    OP_RAPID
    
    OP_PROBE
    OP_PROBE_COMPLETE
    OP_PROBE_TLEN
    OP_PROBE_TRAD
    
    TP
    TP_FEEDSTOP
    TP_CUTLOC
    TP_CUTCON
    TP_AXIS
    TP_ANGLE
    TP_TAN
    TP_CONSEC
    TP_CONDIR

    CURVE

    MOVE
    MOVE_ARC
    MOVE_HELIX
    LAST_TYPE

Type Details

The values are grouped by name. The executables are flow control things like workplans, workingsteps, and selectives. They have the EXEC prefix. The operations are contents of a workingstep and have an OP prefix. The toolpaths have a TP prefix. The different individual tool movement types have a MOVE prefix.

UNKNOWN

Zero value. An unrecognized object.

PROJECT

A STEP-NC project. This is normally the first object pushed onto the stack, followed next by the main workplan.

EXEC

An unrecognized executable type.

EXEC_ASSIGN

An assignment executable

EXEC_IF

An if executable

EXEC_NONSEQ

A nonsequential object

EXEC_PARALLEL

A parallel object

EXEC_SELECT

A selective object. As the cursor walks the process, it will push one element of the selective onto the stack next.

EXEC_WHILE

A while executable.

EXEC_WORKPLAN

A workplan object. As the cursor walks the process, it will push each element of the workplan onto the stack next.

EXEC_WORKSTEP

A workingstep object. As the cursor walks the process, it will push the operation of a workingstep onto the stack next, followed by each toolpath of the operation, followed by the curves of the toolpath, etc.

EXEC_NCFUN

One of the NC Functions defined by STEP-NC.

EXEC_OP_COMBO

This is used to identify an executable that is also an operation. The object will be pushed on the stack again with its appropriate "OP" type. Several types in the STEP-NC model inherit from both concepts. Probing is one and usuallyn appears as an operation in a workingstep, but might appear in a workplan directly.

OP

An unidentified operation type

OP_MILL

A STEP-NC milling operation. There are several different subtypes of milling operations.

OP_TURN

A STEP-NC turning operation. There are several different subtypes of turning operations.

OP_DRILL

A STEP-NC drilling operation. There are several different subtypes of drilling operations.

OP_BORE

A boring or reaming operation

OP_BACK_BORE

A back-boring operation

OP_TAP

A tapping or thread drilling operation

OP_RAPID

A symbolic rapid. This is both an executable and an operation, so it may also appear as an EXEC_OP_COMBO one level higher in the stack.

OP_PROBE

A STEP-NC point probing operation. The operation will have start and end position information, a direction vector, and an expected distance that you can get with get_move_probe() and related functions.

OP_PROBE_COMPLETE

Workpiece complete probing operation

OP_PROBE_TLEN

Tool length probing operation

OP_PROBE_TRAD

Tool radius probing operation

TP

An unrecognized toolpath type.

TP_FEEDSTOP

A STEP-NC symbolic feedstop toolpath.

TP_CUTLOC

A STEP-NC explicit cutter location trajectory toolpath. This is the most common toolpath seen and describes the location in space of the tool tip. May also include the tool axis.

TP_CUTCON

A STEP-NC explicit cutter location trajectory toolpath. This is also commonly used and describe the location in space of the tool contact point plus the surface normal at that point. May also include the tool axis.

TP_AXIS

A STEP-NC raw axis trajectory toolpath.

TP_ANGLE

A STEP-NC symbolic approach lift path angle toolpath.

TP_TAN

A STEP-NC symbolic approach lift path tangent toolpath.

TP_CONSEC

A STEP-NC symbolic connect by securty plane toolpath.

TP_CONDIR

A STEP-NC symbolic connect direct toolpath.

CURVE

A toolpath curve. The position (basis) curve will be the get_active_obj() in the frame. Any other associated curves for tool axis, reference direction, surface normal, or speed profile will be auxillary objects that you can access with get_active_aux()

MOVE

A linear tool move. The move will have final position information that you can get with get_move_end().

MOVE_ARC

A circular tool move. The move will have start position information that you can get with get_move_start(), an final position that you can get with get_move_end(), and additional radius, center, and angle parameters that you can get with get_move_arc().

MOVE_HELIX

A helical tool move. The move will have start position information that you can get with get_move_start(), an final position that you can get with get_move_end(), and additional radius, center, and angle parameters that you can get with get_move_arc(). STEP-NC helix moves never go more than 360°

LAST_TYPE

Not an actual type. Marker testing whether a numeric value is in the range of known types. A helpful definition for sizing arrays.