InspectionProbeTrackingBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# InspectionProbeTrackingBuilder Class

class `NXOpen.CAM.``InspectionProbeTrackingBuilder`

  Bases: `NXOpen.CAM.SolidTrackingBuilder`

  Represents a InspectionProbeTracking builder

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

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
AxialPercent | Returns or sets the axial percentage
Axis | Returns or sets the stem axis
Location | Returns or sets the location
StemTop | Returns or sets the stem top
Tag | Returns the Tag for this object.
TipType | Returns or sets the tip type
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.
SetLocationParameters | Set the trackpoint location and default parameters
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

InspectionProbeTrackingBuilderTipTypes Enumeration | the tip type

# Property Detail

## AxialPercent

`InspectionProbeTrackingBuilder.``AxialPercent`

  Returns or sets the axial percentage

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

  Getter Method

  Signature `AxialPercent`

  Returns: | the axial percentage
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AxialPercent`

  Parameters: | pct (float) – the axial percentage

  New in version NX9.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## Axis

`InspectionProbeTrackingBuilder.``Axis`

  Returns or sets the stem axis

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

  Getter Method

  Signature `Axis`

  Returns: | the axis tag
  Return type: | `NXOpen.NXObject`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Axis`

  Parameters: | axis (`NXOpen.NXObject`) – the axis tag

  New in version NX9.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## StemTop

`InspectionProbeTrackingBuilder.``StemTop`

  Returns or sets the stem top

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

  Getter Method

  Signature `StemTop`

  Returns: | the stem_top tag
  Return type: | `NXOpen.NXObject`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StemTop`

  Parameters: | stemTop (`NXOpen.NXObject`) – the stem_top tag

  New in version NX9.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## TipType

`InspectionProbeTrackingBuilder.``TipType`

  Returns or sets the tip type

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

  Getter Method

  Signature `TipType`

  Returns: |
  Return type: | `NXOpen.CAM.InspectionProbeTrackingBuilderTipTypes`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `TipType`

  Parameters: | type (`NXOpen.CAM.InspectionProbeTrackingBuilderTipTypes`) –

  New in version NX9.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

# Method Detail

## SetLocationParameters

`InspectionProbeTrackingBuilder.``SetLocationParameters`

  Set the trackpoint location and default parameters

  Signature `SetLocationParameters(tpLocation)`

  Parameters: | tpLocation (`NXOpen.NXObject`) – the trackpoint geometry

  New in version NX9.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## Validate

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