Process Planning

blockStock( CornerPt, XLength, YWidth, Thickness )

Returns

<blockStock> Construct a blockStock object of the given dimensions.

CornerPt

<point> The bottom left corner on the front face of the stock.

XLength, YWidth, Thickness

<number> Dimensions of the block in X, Y, and Z respectively.

profileStock( Outline, Thickness , Location )

Returns

<profileStock> Construct a profileStock object with the given outline (using an extrusion in the Z direction).

Outline

<curve> The outline of the stock. The outline should be in the plane of the front face of the stock, which is parallel to the XY plane.

Thickness

<number> Dimension of the stock in Z.

Location

<anchor | euclidPoint> New location and orientation for the stock. The stock origin will be aligned with the location anchor.

roundBarStock( StockZMin, StockZMax, StockDiameter, Loc )

Returns

<roundBarStock> Construct a roundBarStock object with the given dimensions (using an Cylinder with its height along the Z axis).

StockZMin

<number> Z coordinate of the back face of the stock.

StockZMax

<number> Z coordinate of the front face of the stock.

StockDiameter

<number> Diameter of the stock, measured in the X direction.

Loc

<point | anchor> The base location of the stock.

roundTubeStock( StockZMin, StockZMax, StockID, StockOD )

Returns

<roundTubeStock> Construct a roundTubeStock object with the given dimensions (using an Cylinder with its height along the Z axis).

StockZMin

<number> Z coordinate of the back face of the stock.

StockZMax

<number> Z coordinate of the front face of the stock.

StockID, StockOD

<number> Inner and outer diameters of the stock, measured in the X direction.

machine( Operations, PreviousStage, Fixturing )

Returns

<machine> Create a machine object representing a stage of the process plan.

Operations

<any | arrayOf any> Feature objects that describe the machining operations to be done in this stage.

PreviousStage

<extrusion | profileStock | blockStock | machine>(Optional) A description of the stock, or the previous machining stage.

Fixturing

<fixture>(Optional) Fixturing information for this stage.

processPlan( PartName, FinalStage )

Returns

<processPlan> Create a processPlan object with the given stage sequence.

PartName

<string> Name of the part being described.

FinalStage

<machine> The last machining stage for the process plan. It references the previous stages by including them as the stock for each succeeding stage.

fixture( Notes, Transfm, GeomDesc )

Returns

<fixture> Create a fixture object for use in a stage of a process plan.

Notes

<any> This field may be used for annotations relating to the fixturing. The information will be transmitted to the machine operator if possible, and so is a good place for recording instructions about any manual setup that must be done for the machining.

Transfm

<transform | matDescr> Description of the required orientation of the stock for machining of a particular stage. Each machine type has a default base coordinate system, and the transform describes how to postion the stock relative to that base coordinate system.

GeomDesc

<any> The geometric description of the fixture. This is not currently used in the NC code generation, but can be used for documentation purposes for the moment. It would not be unreasonable to put another processPlan object here, which described how to manufacture the fixture.

blockFixture( Stock, Face, Corner, Relative, XOffset, YOffset, ZOffset )

Returns

<blockFixture> Create a block fixture object.

Stock

<blockStock>

Face

<string> "front", "back", "left", "right", "top" or "bottom"

Corner

<string> "ll", "lr", "ul" or "ur"

Relative

<boolean>

XOffset, YOffset, ZOffset

<number>

profileFixture( Stock, Face, Corner, Relative, XOffset, YOffset, ZOffset )

Returns

<profileFixture> Create a profile fixture object.

Stock

<profileStock>

Face

<string> "top" or "bottom"

Corner

<string> "ll", "lr", "ul" or "ur"

Relative

<boolean>

XOffset, YOffset, ZOffset

<number>

tubeFixture( Stock, Face, Corner, Side, Relative, XOffset, YOffset, ZOffset )

Returns

<tubeFixture> Create a tube fixture object.

Stock

<roundTubeStock>

Face

<string> "top", "bottom", "inside" or "outside"

Corner

<string> "ll", "lr", "ul" or "ur"

Side

<string> "top", "mid" or "bot"

Relative

<boolean>

XOffset, YOffset, ZOffset

<number>

barFixture( Stock, Face, Corner, Side, Relative, XOffset, YOffset, ZOffset )

Returns

<barFixture> Create a bar fixture object.

Stock

<roundBarStock>

Face

<string> "top", "bottom" or "outside"

Corner

<string> "ll", "lr", "ul" or "ur"

Side

<string> "top", "mid" or "bot"

Relative

<boolean>

XOffset, YOffset, ZOffset

<number>

ncGen( Plan )

Returns

<processPlan> Generate NC code and related documentation from a process plan or a stage.

Plan

<processPlan | machineStage> If Plan is a stage, a temporary process plan is created, and the output files will be named according to the default process attribute "part_name".

vector( ToolDias... )

Returns

<vector> Create a vector_obj (1d matrix_obj) for tool diameters.

ToolDias...

<number...> A series of tool diameter numbers.

shlMill( Srf, MillType )

Returns

<shlMill>

Srf

<surface>

MillType

<integer>

bclSim( Plan )

Returns

<number> The total simulation time.

Plan

<machineStage | processPlan | boolean | string> If Plan is a machine stage then it will simulate the BCL file of this stage. If Plan is a process plan it will simulate all BCL files of this plan. If it is a boolean the bcl_op hook will be set for simultaneous simulation. A string for Plan gives the BCL file name to simulate.