SolidTrackingBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SolidTrackingBuilder Class

class `NXOpen.CAM.``SolidTrackingBuilder`

  Bases: `NXOpen.CAM.TrackpointBuilder`

  Represents a SolidTracking Builder

  To create a new instance of this class, use `NXOpen.CAM.Tool.CreateSolidTrackingBuilder()`

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
Location | Returns or sets the location
Tag | Returns the Tag for this object.
TlAdjReg | Returns or sets the adjust register
TlCutcomReg | Returns or sets the cutcom register
TrackingName | Returns or sets the Tracking Point name value
TrackingXOff | Returns or sets the XOff value
TrackingYOff | Returns or sets the YOff value
TrackingZOff | Returns or sets the ZOff value

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

# Property Detail

## Location

`SolidTrackingBuilder.``Location`

  Returns or sets the location

  `-------------------------------------`

  Getter Method

  Signature `Location`

  Returns: | the tracking point
  Return type: | `NXOpen.NXObject`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Location`

  Parameters: | tpLocation (`NXOpen.NXObject`) – the tracking point tag

  New in version NX5.0.0.

  License requirements: None.

## TrackingXOff

`SolidTrackingBuilder.``TrackingXOff`

  Returns or sets the XOff value

  `-------------------------------------`

  Getter Method

  Signature `TrackingXOff`

  Returns: | the xoff value
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `TrackingXOff`

  Parameters: | xoffValue (float) – the xoff value

  New in version NX5.0.0.

  License requirements: None.

## TrackingYOff

`SolidTrackingBuilder.``TrackingYOff`

  Returns or sets the YOff value

  `-------------------------------------`

  Getter Method

  Signature `TrackingYOff`

  Returns: | the yoff value
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `TrackingYOff`

  Parameters: | yoffValue (float) – the yoff value

  New in version NX5.0.0.

  License requirements: None.

## TrackingZOff

`SolidTrackingBuilder.``TrackingZOff`

  Returns or sets the ZOff value

  `-------------------------------------`

  Getter Method

  Signature `TrackingZOff`

  Returns: | the zoff value
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `TrackingZOff`

  Parameters: | zoffValue (float) – the zoff value

  New in version NX5.0.0.

  License requirements: None.

# Method Detail

## Validate

`SolidTrackingBuilder.``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.