ProbeCalibrateSphereMoveBuilder Class

class NXOpen.CAM.ProbeCalibrateSphereMoveBuilder

Bases: NXOpen.CAM.MoveBuilder

Represents the Probe Calibrate Sphere Move Builder

To create a new instance of this class, use NXOpen.CAM.MoveCollection.CreateProbeCalibrateSphereMoveBuilder()

New in version NX5.0.0.

Properties

Property	Description
Diameter	Returns or sets the diameter defining the sphere 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 type of geometry
MotionType	Returns or sets the motion type
NumberOfUserParameters	Returns the number of user parameters
Point	Returns or sets the point defining the sphere to probe
ProbeProtectedParameters	Returns the probe protected parameters builder
ProtectedMove	Returns or sets the protected move status
Sphere	Returns or sets the sphere to probe
SubopLabel	Returns or sets the subop label
Tag	Returns the Tag for this object.
ToolOffset	Returns or sets the tool 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

ProbeCalibrateSphereMoveBuilderGeometry Enumeration

the geometry types

Property Detail

Diameter

ProbeCalibrateSphereMoveBuilder.Diameter

Returns or sets the diameter defining the sphere to probe

-------------------------------------

Getter Method

Signature Diameter

Returns: Return type:float

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Diameter

Parameters:diameter (float) –

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

GeometryType

ProbeCalibrateSphereMoveBuilder.GeometryType

Returns or sets the type of geometry

-------------------------------------

Getter Method

Signature GeometryType

Returns: Return type:NXOpen.CAM.ProbeCalibrateSphereMoveBuilderGeometry

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature GeometryType

Parameters:geomType (NXOpen.CAM.ProbeCalibrateSphereMoveBuilderGeometry) –

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

Point

ProbeCalibrateSphereMoveBuilder.Point

Returns or sets the point defining the sphere to probe

-------------------------------------

Getter Method

Signature Point

Returns: Return type:NXOpen.Point

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Point

Parameters:point (NXOpen.Point) –

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

ProbeProtectedParameters

ProbeCalibrateSphereMoveBuilder.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.

Sphere

ProbeCalibrateSphereMoveBuilder.Sphere

Returns or sets the sphere to probe

-------------------------------------

Getter Method

Signature Sphere

Returns: Return type:NXOpen.NXObject

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Sphere

Parameters:sphere (NXOpen.NXObject) –

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

ToolOffset

ProbeCalibrateSphereMoveBuilder.ToolOffset

Returns or sets the tool offset to update

-------------------------------------

Getter Method

Signature ToolOffset

Returns: Return type:int

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ToolOffset

Parameters:toolOffset (int) –

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

Method Detail

Validate

ProbeCalibrateSphereMoveBuilder.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.