ProbeInspectBorebossMoveBuilder Class¶
-
class
NXOpen.CAM.ProbeInspectBorebossMoveBuilder¶ Bases:
NXOpen.CAM.MoveBuilderRepresents the Probe Inspect Bore Boss Move Builder
To create a new instance of this class, use
NXOpen.CAM.MoveCollection.CreateProbeInspectBorebossMoveBuilder()New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| Angle1 | Returns or sets the 1st custom angle to probe at |
| Angle2 | Returns or sets the 2nd custom angle to probe at |
| Angle3 | Returns or sets the 3rd custom angle to probe at |
| AngleType | Returns or sets the angle type |
| ArcVector | Returns or sets the arc vector defining the cylinder to inspect |
| BossDimension | Returns or sets the radial clearance from nominal target surface |
| CycleType | Returns or sets the cycle type |
| Cylinder | Returns or sets the cylinder to inspect |
| DepthType | Returns or sets the depth type |
| Diameter | Returns or sets the diameter defining the cylinder to probe |
| FeedRate | Returns or sets the feed rate |
| FeedType | Returns or sets the feed type |
| FeedUnit | Returns or sets the feed unit |
| GeometryType | Returns or sets the geometry type |
| MeasurementDepth | Returns or sets the probing depth |
| MotionType | Returns or sets the motion type |
| NumberOfUserParameters | Returns the number of user parameters |
| Point | Returns or sets the point defining the cylinder to inspect |
| ProbeControlParameters | Returns the probe control parameters builder |
| ProbeProtectedParameters | Returns the probe protected parameters builder |
| ProbeStockParameters | Returns the probe stock parameters builder |
| ProbeToleranceParameters | Returns the probe tolerance parameters builder |
| ProtectedMove | Returns or sets the protected move status |
| 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¶
| ProbeInspectBorebossMoveBuilderAngle Enumeration | the angle type |
| ProbeInspectBorebossMoveBuilderCycle Enumeration | the cycle type |
| ProbeInspectBorebossMoveBuilderDepth Enumeration | the depth type |
| ProbeInspectBorebossMoveBuilderGeometry Enumeration | the geometry type |
Property Detail¶
Angle1¶
-
ProbeInspectBorebossMoveBuilder.Angle1¶ Returns or sets the 1st custom angle to probe at
-------------------------------------Getter Method
Signature
Angle1Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Angle1Parameters: angle1 (float) – New in version NX5.0.0.
License requirements: None.
Angle2¶
-
ProbeInspectBorebossMoveBuilder.Angle2¶ Returns or sets the 2nd custom angle to probe at
-------------------------------------Getter Method
Signature
Angle2Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Angle2Parameters: angle2 (float) – New in version NX5.0.0.
License requirements: None.
Angle3¶
-
ProbeInspectBorebossMoveBuilder.Angle3¶ Returns or sets the 3rd custom angle to probe at
-------------------------------------Getter Method
Signature
Angle3Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Angle3Parameters: angle3 (float) – New in version NX5.0.0.
License requirements: None.
AngleType¶
-
ProbeInspectBorebossMoveBuilder.AngleType¶ Returns or sets the angle type
-------------------------------------Getter Method
Signature
AngleTypeReturns: Return type: NXOpen.CAM.ProbeInspectBorebossMoveBuilderAngleNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AngleTypeParameters: angleType ( NXOpen.CAM.ProbeInspectBorebossMoveBuilderAngle) –New in version NX5.0.0.
License requirements: None.
ArcVector¶
-
ProbeInspectBorebossMoveBuilder.ArcVector¶ Returns or sets the arc vector defining the cylinder to inspect
-------------------------------------Getter Method
Signature
ArcVectorReturns: Return type: NXOpen.NXObjectNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ArcVectorParameters: vector ( NXOpen.NXObject) –New in version NX5.0.0.
License requirements: None.
BossDimension¶
-
ProbeInspectBorebossMoveBuilder.BossDimension¶ Returns or sets the radial clearance from nominal target surface
-------------------------------------Getter Method
Signature
BossDimensionReturns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BossDimensionParameters: radialClearance (float) – New in version NX5.0.0.
License requirements: None.
CycleType¶
-
ProbeInspectBorebossMoveBuilder.CycleType¶ Returns or sets the cycle type
-------------------------------------Getter Method
Signature
CycleTypeReturns: Return type: NXOpen.CAM.ProbeInspectBorebossMoveBuilderCycleNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CycleTypeParameters: cycleType ( NXOpen.CAM.ProbeInspectBorebossMoveBuilderCycle) –New in version NX5.0.0.
License requirements: None.
Cylinder¶
-
ProbeInspectBorebossMoveBuilder.Cylinder¶ Returns or sets the cylinder to inspect
-------------------------------------Getter Method
Signature
CylinderReturns: Return type: NXOpen.NXObjectNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CylinderParameters: face ( NXOpen.NXObject) –New in version NX5.0.0.
License requirements: None.
DepthType¶
-
ProbeInspectBorebossMoveBuilder.DepthType¶ Returns or sets the depth type
-------------------------------------Getter Method
Signature
DepthTypeReturns: Return type: NXOpen.CAM.ProbeInspectBorebossMoveBuilderDepthNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DepthTypeParameters: depthType ( NXOpen.CAM.ProbeInspectBorebossMoveBuilderDepth) –New in version NX5.0.0.
License requirements: None.
Diameter¶
-
ProbeInspectBorebossMoveBuilder.Diameter¶ Returns or sets the diameter defining the cylinder to probe
-------------------------------------Getter Method
Signature
DiameterReturns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DiameterParameters: diameter (float) – New in version NX5.0.0.
License requirements: None.
GeometryType¶
-
ProbeInspectBorebossMoveBuilder.GeometryType¶ Returns or sets the geometry type
-------------------------------------Getter Method
Signature
GeometryTypeReturns: Return type: NXOpen.CAM.ProbeInspectBorebossMoveBuilderGeometryNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
GeometryTypeParameters: geomType ( NXOpen.CAM.ProbeInspectBorebossMoveBuilderGeometry) –New in version NX5.0.0.
License requirements: None.
MeasurementDepth¶
-
ProbeInspectBorebossMoveBuilder.MeasurementDepth¶ Returns or sets the probing depth
-------------------------------------Getter Method
Signature
MeasurementDepthReturns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MeasurementDepthParameters: measurementDepth (float) – New in version NX5.0.0.
License requirements: None.
Point¶
-
ProbeInspectBorebossMoveBuilder.Point¶ Returns or sets the point defining the cylinder to inspect
-------------------------------------Getter Method
Signature
PointReturns: Return type: NXOpen.PointNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PointParameters: point ( NXOpen.Point) –New in version NX5.0.0.
License requirements: None.
ProbeControlParameters¶
-
ProbeInspectBorebossMoveBuilder.ProbeControlParameters¶ Returns the probe control parameters builder
-------------------------------------Getter Method
Signature
ProbeControlParametersReturns: Return type: NXOpen.CAM.ProbeControlParametersBuilderNew in version NX5.0.0.
License requirements: None.
ProbeProtectedParameters¶
-
ProbeInspectBorebossMoveBuilder.ProbeProtectedParameters¶ Returns the probe protected parameters builder
-------------------------------------Getter Method
Signature
ProbeProtectedParametersReturns: Return type: NXOpen.CAM.ProbeProtectedParametersBuilderNew in version NX5.0.0.
License requirements: None.
ProbeStockParameters¶
-
ProbeInspectBorebossMoveBuilder.ProbeStockParameters¶ Returns the probe stock parameters builder
-------------------------------------Getter Method
Signature
ProbeStockParametersReturns: Return type: NXOpen.CAM.ProbeStockParametersBuilderNew in version NX5.0.0.
License requirements: None.
ProbeToleranceParameters¶
-
ProbeInspectBorebossMoveBuilder.ProbeToleranceParameters¶ Returns the probe tolerance parameters builder
-------------------------------------Getter Method
Signature
ProbeToleranceParametersReturns: Return type: NXOpen.CAM.ProbeToleranceParametersBuilderNew in version NX5.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
ProbeInspectBorebossMoveBuilder.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.