OperationBuilder Class¶
-
class
NXOpen.CAM.OperationBuilder¶ Bases:
NXOpen.CAM.ParamBuilderRepresents a Opr Builder
This is an abstract class, and cannot be instantiated.
Default values.
Property Value ToolPathEditor.DeltaXC 0 ToolPathEditor.DeltaYC 0 ToolPathEditor.DeltaZC 0 ToolPathEditor.ExtendMethod Linear ToolPathEditor.GougeCheckClearanceMethod Specify ToolPathEditor.HolderCheck 1 ToolPathEditor.MotionMethod Delta ToolPathEditor.MoveStartPoint 1 ToolPathEditor.TransformCircles 0 New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| ChannelName | Returns or sets the channel’s name |
| CycleEvent | Returns the cycle event |
| CycleTable | Returns the cycle |
| Description | Returns or sets the description |
| EndOfPath | Returns the end event builder |
| EndUdeSet | Returns the end ude set |
| 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 |
| LayoutAndLayer | Returns the Layer and Layout |
| MotionOutputBuilder | Returns the motion output 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 |
| 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 |
| 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. |
| ToolChangeSetting | Returns the tool change builder |
| ToolPathEditor | Returns the Tool Path Editor Builder |
| ToolPathSplitParametersBuilder | Returns the tool path split Parameters |
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. |
| GetHoleAxisValues | Get the Hole Axis values @return 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¶
| OperationBuilderHoleAxisTypes Enumeration | Available types for Hole Axis Type in feature milling and hole making |
| OperationBuilderHoleDepthTypes Enumeration | Available types for Hole Depth Type in feature milling and hole making |
| OperationBuilderOptimizationBasedOnTypes Enumeration | Available types for optimization based on in operation |
| OperationBuilderOptimizationDistanceTypes Enumeration | Available types for optimization distance method in operation |
| OperationBuilderOptimizationLevelTypes Enumeration | Available types for optimization level in operation |
Property Detail¶
ChannelName¶
-
OperationBuilder.ChannelName¶ Returns or sets the channel’s name
-------------------------------------Getter Method
Signature
ChannelName()Returns: the channel’s name Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ChannelName(channel)Parameters: channel (str) – the channel’s name New in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
Description¶
-
OperationBuilder.Description¶ Returns or sets the description
-------------------------------------Getter Method
Signature
Description()Returns: the description Return type: str New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------Setter Method
Signature
Description(description)Parameters: description (str) – the description New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
EndOfPath¶
-
OperationBuilder.EndOfPath¶ Returns the end event builder
-------------------------------------Getter Method
Signature
EndOfPath()Returns: the end of path builder Return type: NXOpen.CAM.PostEventsCiBuilderNew in version NX5.0.1.
License requirements: None.
EndUdeSet¶
-
OperationBuilder.EndUdeSet¶ Returns the end ude set
-------------------------------------Getter Method
Signature
EndUdeSet()Returns: the end ude set Return type: NXOpen.CAM.UdeSetNew in version NX7.5.0.
License requirements: None.
Geometry¶
-
OperationBuilder.Geometry¶ Returns the geometry builder
-------------------------------------Getter Method
Signature
Geometry()Returns: Return type: NXOpen.CAM.GeometryCiBuilderNew in version NX5.0.0.
License requirements: None.
GougeChecking¶
-
OperationBuilder.GougeChecking¶ Returns or sets the gouge checking flag
-------------------------------------Getter Method
Signature
GougeChecking()Returns: the Gouge Checking Flag Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
GougeChecking(gougeChecking)Parameters: gougeChecking (bool) – the Gouge Checking Flag New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
HoleAxisType¶
-
OperationBuilder.HoleAxisType¶ Returns or sets the Hole Axis Type
-------------------------------------Getter Method
Signature
HoleAxisType()Returns: the Hole Axis Type Return type: NXOpen.CAM.OperationBuilderHoleAxisTypesNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
HoleAxisType(types)Parameters: types ( NXOpen.CAM.OperationBuilderHoleAxisTypes) – the Hole Axis TypeNew in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
HoleDepth¶
-
OperationBuilder.HoleDepth¶ Returns the max depth distance builder
-------------------------------------Getter Method
Signature
HoleDepth()Returns: the max depth distance builder Return type: NXOpen.CAM.InheritableDoubleBuilderNew in version NX5.0.0.
License requirements: None.
HoleDepthType¶
-
OperationBuilder.HoleDepthType¶ Returns or sets the Hole Depth Type
-------------------------------------Getter Method
Signature
HoleDepthType()Returns: the Hole Depth Type Return type: NXOpen.CAM.OperationBuilderHoleDepthTypesNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
HoleDepthType(types)Parameters: types ( NXOpen.CAM.OperationBuilderHoleDepthTypes) – the Hole Depth TypeNew in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
LayoutAndLayer¶
-
OperationBuilder.LayoutAndLayer¶ Returns the Layer and Layout
-------------------------------------Getter Method
Signature
LayoutAndLayer()Returns: the layout and layer Return type: NXOpen.CAM.LayoutCiBuilderNew in version NX9.0.1.
License requirements: None.
MotionOutputBuilder¶
-
OperationBuilder.MotionOutputBuilder¶ Returns the motion output builder
-------------------------------------Getter Method
Signature
MotionOutputBuilder()Returns: Return type: NXOpen.CAM.ArcOutputTypeCiBuilderNew in version NX8.0.0.
License requirements: None.
Notes¶
-
OperationBuilder.Notes¶ Returns the notes builder
-------------------------------------Getter Method
Signature
Notes()Returns: Return type: NXOpen.CAM.NotesNew in version NX9.0.0.
License requirements: None.
OptimizationBasedOn¶
-
OperationBuilder.OptimizationBasedOn¶ Returns or sets the optimization based on in operation
-------------------------------------Getter Method
Signature
OptimizationBasedOn()Returns: Return type: NXOpen.CAM.OperationBuilderOptimizationBasedOnTypesNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
OptimizationBasedOn(optimBasedOn)Parameters: optimBasedOn ( NXOpen.CAM.OperationBuilderOptimizationBasedOnTypes) –New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
OptimizationDistanceMethod¶
-
OperationBuilder.OptimizationDistanceMethod¶ Returns or sets the optimization distance method in operation
-------------------------------------Getter Method
Signature
OptimizationDistanceMethod()Returns: Return type: NXOpen.CAM.OperationBuilderOptimizationDistanceTypesNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
OptimizationDistanceMethod(optimDistance)Parameters: optimDistance ( NXOpen.CAM.OperationBuilderOptimizationDistanceTypes) –New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
OptimizationLevel¶
-
OperationBuilder.OptimizationLevel¶ Returns or sets the optimization level in operation
-------------------------------------Getter Method
Signature
OptimizationLevel()Returns: Return type: NXOpen.CAM.OperationBuilderOptimizationLevelTypesNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
OptimizationLevel(optimType)Parameters: optimType ( NXOpen.CAM.OperationBuilderOptimizationLevelTypes) –New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
PathDisplayOptions¶
-
OperationBuilder.PathDisplayOptions¶ Returns the path display options builder
-------------------------------------Getter Method
Signature
PathDisplayOptions()Returns: The path display options builder Return type: NXOpen.CAM.OperationDisplayOptionsBuilderNew in version NX6.0.0.
License requirements: None.
PostToolPathExit¶
-
OperationBuilder.PostToolPathExit¶ Returns or sets the environment variable that points to the post tool path generation library which has the exit
-------------------------------------Getter Method
Signature
PostToolPathExit()Returns: the description Return type: str New in version NX9.0.3.
License requirements: cam_base (“CAM BASE”)
-------------------------------------Setter Method
Signature
PostToolPathExit(exitName)Parameters: exitName (str) – the environment variable that points to the post tool path generation library New in version NX9.0.3.
License requirements: cam_base (“CAM BASE”)
RetractDistance¶
-
OperationBuilder.RetractDistance¶ Returns the Retract Distance builder (inheritable double)
-------------------------------------Getter Method
Signature
RetractDistance()Returns: Return type: NXOpen.CAM.InheritableDoubleBuilderNew in version NX5.0.0.
License requirements: None.
RetractDistanceOnToolAxisChange¶
-
OperationBuilder.RetractDistanceOnToolAxisChange¶ Returns the Retract Distance on Tool Axis Change builder (inheritable double)
-------------------------------------Getter Method
Signature
RetractDistanceOnToolAxisChange()Returns: the Retract Distance on Tool Axis Change builder Return type: NXOpen.CAM.InheritableDoubleBuilderNew in version NX5.0.0.
License requirements: None.
SafeClearance¶
-
OperationBuilder.SafeClearance¶ Returns the safe clearance builder
-------------------------------------Getter Method
Signature
SafeClearance()Returns: The safe clearance builder Return type: NXOpen.CAM.InheritableDoubleBuilderNew in version NX6.0.0.
License requirements: None.
SelectToolFlag¶
-
OperationBuilder.SelectToolFlag¶ Returns or sets the user selected tool
-------------------------------------Getter Method
Signature
SelectToolFlag()Returns: the user selected tool Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SelectToolFlag(selToolFlag)Parameters: selToolFlag (bool) – the user selected tool New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
StartOfPath¶
-
OperationBuilder.StartOfPath¶ Returns the start event builder
-------------------------------------Getter Method
Signature
StartOfPath()Returns: the start of path builder Return type: NXOpen.CAM.PostEventsCiBuilderNew in version NX5.0.1.
License requirements: None.
StartUdeSet¶
-
OperationBuilder.StartUdeSet¶ Returns the start ude set
-------------------------------------Getter Method
Signature
StartUdeSet()Returns: the start ude set Return type: NXOpen.CAM.UdeSetNew in version NX7.5.0.
License requirements: None.
ToolChangeSetting¶
-
OperationBuilder.ToolChangeSetting¶ Returns the tool change builder
-------------------------------------Getter Method
Signature
ToolChangeSetting()Returns: Return type: NXOpen.CAM.ToolChangeCiBuilderNew in version NX5.0.0.
License requirements: None.
ToolPathEditor¶
-
OperationBuilder.ToolPathEditor¶ Returns the Tool Path Editor Builder
-------------------------------------Getter Method
Signature
ToolPathEditor()Returns: the tool path editor Return type: NXOpen.CAM.ToolPathEditorBuilderNew in version NX9.0.3.
License requirements: None.
ToolPathSplitParametersBuilder¶
-
OperationBuilder.ToolPathSplitParametersBuilder¶ Returns the tool path split Parameters
-------------------------------------Getter Method
Signature
ToolPathSplitParametersBuilder()Returns: Return type: NXOpen.CAM.ToolPathSplitParametersBuilderNew in version NX9.0.0.
License requirements: None.
Method Detail¶
GetHoleAxisValues¶
-
OperationBuilder.GetHoleAxisValues¶ Get the Hole Axis values
Signature
GetHoleAxisValues()Returns: the Hole Axis values Return type: list of float New in version NX5.0.0.
License requirements: None.
SetHoleAxisValues¶
-
OperationBuilder.SetHoleAxisValues¶ Set the Hole Axis values
Signature
SetHoleAxisValues(holeAxis)Parameters: holeAxis (list of float) – the Hole Axis values New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
Validate¶
-
OperationBuilder.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.