ToolTrackingPointBuilder Class

class NXOpen.CAM.ToolTrackingPointBuilder

Bases: NXOpen.CAM.MoveBuilder

Represents the Tool Tracking Point Builder

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

New in version NX8.5.1.

Properties

Property Description
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
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.
GetAdjustRegister Get the Adjust register
GetAdjustRegisterToggle Get the Adjust register Toggle Status
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.
GetTrackingPoint Get the Tracking point index
GetUserParameter Returns the custom parameter with the given name.
GetXoffset Get the X offset
GetXoffsetToggle Get the X offset Toggle Status
GetYoffset Get the Y offset
GetYoffsetToggle Get the Y offset Toggle Status
GetZoffset Get the Z offset
GetZoffsetToggle Get the Z offset Toggle Status
SetAdjustRegister Set the Adjust register
SetAdjustRegisterToggle Set the Adjust register Toggle Status
SetParent Set parent
SetSibling Set sibling
SetTrackingPoint Set the Tracking point index
SetXoffset Set the X offset
SetXoffsetToggle Set the X offset Toggle Status
SetYoffset Set the Y offset
SetYoffsetToggle Set the Y offset Toggle Status
SetZoffset Set the Z offset
SetZoffsetToggle Set the Z offset Toggle Status
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.

Method Detail

GetAdjustRegister

ToolTrackingPointBuilder.GetAdjustRegister

Get the Adjust register

Signature GetAdjustRegister()

Returns:
Return type:int

New in version NX9.0.2.

License requirements: None.

GetAdjustRegisterToggle

ToolTrackingPointBuilder.GetAdjustRegisterToggle

Get the Adjust register Toggle Status

Signature GetAdjustRegisterToggle()

Returns:
Return type:bool

New in version NX9.0.2.

License requirements: None.

GetTrackingPoint

ToolTrackingPointBuilder.GetTrackingPoint

Get the Tracking point index

Signature GetTrackingPoint()

Returns:
Return type:int

New in version NX9.0.2.

License requirements: None.

GetXoffset

ToolTrackingPointBuilder.GetXoffset

Get the X offset

Signature GetXoffset()

Returns:
Return type:float

New in version NX9.0.2.

License requirements: None.

GetXoffsetToggle

ToolTrackingPointBuilder.GetXoffsetToggle

Get the X offset Toggle Status

Signature GetXoffsetToggle()

Returns:
Return type:bool

New in version NX9.0.2.

License requirements: None.

GetYoffset

ToolTrackingPointBuilder.GetYoffset

Get the Y offset

Signature GetYoffset()

Returns:
Return type:float

New in version NX9.0.2.

License requirements: None.

GetYoffsetToggle

ToolTrackingPointBuilder.GetYoffsetToggle

Get the Y offset Toggle Status

Signature GetYoffsetToggle()

Returns:
Return type:bool

New in version NX9.0.2.

License requirements: None.

GetZoffset

ToolTrackingPointBuilder.GetZoffset

Get the Z offset

Signature GetZoffset()

Returns:
Return type:float

New in version NX9.0.2.

License requirements: None.

GetZoffsetToggle

ToolTrackingPointBuilder.GetZoffsetToggle

Get the Z offset Toggle Status

Signature GetZoffsetToggle()

Returns:
Return type:bool

New in version NX9.0.2.

License requirements: None.

SetAdjustRegister

ToolTrackingPointBuilder.SetAdjustRegister

Set the Adjust register

Signature SetAdjustRegister(index, adjreg)

Parameters:
  • index (int) –
  • adjreg (int) –

New in version NX9.0.2.

License requirements: None.

SetAdjustRegisterToggle

ToolTrackingPointBuilder.SetAdjustRegisterToggle

Set the Adjust register Toggle Status

Signature SetAdjustRegisterToggle(index, adjregstat)

Parameters:
  • index (int) –
  • adjregstat (bool) –

New in version NX9.0.2.

License requirements: None.

SetTrackingPoint

ToolTrackingPointBuilder.SetTrackingPoint

Set the Tracking point index

Signature SetTrackingPoint(index)

Parameters:index (int) –

New in version NX9.0.2.

License requirements: None.

SetXoffset

ToolTrackingPointBuilder.SetXoffset

Set the X offset

Signature SetXoffset(index, xoff)

Parameters:
  • index (int) –
  • xoff (float) –

New in version NX9.0.2.

License requirements: None.

SetXoffsetToggle

ToolTrackingPointBuilder.SetXoffsetToggle

Set the X offset Toggle Status

Signature SetXoffsetToggle(index, xoffstat)

Parameters:
  • index (int) –
  • xoffstat (bool) –

New in version NX9.0.2.

License requirements: None.

SetYoffset

ToolTrackingPointBuilder.SetYoffset

Set the Y offset

Signature SetYoffset(index, yoff)

Parameters:
  • index (int) –
  • yoff (float) –

New in version NX9.0.2.

License requirements: None.

SetYoffsetToggle

ToolTrackingPointBuilder.SetYoffsetToggle

Set the Y offset Toggle Status

Signature SetYoffsetToggle(index, yoffstat)

Parameters:
  • index (int) –
  • yoffstat (bool) –

New in version NX9.0.2.

License requirements: None.

SetZoffset

ToolTrackingPointBuilder.SetZoffset

Set the Z offset

Signature SetZoffset(index, zoff)

Parameters:
  • index (int) –
  • zoff (float) –

New in version NX9.0.2.

License requirements: None.

SetZoffsetToggle

ToolTrackingPointBuilder.SetZoffsetToggle

Set the Z offset Toggle Status

Signature SetZoffsetToggle(index, zoffstat)

Parameters:
  • index (int) –
  • zoffstat (bool) –

New in version NX9.0.2.

License requirements: None.

Validate

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