TurnToolProbingBuilder Class¶
-
class
NXOpen.CAM.TurnToolProbingBuilder¶ Bases:
NXOpen.CAM.OperationBuilderRepresents a Turn tool probing Builder
To create a new instance of this class, use
NXOpen.CAM.OperationCollection.CreateTurnToolProbingBuilder()New in version NX8.5.1.
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 |
| 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 |
| 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 |
| ProbeParamsBuilder | Returns the probe parameter builder |
| ReorientToolHolder | Returns or sets the Reorient Tool Holder toggle |
| 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 |
| 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 |
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¶
| TurnToolProbingBuilderTrackingPointTypes Enumeration | available types for tracking point |
Property Detail¶
FeedsBuilder¶
-
TurnToolProbingBuilder.FeedsBuilder¶ Returns the feeds and speeds builder
-------------------------------------Getter Method
Signature
FeedsBuilderReturns: the feeds and speeds builder Return type: NXOpen.CAM.FeedsBuilderNew in version NX8.5.1.
License requirements: None.
FlipToolAroundHolder¶
-
TurnToolProbingBuilder.FlipToolAroundHolder¶ Returns or sets the Flip Tool Around Holder toggle
-------------------------------------Getter Method
Signature
FlipToolAroundHolderReturns: the machine’s A-axis Return type: bool New in version NX8.5.1.
License requirements: None.
-------------------------------------Setter Method
Signature
FlipToolAroundHolderParameters: machAAxis (bool) – the machine’s A-axis New in version NX8.5.1.
License requirements: cam_base (“CAM BASE”)
ProbeParamsBuilder¶
-
TurnToolProbingBuilder.ProbeParamsBuilder¶ Returns the probe parameter builder
-------------------------------------Getter Method
Signature
ProbeParamsBuilderReturns: the probe parameter builder Return type: NXOpen.CAM.ProbeParamsBuilderNew in version NX8.5.1.
License requirements: None.
ReorientToolHolder¶
-
TurnToolProbingBuilder.ReorientToolHolder¶ Returns or sets the Reorient Tool Holder toggle
-------------------------------------Getter Method
Signature
ReorientToolHolderReturns: Reorient Tool Holder Return type: bool New in version NX8.5.1.
License requirements: None.
-------------------------------------Setter Method
Signature
ReorientToolHolderParameters: reorient (bool) – Reorient Tool Holder New in version NX8.5.1.
License requirements: cam_base (“CAM BASE”)
ToolHolderAngle¶
-
TurnToolProbingBuilder.ToolHolderAngle¶ Returns the Tool Holder Angle
-------------------------------------Getter Method
Signature
ToolHolderAngleReturns: the Tool Holder Angle builder Return type: NXOpen.CAM.InheritableDoubleBuilderNew in version NX8.5.1.
License requirements: None.
TrackingPointStatus¶
-
TurnToolProbingBuilder.TrackingPointStatus¶ Returns or sets the tracking point status
-------------------------------------Getter Method
Signature
TrackingPointStatusReturns: tracking point status Return type: NXOpen.CAM.TurnToolProbingBuilderTrackingPointTypesNew in version NX8.5.1.
License requirements: None.
-------------------------------------Setter Method
Signature
TrackingPointStatusParameters: status ( NXOpen.CAM.TurnToolProbingBuilderTrackingPointTypes) – tracking point statusNew in version NX8.5.1.
License requirements: cam_base (“CAM BASE”)
Method Detail¶
Validate¶
-
TurnToolProbingBuilder.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.