PlanarOperationBuilder Class

class NXOpen.CAM.PlanarOperationBuilder

Bases: NXOpen.CAM.MillOperationBuilder

Represents a PlanarOperation Builder

This is an abstract class and cannot be instantiated.

New in version NX5.0.0.

Properties

Property	Description
AdditionalPasses	Returns or sets the Boundary Additional Passes
AutomaticPartBoundaryMethod	Returns or sets the Automatic Part Boundary Method
BndStepover	Returns the boundary stepover builder
ChannelName	Returns or sets the channel’s name
CheckGeometry	Returns the check geometry builder
CornerLoops	Returns or sets the corner loops value
CutAreaGeometry	Returns the cut area geometry builder
CutParameters	Returns the cut parameter object
CutPattern	Returns the cut pattern builder
CycleEvent	Returns the cycle event
CycleTable	Returns the cycle
DeferCuttingStatus	Returns or sets the defer cutting status value
DepthPerCut	Returns the depth per cut builder (inheritable double)
Description	Returns or sets the description
EndOfPath	Returns the end event builder
EndUdeSet	Returns the end ude set
FeedsBuilder	Returns the feeds and speeds builder
Geometry	Returns the geometry builder
GougeChecking	Returns or sets the gouge checking flag
HoleAxisType	Returns or sets the Hole Axis Type
HoleDepth	Returns the max depth distance builder
HoleDepthType	Returns or sets the Hole Depth Type
IslandCleanup	Returns or sets the island cleanup status
LayoutAndLayer	Returns the Layer and Layout
MinCutLength	Returns the min cut length builder (tool dependent double)
MotionOutput	Returns the motion output builder
MotionOutputBuilder	Returns the motion output builder
NonCuttingBuilder	Returns the non-cutting moves builder
Notes	Returns the notes builder
OptimizationBasedOn	Returns or sets the optimization based on in operation
OptimizationDistanceMethod	Returns or sets the optimization distance method in operation
OptimizationLevel	Returns or sets the optimization level in operation
OptimizationMethod	Returns or sets the optim method
PartGeometry	Returns the part geometry builder
PathDisplayOptions	Returns the path display options builder
PostToolPathExit	Returns or sets the environment variable that points to the post tool path generation library which has the exit
ReferenceTool	Returns or sets the reference tool object
RetractDistance	Returns the Retract Distance builder (inheritable double)
RetractDistanceOnToolAxisChange	Returns the Retract Distance on Tool Axis Change builder (inheritable double)
SafeClearance	Returns the safe clearance builder
SelectToolFlag	Returns or sets the user selected tool
StartOfPath	Returns the start event builder
StartUdeSet	Returns the start ude set
Tag	Returns the Tag for this object.
ToolAxisFix	Returns the pmop tool axis ci builder
ToolChangeSetting	Returns the tool change builder
ToolMinimumLengthUsage	Returns or sets the tool minimum length usage
ToolPathEditor	Returns the Tool Path Editor Builder
ToolPathSplitParametersBuilder	Returns the tool path split Parameters
WallCleanupType	Returns or sets the wall cleanup mode

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetCustomizableItemBuilder	Returns the customizable item builder for the given customizable item name
GetCustomizableItemNames	Returns the names for all customizable item ids
GetHoleAxisValues	Get the Hole Axis values
GetObject	Returns the object currently being edited by this builder.
SetHoleAxisValues	Set the Hole Axis values
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

PlanarOperationBuilderAutomaticPartBoundaryMethodTypes Enumeration

Available types for automatic part boundary method in planar mill operation

Property Detail

AdditionalPasses

PlanarOperationBuilder.AdditionalPasses

Returns or sets the Boundary Additional Passes

-------------------------------------

Getter Method

Signature AdditionalPasses

Returns:the Boundary Additional Passes Return type:int

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature AdditionalPasses

Parameters:numPasses (int) – the Boundary Additional Passes

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

AutomaticPartBoundaryMethod

PlanarOperationBuilder.AutomaticPartBoundaryMethod

Returns or sets the Automatic Part Boundary Method

-------------------------------------

Getter Method

Signature AutomaticPartBoundaryMethod

Returns: Return type:NXOpen.CAM.PlanarOperationBuilderAutomaticPartBoundaryMethodTypes

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature AutomaticPartBoundaryMethod

Parameters:automaticPartBoundary (NXOpen.CAM.PlanarOperationBuilderAutomaticPartBoundaryMethodTypes) –

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

BndStepover

PlanarOperationBuilder.BndStepover

Returns the boundary stepover builder

-------------------------------------

Getter Method

Signature BndStepover

Returns:The boundary stepover builder Return type:NXOpen.CAM.StepoverBuilder

New in version NX5.0.0.

License requirements: None.

CheckGeometry

PlanarOperationBuilder.CheckGeometry

Returns the check geometry builder

-------------------------------------

Getter Method

Signature CheckGeometry

Returns: Return type:NXOpen.CAM.Geometry

New in version NX8.0.0.

License requirements: None.

CornerLoops

PlanarOperationBuilder.CornerLoops

Returns or sets the corner loops value

-------------------------------------

Getter Method

Signature CornerLoops

Returns:the corner loops value Return type:bool

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CornerLoops

Parameters:cornerLoops (bool) – the corner loops value

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

CutAreaGeometry

PlanarOperationBuilder.CutAreaGeometry

Returns the cut area geometry builder

-------------------------------------

Getter Method

Signature CutAreaGeometry

Returns: Return type:NXOpen.CAM.Geometry

New in version NX8.0.0.

License requirements: None.

CutPattern

PlanarOperationBuilder.CutPattern

Returns the cut pattern builder

-------------------------------------

Getter Method

Signature CutPattern

Returns:The cut pattern builder Return type:NXOpen.CAM.CutPatternBuilder

New in version NX6.0.0.

License requirements: None.

DeferCuttingStatus

PlanarOperationBuilder.DeferCuttingStatus

Returns or sets the defer cutting status value

-------------------------------------

Getter Method

Signature DeferCuttingStatus

Returns:the defer cutting status value Return type:bool

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DeferCuttingStatus

Parameters:deferCuttingStatus (bool) – the defer cutting status value

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

DepthPerCut

PlanarOperationBuilder.DepthPerCut

Returns the depth per cut builder (inheritable double)

-------------------------------------

Getter Method

Signature DepthPerCut

Returns:the depth per cut builder Return type:NXOpen.CAM.InheritableDoubleBuilder

New in version NX5.0.0.

License requirements: None.

IslandCleanup

PlanarOperationBuilder.IslandCleanup

Returns or sets the island cleanup status

-------------------------------------

Getter Method

Signature IslandCleanup

Returns:island cleanup Return type:bool

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IslandCleanup

Parameters:status (bool) –

New in version NX12.0.0.

License requirements: None.

NonCuttingBuilder

PlanarOperationBuilder.NonCuttingBuilder

Returns the non-cutting moves builder

-------------------------------------

Getter Method

Signature NonCuttingBuilder

Returns: Return type:NXOpen.CAM.NcmPlanarBuilder

New in version NX5.0.0.

License requirements: None.

PartGeometry

PlanarOperationBuilder.PartGeometry

Returns the part geometry builder

-------------------------------------

Getter Method

Signature PartGeometry

Returns: Return type:NXOpen.CAM.Geometry

New in version NX8.0.0.

License requirements: None.

ToolAxisFix

PlanarOperationBuilder.ToolAxisFix

Returns the pmop tool axis ci builder

-------------------------------------

Getter Method

Signature ToolAxisFix

Returns: Return type:NXOpen.CAM.ToolAxisFixed

New in version NX7.5.0.

License requirements: None.

ToolMinimumLengthUsage

PlanarOperationBuilder.ToolMinimumLengthUsage

Returns or sets the tool minimum length usage

-------------------------------------

Getter Method

Signature ToolMinimumLengthUsage

Returns:the tool minimum length usage Return type:bool

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ToolMinimumLengthUsage

Parameters:toolMinUsage (bool) – the tool minimum length usage

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

Method Detail

Validate

PlanarOperationBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.