RoughFinishTurningBuilder Class¶
-
class
NXOpen.CAM.
RoughFinishTurningBuilder
¶ Bases:
NXOpen.CAM.TurningOperationBuilder
Represents a RoughFinishTurning Builder
This is an abstract class and cannot be instantiated.
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 |
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 |
CycleEvent | Returns the cycle event |
CycleTable | Returns the cycle |
Description | Returns or sets the description |
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 |
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 |
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 |
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 |
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) |
RotateTrackingPoint | Returns or sets the Rotate Tracking Point toggle |
SafeClearance | Returns the safe clearance builder |
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 |
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¶
Property Detail¶
AxialTrimPlane1¶
-
RoughFinishTurningBuilder.
AxialTrimPlane1
¶ Returns the axial trim plane 1
-------------------------------------
Getter Method
Signature
AxialTrimPlane1
Returns: the axial trim plane 1 Return type: NXOpen.CAM.TrimPlane
New in version NX6.0.0.
License requirements: None.
AxialTrimPlane2¶
-
RoughFinishTurningBuilder.
AxialTrimPlane2
¶ Returns the axial trim plane 2
-------------------------------------
Getter Method
Signature
AxialTrimPlane2
Returns: the axial trim plane 2 Return type: NXOpen.CAM.TrimPlane
New in version NX6.0.0.
License requirements: None.
CustomMemberData¶
-
RoughFinishTurningBuilder.
CustomMemberData
¶ Returns or sets the Custom Member Data type
-------------------------------------
Getter Method
Signature
CustomMemberData
Returns: the custom member data type Return type: NXOpen.CAM.RoughFinishTurningBuilderCustomMemberDataTypes
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CustomMemberData
Parameters: surfaceSensitivityMode ( NXOpen.CAM.RoughFinishTurningBuilderCustomMemberDataTypes
) – the custom member data typeNew in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
CustomMemberDataDistance¶
-
RoughFinishTurningBuilder.
CustomMemberDataDistance
¶ Returns or sets the Custom Member Data Distance
-------------------------------------
Getter Method
Signature
CustomMemberDataDistance
Returns: the custom member data distance Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CustomMemberDataDistance
Parameters: surfaceSensitivityTolerance (float) – the custom member data distance New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
CustomPartBoundary¶
-
RoughFinishTurningBuilder.
CustomPartBoundary
¶ Returns the custom part boundary builder
-------------------------------------
Getter Method
Signature
CustomPartBoundary
Returns: Return type: NXOpen.CAM.Boundary
New in version NX9.0.2.
License requirements: None.
CutParameters¶
-
RoughFinishTurningBuilder.
CutParameters
¶ Returns the cut parameter object
-------------------------------------
Getter Method
Signature
CutParameters
Returns: Return type: NXOpen.CAM.TurnCutParameters
New in version NX6.0.0.
License requirements: None.
CutRegions¶
-
RoughFinishTurningBuilder.
CutRegions
¶ Returns or sets the Cut regions type
-------------------------------------
Getter Method
Signature
CutRegions
Returns: the Cut regions type Return type: NXOpen.CAM.RoughFinishTurningBuilderCutRegionsTypes
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CutRegions
Parameters: multipleCutRegions ( NXOpen.CAM.RoughFinishTurningBuilderCutRegionsTypes
) – the Cut regions typeNew in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
EndAngle¶
-
RoughFinishTurningBuilder.
EndAngle
¶ Returns or sets the end angle
-------------------------------------
Getter Method
Signature
EndAngle
Returns: the end angle Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
EndAngle
Parameters: endAngle (float) – the end angle New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
EndOffset¶
-
RoughFinishTurningBuilder.
EndOffset
¶ Returns or sets the end offset
-------------------------------------
Getter Method
Signature
EndOffset
Returns: the end offset Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
EndOffset
Parameters: endOffset (float) – the end offset New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
ExtendMode¶
-
RoughFinishTurningBuilder.
ExtendMode
¶ Returns or sets the Extend Mode
-------------------------------------
Getter Method
Signature
ExtendMode
Returns: the extend mode type Return type: NXOpen.CAM.RoughFinishTurningBuilderExtendModeTypes
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExtendMode
Parameters: tangentialStartEndExtension ( NXOpen.CAM.RoughFinishTurningBuilderExtendModeTypes
) – the extend mode typeNew in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
IgnoreMinimumBoringDiameter¶
-
RoughFinishTurningBuilder.
IgnoreMinimumBoringDiameter
¶ Returns or sets the Ignore Minimum Boring Diameter toggle
-------------------------------------
Getter Method
Signature
IgnoreMinimumBoringDiameter
Returns: the Ignore Minimum Boring Diameter Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IgnoreMinimumBoringDiameter
Parameters: ignoreMinBoringDia (bool) – the Ignore Minimum Boring Diameter New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
LevelAngleBuilder¶
-
RoughFinishTurningBuilder.
LevelAngleBuilder
¶ Returns the Level Angle
-------------------------------------
Getter Method
Signature
LevelAngleBuilder
Returns: the Level Angle Return type: NXOpen.CAM.CutAngle
New in version NX7.5.0.
License requirements: None.
MaximumAreaMode¶
-
RoughFinishTurningBuilder.
MaximumAreaMode
¶ Returns or sets the Maximum Area mode
-------------------------------------
Getter Method
Signature
MaximumAreaMode
Returns: the maximum area mode Return type: NXOpen.CAM.RoughFinishTurningBuilderMaximumAreaModes
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MaximumAreaMode
Parameters: maximumAreaMode ( NXOpen.CAM.RoughFinishTurningBuilderMaximumAreaModes
) – the maximum area modeNew in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
MaximumAreaSize¶
-
RoughFinishTurningBuilder.
MaximumAreaSize
¶ Returns or sets the Maximum Area Size
-------------------------------------
Getter Method
Signature
MaximumAreaSize
Returns: the maximum area size Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MaximumAreaSize
Parameters: maxSize (float) – the maximum size New in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
MaximumAreaUnit¶
-
RoughFinishTurningBuilder.
MaximumAreaUnit
¶ Returns or sets the Maximum Area Unit
-------------------------------------
Getter Method
Signature
MaximumAreaUnit
Returns: the maximum area unit Return type: NXOpen.CAM.RoughFinishTurningBuilderMinmaxAreaUnits
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MaximumAreaUnit
Parameters: maxAreaUnit ( NXOpen.CAM.RoughFinishTurningBuilderMinmaxAreaUnits
) – the maximum area unitNew in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
MaximumSizeAxial¶
-
RoughFinishTurningBuilder.
MaximumSizeAxial
¶ Returns the Maximum Size Axial
-------------------------------------
Getter Method
Signature
MaximumSizeAxial
Returns: the maximum size axial Return type: NXOpen.CAM.InheritableToolDepBuilder
New in version NX7.5.0.
License requirements: None.
MaximumSizeMode¶
-
RoughFinishTurningBuilder.
MaximumSizeMode
¶ Returns or sets the Maximum Size Mode
-------------------------------------
Getter Method
Signature
MaximumSizeMode
Returns: the maximum size mode Return type: NXOpen.CAM.RoughFinishTurningBuilderMinmaxSizeModes
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MaximumSizeMode
Parameters: maximumSizeMode ( NXOpen.CAM.RoughFinishTurningBuilderMinmaxSizeModes
) – the maximum size modeNew in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
MaximumSizeRadial¶
-
RoughFinishTurningBuilder.
MaximumSizeRadial
¶ Returns the Maximum Size Radial
-------------------------------------
Getter Method
Signature
MaximumSizeRadial
Returns: the maximum size radial Return type: NXOpen.CAM.InheritableToolDepBuilder
New in version NX7.5.0.
License requirements: None.
MinimumArea¶
-
RoughFinishTurningBuilder.
MinimumArea
¶ Returns or sets the Minimum Area type
-------------------------------------
Getter Method
Signature
MinimumArea
Returns: the minimum area type Return type: NXOpen.CAM.RoughFinishTurningBuilderMinimumAreaTypes
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MinimumArea
Parameters: minimumAreaActive ( NXOpen.CAM.RoughFinishTurningBuilderMinimumAreaTypes
) – the minimum area typeNew in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
MinimumAreaSize¶
-
RoughFinishTurningBuilder.
MinimumAreaSize
¶ Returns or sets the Minimum Area Size
-------------------------------------
Getter Method
Signature
MinimumAreaSize
Returns: the minimum area size Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MinimumAreaSize
Parameters: minArea (float) – the minimum area size New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
MinimumAreaUnit¶
-
RoughFinishTurningBuilder.
MinimumAreaUnit
¶ Returns or sets the Minimum Area Unit
-------------------------------------
Getter Method
Signature
MinimumAreaUnit
Returns: the minimum area unit Return type: NXOpen.CAM.RoughFinishTurningBuilderMinmaxAreaUnits
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MinimumAreaUnit
Parameters: minAreaUnit ( NXOpen.CAM.RoughFinishTurningBuilderMinmaxAreaUnits
) – the minimum area unitNew in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
MinimumSizeAxial¶
-
RoughFinishTurningBuilder.
MinimumSizeAxial
¶ Returns the Minimum Size Axial
-------------------------------------
Getter Method
Signature
MinimumSizeAxial
Returns: the minimum size axial Return type: NXOpen.CAM.InheritableToolDepBuilder
New in version NX7.5.0.
License requirements: None.
MinimumSizeMode¶
-
RoughFinishTurningBuilder.
MinimumSizeMode
¶ Returns or sets the Minimum Size Mode
-------------------------------------
Getter Method
Signature
MinimumSizeMode
Returns: the minimum size mode Return type: NXOpen.CAM.RoughFinishTurningBuilderMinmaxSizeModes
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MinimumSizeMode
Parameters: minimumSizeMode ( NXOpen.CAM.RoughFinishTurningBuilderMinmaxSizeModes
) – the minimum size modeNew in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
MinimumSizeRadial¶
-
RoughFinishTurningBuilder.
MinimumSizeRadial
¶ Returns the Minimum Size Radial
-------------------------------------
Getter Method
Signature
MinimumSizeRadial
Returns: the minimum size radial Return type: NXOpen.CAM.InheritableToolDepBuilder
New in version NX7.5.0.
License requirements: None.
OmitReversals¶
-
RoughFinishTurningBuilder.
OmitReversals
¶ Returns or sets the Omit Reversals toggle
-------------------------------------
Getter Method
Signature
OmitReversals
Returns: the omit reversals Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OmitReversals
Parameters: omitReversals (bool) – the omit reversals New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
RadialTrimPlane1¶
-
RoughFinishTurningBuilder.
RadialTrimPlane1
¶ Returns the radial trim plane 1
-------------------------------------
Getter Method
Signature
RadialTrimPlane1
Returns: the radial trim plane 1 Return type: NXOpen.CAM.TrimPlane
New in version NX6.0.0.
License requirements: None.
RadialTrimPlane2¶
-
RoughFinishTurningBuilder.
RadialTrimPlane2
¶ Returns the radial trim plane 2
-------------------------------------
Getter Method
Signature
RadialTrimPlane2
Returns: the radial trim plane 2 Return type: NXOpen.CAM.TrimPlane
New in version NX6.0.0.
License requirements: None.
RegionMachining¶
-
RoughFinishTurningBuilder.
RegionMachining
¶ Returns or sets the Region Machining type
-------------------------------------
Getter Method
Signature
RegionMachining
Returns: the Region Machining type Return type: NXOpen.CAM.RoughFinishTurningBuilderRegionMachiningTypes
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RegionMachining
Parameters: regionMachining ( NXOpen.CAM.RoughFinishTurningBuilderRegionMachiningTypes
) – the Region Machining typeNew in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
RegionSelection¶
-
RoughFinishTurningBuilder.
RegionSelection
¶ Returns or sets the Region Selection type
-------------------------------------
Getter Method
Signature
RegionSelection
Returns: the region selection type Return type: NXOpen.CAM.RoughFinishTurningBuilderRegionSelectionTypes
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RegionSelection
Parameters: cutRegionSelectionMode ( NXOpen.CAM.RoughFinishTurningBuilderRegionSelectionTypes
) – the region selection typeNew in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
RegionSelectionPoint¶
-
RoughFinishTurningBuilder.
RegionSelectionPoint
¶ Returns or sets the Region Selection Point
-------------------------------------
Getter Method
Signature
RegionSelectionPoint
Returns: the region selection point Return type: NXOpen.Point
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RegionSelectionPoint
Parameters: cutRegionSelectionPoint ( NXOpen.Point
) – the region selection pointNew in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
StartAngle¶
-
RoughFinishTurningBuilder.
StartAngle
¶ Returns or sets the start angle
-------------------------------------
Getter Method
Signature
StartAngle
Returns: the start angle Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StartAngle
Parameters: startAngle (float) – the start angle New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
StartOffset¶
-
RoughFinishTurningBuilder.
StartOffset
¶ Returns or sets the Start Offset
-------------------------------------
Getter Method
Signature
StartOffset
Returns: the start offset Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StartOffset
Parameters: startOffset (float) – the start offset New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
StepAngleBuilder¶
-
RoughFinishTurningBuilder.
StepAngleBuilder
¶ Returns the Step Angle
-------------------------------------
Getter Method
Signature
StepAngleBuilder
Returns: the Step Angle Return type: NXOpen.CAM.CutAngle
New in version NX7.5.0.
License requirements: None.
ToleranceOffset¶
-
RoughFinishTurningBuilder.
ToleranceOffset
¶ Returns or sets the Tolerance Offset type
-------------------------------------
Getter Method
Signature
ToleranceOffset
Returns: the tolerance offset type Return type: NXOpen.CAM.RoughFinishTurningBuilderToleranceOffsetTypes
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToleranceOffset
Parameters: toleranceOffsetMode ( NXOpen.CAM.RoughFinishTurningBuilderToleranceOffsetTypes
) – the tolerance offset typeNew in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
TrimPoint1¶
-
RoughFinishTurningBuilder.
TrimPoint1
¶ Returns the trim point 1
-------------------------------------
Getter Method
Signature
TrimPoint1
Returns: the trim point 1 Return type: NXOpen.CAM.TrimPoint
New in version NX6.0.0.
License requirements: None.
TrimPoint2¶
-
RoughFinishTurningBuilder.
TrimPoint2
¶ Returns the trim point 2
-------------------------------------
Getter Method
Signature
TrimPoint2
Returns: the trim point 2 Return type: NXOpen.CAM.TrimPoint
New in version NX6.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
RoughFinishTurningBuilder.
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.