ProbeCalibrateStylusMoveBuilder Class¶
-
class
NXOpen.CAM.
ProbeCalibrateStylusMoveBuilder
¶ Bases:
NXOpen.CAM.MoveBuilder
Represents the Probe Calibrate Stylus Move Builder
To create a new instance of this class, use
NXOpen.CAM.MoveCollection.CreateProbeCalibrateStylusMoveBuilder()
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
ArcVector | Returns or sets the arc vector defining the cylinder to probe |
CalibrationDepth | Returns or sets the calibration depth |
CalibrationType | Returns or sets the calibration type |
Cylinder | Returns or sets the cylinder to probe |
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 |
MotionType | Returns or sets the motion type |
NumberOfUserParameters | Returns the number of user parameters |
OutputWorkOffset | Returns or sets the option to output the work offset to update |
Point | Returns or sets the point defining the cylinder to probe |
ProbeProtectedParameters | Returns the probe protected parameters builder |
ProtectedMove | Returns or sets the protected move status |
SubopLabel | Returns or sets the subop label |
Tag | Returns the Tag for this object. |
WorkOffset | Returns or sets the work offset to update |
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¶
ProbeCalibrateStylusMoveBuilderCalibrateStylusType Enumeration | the stylus calibration types |
ProbeCalibrateStylusMoveBuilderDepth Enumeration | the depth types |
ProbeCalibrateStylusMoveBuilderGeometry Enumeration | the geometry types |
Property Detail¶
ArcVector¶
-
ProbeCalibrateStylusMoveBuilder.
ArcVector
¶ Returns or sets the arc vector defining the cylinder to probe
-------------------------------------
Getter Method
Signature
ArcVector()
Returns: Return type: NXOpen.NXObject
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ArcVector(vector)
Parameters: vector ( NXOpen.NXObject
) –New in version NX5.0.0.
License requirements: None.
CalibrationDepth¶
-
ProbeCalibrateStylusMoveBuilder.
CalibrationDepth
¶ Returns or sets the calibration depth
-------------------------------------
Getter Method
Signature
CalibrationDepth()
Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CalibrationDepth(calibrationDepth)
Parameters: calibrationDepth (float) – New in version NX5.0.0.
License requirements: None.
CalibrationType¶
-
ProbeCalibrateStylusMoveBuilder.
CalibrationType
¶ Returns or sets the calibration type
-------------------------------------
Getter Method
Signature
CalibrationType()
Returns: Return type: NXOpen.CAM.ProbeCalibrateStylusMoveBuilderCalibrateStylusType
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CalibrationType(calibType)
Parameters: calibType ( NXOpen.CAM.ProbeCalibrateStylusMoveBuilderCalibrateStylusType
) –New in version NX5.0.0.
License requirements: None.
Cylinder¶
-
ProbeCalibrateStylusMoveBuilder.
Cylinder
¶ Returns or sets the cylinder to probe
-------------------------------------
Getter Method
Signature
Cylinder()
Returns: Return type: NXOpen.NXObject
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Cylinder(cylinder)
Parameters: cylinder ( NXOpen.NXObject
) –New in version NX5.0.0.
License requirements: None.
DepthType¶
-
ProbeCalibrateStylusMoveBuilder.
DepthType
¶ Returns or sets the depth type
-------------------------------------
Getter Method
Signature
DepthType()
Returns: Return type: NXOpen.CAM.ProbeCalibrateStylusMoveBuilderDepth
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DepthType(depthType)
Parameters: depthType ( NXOpen.CAM.ProbeCalibrateStylusMoveBuilderDepth
) –New in version NX5.0.0.
License requirements: None.
Diameter¶
-
ProbeCalibrateStylusMoveBuilder.
Diameter
¶ Returns or sets the diameter defining the cylinder to probe
-------------------------------------
Getter Method
Signature
Diameter()
Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Diameter(diameter)
Parameters: diameter (float) – New in version NX5.0.0.
License requirements: None.
GeometryType¶
-
ProbeCalibrateStylusMoveBuilder.
GeometryType
¶ Returns or sets the geometry type
-------------------------------------
Getter Method
Signature
GeometryType()
Returns: Return type: NXOpen.CAM.ProbeCalibrateStylusMoveBuilderGeometry
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GeometryType(geomType)
Parameters: geomType ( NXOpen.CAM.ProbeCalibrateStylusMoveBuilderGeometry
) –New in version NX5.0.0.
License requirements: None.
OutputWorkOffset¶
-
ProbeCalibrateStylusMoveBuilder.
OutputWorkOffset
¶ Returns or sets the option to output the work offset to update
-------------------------------------
Getter Method
Signature
OutputWorkOffset()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OutputWorkOffset(newValue)
Parameters: newValue (bool) – New in version NX5.0.0.
License requirements: None.
Point¶
-
ProbeCalibrateStylusMoveBuilder.
Point
¶ Returns or sets the point defining the cylinder to probe
-------------------------------------
Getter Method
Signature
Point()
Returns: Return type: NXOpen.Point
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Point(point)
Parameters: point ( NXOpen.Point
) –New in version NX5.0.0.
License requirements: None.
ProbeProtectedParameters¶
-
ProbeCalibrateStylusMoveBuilder.
ProbeProtectedParameters
¶ Returns the probe protected parameters builder
-------------------------------------
Getter Method
Signature
ProbeProtectedParameters()
Returns: Return type: NXOpen.CAM.ProbeProtectedParametersBuilder
New in version NX5.0.0.
License requirements: None.
WorkOffset¶
-
ProbeCalibrateStylusMoveBuilder.
WorkOffset
¶ Returns or sets the work offset to update
-------------------------------------
Getter Method
Signature
WorkOffset()
Returns: Return type: int New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
WorkOffset(workOffset)
Parameters: workOffset (int) – New in version NX5.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
ProbeCalibrateStylusMoveBuilder.
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.