TurnProbeClearanceBuilder Class¶
-
class
NXOpen.CAM.TurnProbeClearanceBuilder¶ Bases:
NXOpen.CAM.MoveBuilderRepresents an probe start of engage Builder
To create a new instance of this class, use
NXOpen.CAM.MoveCollection.CreateTurnProbeClearanceBuilder()New in version NX8.5.1.
Properties¶
| Property | Description |
|---|---|
| AxialPlaneMode | Returns or sets the axial plane mode |
| AxialPlanePoint | Returns or sets the axial plane point |
| AxialPlaneValue | Returns or sets the axial plane value |
| FeedRate | Returns or sets the feed rate |
| FeedType | Returns or sets the feed type |
| FeedUnit | Returns or sets the feed unit |
| MotionType | Returns or sets the motion type |
| NumberOfUserParameters | Returns the number of user parameters |
| ProtectedMove | Returns or sets the protected move status |
| RadialPlaneMode | Returns or sets the radial plane mode |
| RadialPlanePoint | Returns or sets the radial plane point |
| RadialPlaneValue | Returns or sets the radial plane value |
| SubopLabel | Returns or sets the subop label |
| Tag | Returns the Tag for this object. |
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. |
| GetObject | Returns the object currently being edited by this builder. |
| GetUserParameter | Returns the custom parameter with the given name. |
| SetParent | Set parent |
| SetSibling | Set sibling |
| 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¶
| TurnProbeClearanceBuilderAxialPlaneModes Enumeration | The axial plane mode options |
| TurnProbeClearanceBuilderRadialPlaneModes Enumeration | The radial plane mode options |
Property Detail¶
AxialPlaneMode¶
-
TurnProbeClearanceBuilder.AxialPlaneMode¶ Returns or sets the axial plane mode
-------------------------------------Getter Method
Signature
AxialPlaneModeReturns: the axial plane mode value Return type: NXOpen.CAM.TurnProbeClearanceBuilderAxialPlaneModesNew in version NX8.5.1.
License requirements: None.
-------------------------------------Setter Method
Signature
AxialPlaneModeParameters: axialPlaneMode ( NXOpen.CAM.TurnProbeClearanceBuilderAxialPlaneModes) – the axial plane mode valueNew in version NX8.5.1.
License requirements: cam_base (“CAM BASE”)
AxialPlanePoint¶
-
TurnProbeClearanceBuilder.AxialPlanePoint¶ Returns or sets the axial plane point
-------------------------------------Getter Method
Signature
AxialPlanePointReturns: the axial plane point value Return type: NXOpen.PointNew in version NX8.5.1.
License requirements: None.
-------------------------------------Setter Method
Signature
AxialPlanePointParameters: axialPlanePoint ( NXOpen.Point) – the axial plane point valueNew in version NX8.5.1.
License requirements: cam_base (“CAM BASE”)
AxialPlaneValue¶
-
TurnProbeClearanceBuilder.AxialPlaneValue¶ Returns or sets the axial plane value
-------------------------------------Getter Method
Signature
AxialPlaneValueReturns: the axial plane value value Return type: float New in version NX8.5.1.
License requirements: None.
-------------------------------------Setter Method
Signature
AxialPlaneValueParameters: axialPlaneValue (float) – the axial plane value value New in version NX8.5.1.
License requirements: cam_base (“CAM BASE”)
RadialPlaneMode¶
-
TurnProbeClearanceBuilder.RadialPlaneMode¶ Returns or sets the radial plane mode
-------------------------------------Getter Method
Signature
RadialPlaneModeReturns: the radial plane mode value Return type: NXOpen.CAM.TurnProbeClearanceBuilderRadialPlaneModesNew in version NX8.5.1.
License requirements: None.
-------------------------------------Setter Method
Signature
RadialPlaneModeParameters: radialPlaneMode ( NXOpen.CAM.TurnProbeClearanceBuilderRadialPlaneModes) – the radial plane mode valueNew in version NX8.5.1.
License requirements: cam_base (“CAM BASE”)
RadialPlanePoint¶
-
TurnProbeClearanceBuilder.RadialPlanePoint¶ Returns or sets the radial plane point
-------------------------------------Getter Method
Signature
RadialPlanePointReturns: the radial plane point value Return type: NXOpen.PointNew in version NX8.5.1.
License requirements: None.
-------------------------------------Setter Method
Signature
RadialPlanePointParameters: radialPlanePoint ( NXOpen.Point) – the radial plane point valueNew in version NX8.5.1.
License requirements: cam_base (“CAM BASE”)
RadialPlaneValue¶
-
TurnProbeClearanceBuilder.RadialPlaneValue¶ Returns or sets the radial plane value
-------------------------------------Getter Method
Signature
RadialPlaneValueReturns: the radial plane value value Return type: float New in version NX8.5.1.
License requirements: None.
-------------------------------------Setter Method
Signature
RadialPlaneValueParameters: radialPlaneValue (float) – the radial plane value value New in version NX8.5.1.
License requirements: cam_base (“CAM BASE”)
Method Detail¶
Validate¶
-
TurnProbeClearanceBuilder.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.