RoughTurningBuilder Class¶
-
class
NXOpen.CAM.RoughTurningBuilder¶ Bases:
NXOpen.CAM.RoughFinishTurningBuilderRepresents a RoughTurning Builder
To create a new instance of this class, use
NXOpen.CAM.OperationCollection.CreateRoughTurningBuilder()New in version NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| AdditionalCommands | Returns or sets the Additional Commands |
| AxialTrimPlane1 | Returns the axial trim plane 1 |
| AxialTrimPlane2 | Returns the axial trim plane 2 |
| ChannelName | Returns or sets the channel’s name |
| Cleanup | Returns or sets the Cleanup |
| CustomMemberData | Returns or sets the Custom Member Data type |
| CustomMemberDataDistance | Returns or sets the Custom Member Data Distance |
| CustomPartBoundary | Returns the custom part boundary builder |
| CutParameters | Returns the cut parameter object |
| CutRegions | Returns or sets the Cut regions type |
| CutStrategy | Returns the Cut Strategy |
| CycleEvent | Returns the cycle event |
| CycleTable | Returns the cycle |
| Description | Returns or sets the description |
| Direction | Returns the Rough Direction |
| EndAngle | Returns or sets the end angle |
| EndOfPath | Returns the end event builder |
| EndOffset | Returns or sets the end offset |
| EndUdeSet | Returns the end ude set |
| ExtendMode | Returns or sets the Extend Mode |
| FeedsBuilder | Returns the feeds and speeds builder |
| FirstPlunge | Returns the First Plunge |
| FlipToolAroundHolder | Returns or sets the Flip Tool Around Holder toggle |
| 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 |
| IgnoreMinimumBoringDiameter | Returns or sets the Ignore Minimum Boring Diameter toggle |
| LayoutAndLayer | Returns the Layer and Layout |
| LevelAngleBuilder | Returns the Level Angle |
| LevelDepth | Returns or sets the level depth |
| LevelDepthMode | Returns or sets the Level Depth Mode |
| MachineCycleSubroutineName | Returns or sets the machine cycle subroutine name |
| MaximumAreaMode | Returns or sets the Maximum Area mode |
| MaximumAreaSize | Returns or sets the Maximum Area Size |
| MaximumAreaUnit | Returns or sets the Maximum Area Unit |
| MaximumSizeAxial | Returns the Maximum Size Axial |
| MaximumSizeMode | Returns or sets the Maximum Size Mode |
| MaximumSizeRadial | Returns the Maximum Size Radial |
| MinimumArea | Returns or sets the Minimum Area type |
| MinimumAreaSize | Returns or sets the Minimum Area Size |
| MinimumAreaUnit | Returns or sets the Minimum Area Unit |
| MinimumSizeAxial | Returns the Minimum Size Axial |
| MinimumSizeMode | Returns or sets the Minimum Size Mode |
| MinimumSizeRadial | Returns the Minimum Size Radial |
| MotionOutput | Returns or sets the motion output |
| MotionOutputBuilder | Returns the motion output builder |
| NonCuttingBuilder | Returns the non-cutting builder |
| Notes | Returns the notes builder |
| OmitReversals | Returns or sets the Omit Reversals toggle |
| 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 |
| PartOffDepthMode | Returns or sets the Part Off Depth Mode |
| PartOffDepthValue | Returns or sets the Part Off Depth Value |
| PartOffEvents | Returns the Part Off Events |
| PartOffPositionMode | Returns or sets the Part Off Position Mode |
| PartOffPositionPoint | Returns or sets the Part Off Position Point |
| 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 |
| RadialTrimPlane1 | Returns the radial trim plane 1 |
| RadialTrimPlane2 | Returns the radial trim plane 2 |
| RegionMachining | Returns or sets the Region Machining type |
| RegionSelection | Returns or sets the Region Selection type |
| RegionSelectionPoint | Returns or sets the Region Selection Point |
| ReorientToolHolder | Returns or sets the Reorient Tool Holder toggle. |
| ReorientToolHolderMode | Returns or sets the Reorient Tool Holder Mode |
| RetractDistance | Returns the Retract Distance builder (inheritable double) |
| RetractDistanceOnToolAxisChange | Returns the Retract Distance on Tool Axis Change builder (inheritable double) |
| ReversalMode | Returns or sets the Reversal Mode |
| RotateTrackingPoint | Returns or sets the Rotate Tracking Point toggle |
| SafeClearance | Returns the safe clearance builder |
| SafeDistance | Returns or sets the Safe Distance |
| SelectToolFlag | Returns or sets the user selected tool |
| StartAngle | Returns or sets the start angle |
| StartOfPath | Returns the start event builder |
| StartOffset | Returns or sets the Start Offset |
| StartUdeSet | Returns the start ude set |
| StepAngleBuilder | Returns the Step Angle |
| Stepover | Returns the Stepover |
| Tag | Returns the Tag for this object. |
| ToleranceOffset | Returns or sets the Tolerance Offset type |
| ToolChangeSetting | Returns the tool change builder |
| ToolHolderAngle | Returns the Tool Holder Angle |
| ToolPathEditor | Returns the Tool Path Editor Builder |
| ToolPathSplitParametersBuilder | Returns the tool path split Parameters |
| TrackingPointStatus | Returns or sets the tracking point status |
| TrimPoint1 | Returns the trim point 1 |
| TrimPoint2 | Returns the trim point 2 |
| UpdateIpw | Returns or sets the update IPW mode |
| UseMachineCycle | Returns or sets the Use Machine Cycle toggle |
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¶
| RoughTurningBuilderCleanupTypes Enumeration | the Cleanup types |
| RoughTurningBuilderLevelDepthModeTypes Enumeration | the Level Depth Mode types |
| RoughTurningBuilderPartOffDepthModeTypes Enumeration | the Part Off Depth Mode types |
| RoughTurningBuilderPartOffPositionModeTypes Enumeration | the Part Off Position Mode types |
| RoughTurningBuilderReversalModeTypes Enumeration | the Reversal Mode types |
Property Detail¶
Cleanup¶
-
RoughTurningBuilder.Cleanup¶ Returns or sets the Cleanup
-------------------------------------Getter Method
Signature
CleanupReturns: the cleanup type Return type: NXOpen.CAM.RoughTurningBuilderCleanupTypesNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CleanupParameters: cleanupMode ( NXOpen.CAM.RoughTurningBuilderCleanupTypes) – the cleanup typeNew in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
CutStrategy¶
-
RoughTurningBuilder.CutStrategy¶ Returns the Cut Strategy
-------------------------------------Getter Method
Signature
CutStrategyReturns: the cut strategy Return type: NXOpen.CAM.CutStrategyNew in version NX6.0.0.
License requirements: None.
Direction¶
-
RoughTurningBuilder.Direction¶ Returns the Rough Direction
-------------------------------------Getter Method
Signature
DirectionReturns: the rough direction Return type: NXOpen.CAM.TurnDirectionNew in version NX6.0.0.
License requirements: None.
FirstPlunge¶
-
RoughTurningBuilder.FirstPlunge¶ Returns the First Plunge
-------------------------------------Getter Method
Signature
FirstPlungeReturns: the first plunge Return type: NXOpen.CAM.FirstPlungeNew in version NX6.0.0.
License requirements: None.
LevelDepth¶
-
RoughTurningBuilder.LevelDepth¶ Returns or sets the level depth
-------------------------------------Getter Method
Signature
LevelDepthReturns: the level depth Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LevelDepthParameters: levelDepth (float) – the level depth New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
LevelDepthMode¶
-
RoughTurningBuilder.LevelDepthMode¶ Returns or sets the Level Depth Mode
-------------------------------------Getter Method
Signature
LevelDepthModeReturns: the level depth mode Return type: NXOpen.CAM.RoughTurningBuilderLevelDepthModeTypesNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LevelDepthModeParameters: levelDepthMode ( NXOpen.CAM.RoughTurningBuilderLevelDepthModeTypes) – the level depth modeNew in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
NonCuttingBuilder¶
-
RoughTurningBuilder.NonCuttingBuilder¶ Returns the non-cutting builder
-------------------------------------Getter Method
Signature
NonCuttingBuilderReturns: the non-cutting builder Return type: NXOpen.CAM.NcmTurnRoughBuilderNew in version NX6.0.0.
License requirements: None.
PartOffDepthMode¶
-
RoughTurningBuilder.PartOffDepthMode¶ Returns or sets the Part Off Depth Mode
-------------------------------------Getter Method
Signature
PartOffDepthModeReturns: the part off depth mode Return type: NXOpen.CAM.RoughTurningBuilderPartOffDepthModeTypesNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PartOffDepthModeParameters: partOffDepthMode ( NXOpen.CAM.RoughTurningBuilderPartOffDepthModeTypes) – the part off depth modeNew in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
PartOffDepthValue¶
-
RoughTurningBuilder.PartOffDepthValue¶ Returns or sets the Part Off Depth Value
-------------------------------------Getter Method
Signature
PartOffDepthValueReturns: the part off depth value Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PartOffDepthValueParameters: partOffDepthValue (float) – the part off depth value New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
PartOffEvents¶
-
RoughTurningBuilder.PartOffEvents¶ Returns the Part Off Events
-------------------------------------Getter Method
Signature
PartOffEventsReturns: the part off events Return type: NXOpen.CAM.PostEventsCiBuilderNew in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
PartOffPositionMode¶
-
RoughTurningBuilder.PartOffPositionMode¶ Returns or sets the Part Off Position Mode
-------------------------------------Getter Method
Signature
PartOffPositionModeReturns: the part off position mode Return type: NXOpen.CAM.RoughTurningBuilderPartOffPositionModeTypesNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PartOffPositionModeParameters: partOffPositionMode ( NXOpen.CAM.RoughTurningBuilderPartOffPositionModeTypes) – the part off position modeNew in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
PartOffPositionPoint¶
-
RoughTurningBuilder.PartOffPositionPoint¶ Returns or sets the Part Off Position Point
-------------------------------------Getter Method
Signature
PartOffPositionPointReturns: the part off position point Return type: NXOpen.PointNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PartOffPositionPointParameters: partOffPositionPoint ( NXOpen.Point) – the part off position pointNew in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
ReversalMode¶
-
RoughTurningBuilder.ReversalMode¶ Returns or sets the Reversal Mode
-------------------------------------Getter Method
Signature
ReversalModeReturns: the reversal mode Return type: NXOpen.CAM.RoughTurningBuilderReversalModeTypesNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReversalModeParameters: reversalMode ( NXOpen.CAM.RoughTurningBuilderReversalModeTypes) – the reversal modeNew in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
SafeDistance¶
-
RoughTurningBuilder.SafeDistance¶ Returns or sets the Safe Distance
-------------------------------------Getter Method
Signature
SafeDistanceReturns: the safe distance Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SafeDistanceParameters: safeDistanceValue (float) – the safe distance New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
Stepover¶
-
RoughTurningBuilder.Stepover¶ Returns the Stepover
-------------------------------------Getter Method
Signature
StepoverReturns: the stepover Return type: NXOpen.CAM.StepoverBuilderNew in version NX6.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
RoughTurningBuilder.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.