InspectionAnalyzeBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# InspectionAnalyzeBuilder Class

class `NXOpen.CAM.``InspectionAnalyzeBuilder`

  Bases: `NXOpen.Builder`

  Inspection Analyze options dialog builder

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

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
AxisExtrapolation | Returns or sets the analysis axis extrapolation type
CylinderFitting | Returns or sets the analysis cylinder/circle fitting type
DatumPlaneFitting | Returns or sets the analysis datum plane fitting type
LimitsOfSize | Returns or sets the analysis limits of size fitting type
ProfileDisposition | Returns or sets the analysis profile disposition fitting type
Rx | Returns or sets the DOF setting in the X Rotation direction
RxLower | Returns or sets the rotation in X DOF lower limit
RxUpper | Returns or sets the rotation in X DOF upper limit
Ry | Returns or sets the DOF setting in the Y Rotation direction
RyLower | Returns or sets the rotation in Y DOF lower limit
RyUpper | Returns or sets the rotation in Y DOF upper limit
Rz | Returns or sets the DOF setting in the Z Rotation direction
RzLower | Returns or sets the rotation in Z DOF lower limit
RzUpper | Returns or sets the rotation in Z DOF upper limit
SurfaceProfile | Returns or sets the analysis surface profile fitting type
Tag | Returns the Tag for this object.
ToleranceName | Returns or sets the tolerance defining the DOF limits
Tx | Returns or sets the DOF setting in the X Translation direction
TxLower | Returns or sets the translation in X DOF lower limit
TxUpper | Returns or sets the translation in X DOF upper limit
Ty | Returns or sets the DOF setting in the Y Translation direction
TyLower | Returns or sets the translation in Y DOF lower limit
TyUpper | Returns or sets the translation in Y DOF upper limit
Tz | Returns or sets the DOF setting in the Z Translation direction
TzLower | Returns or sets the translation in Z DOF lower limit
TzUpper | Returns or sets the translation in Z DOF upper limit

# Methods

Method | Description
--- | ---
AnalyzeAll | Run Analysis for All Operations
AnalyzeSelected | Run Analysis for Selected Operations
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.
UseDefault | Reset to use Tolerance
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

InspectionAnalyzeBuilderDofTypes Enumeration | Inspection Analysis Degrees of Freedom Types

# Property Detail

## AxisExtrapolation

`InspectionAnalyzeBuilder.``AxisExtrapolation`

  Returns or sets the analysis axis extrapolation type

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

  Getter Method

  Signature `AxisExtrapolation`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `AxisExtrapolation`

  Parameters: | axisExtrapolation (`NXOpen.CAM.InspectionMethodBuilderAxisExtrapolationTypes`) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## CylinderFitting

`InspectionAnalyzeBuilder.``CylinderFitting`

  Returns or sets the analysis cylinder/circle fitting type

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

  Getter Method

  Signature `CylinderFitting`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `CylinderFitting`

  Parameters: | cylinderFitting (`NXOpen.CAM.InspectionMethodBuilderCylinderFittingTypes`) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## DatumPlaneFitting

`InspectionAnalyzeBuilder.``DatumPlaneFitting`

  Returns or sets the analysis datum plane fitting type

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

  Getter Method

  Signature `DatumPlaneFitting`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `DatumPlaneFitting`

  Parameters: | datumPlaneFitting (`NXOpen.CAM.InspectionMethodBuilderDatumPlaneFittingTypes`) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## LimitsOfSize

`InspectionAnalyzeBuilder.``LimitsOfSize`

  Returns or sets the analysis limits of size fitting type

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

  Getter Method

  Signature `LimitsOfSize`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `LimitsOfSize`

  Parameters: | limitsOfSize (`NXOpen.CAM.InspectionMethodBuilderLimitsOfSizeTypes`) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## ProfileDisposition

`InspectionAnalyzeBuilder.``ProfileDisposition`

  Returns or sets the analysis profile disposition fitting type

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

  Getter Method

  Signature `ProfileDisposition`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ProfileDisposition`

  Parameters: | profileDisposition (`NXOpen.CAM.InspectionMethodBuilderProfileDispositionTypes`) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## Rx

`InspectionAnalyzeBuilder.``Rx`

  Returns or sets the DOF setting in the X Rotation direction

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

  Getter Method

  Signature `Rx`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Rx`

  Parameters: | rx (`NXOpen.CAM.InspectionAnalyzeBuilderDofTypes`) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## RxLower

`InspectionAnalyzeBuilder.``RxLower`

  Returns or sets the rotation in X DOF lower limit

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

  Getter Method

  Signature `RxLower`

  Returns: |
  Return type: | float

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `RxLower`

  Parameters: | rxLower (float) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## RxUpper

`InspectionAnalyzeBuilder.``RxUpper`

  Returns or sets the rotation in X DOF upper limit

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

  Getter Method

  Signature `RxUpper`

  Returns: |
  Return type: | float

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `RxUpper`

  Parameters: | rxUpper (float) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## Ry

`InspectionAnalyzeBuilder.``Ry`

  Returns or sets the DOF setting in the Y Rotation direction

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

  Getter Method

  Signature `Ry`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Ry`

  Parameters: | ry (`NXOpen.CAM.InspectionAnalyzeBuilderDofTypes`) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## RyLower

`InspectionAnalyzeBuilder.``RyLower`

  Returns or sets the rotation in Y DOF lower limit

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

  Getter Method

  Signature `RyLower`

  Returns: |
  Return type: | float

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `RyLower`

  Parameters: | ryLower (float) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## RyUpper

`InspectionAnalyzeBuilder.``RyUpper`

  Returns or sets the rotation in Y DOF upper limit

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

  Getter Method

  Signature `RyUpper`

  Returns: |
  Return type: | float

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `RyUpper`

  Parameters: | ryUpper (float) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## Rz

`InspectionAnalyzeBuilder.``Rz`

  Returns or sets the DOF setting in the Z Rotation direction

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

  Getter Method

  Signature `Rz`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Rz`

  Parameters: | rz (`NXOpen.CAM.InspectionAnalyzeBuilderDofTypes`) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## RzLower

`InspectionAnalyzeBuilder.``RzLower`

  Returns or sets the rotation in Z DOF lower limit

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

  Getter Method

  Signature `RzLower`

  Returns: |
  Return type: | float

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `RzLower`

  Parameters: | rzLower (float) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## RzUpper

`InspectionAnalyzeBuilder.``RzUpper`

  Returns or sets the rotation in Z DOF upper limit

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

  Getter Method

  Signature `RzUpper`

  Returns: |
  Return type: | float

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `RzUpper`

  Parameters: | rzUpper (float) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SurfaceProfile

`InspectionAnalyzeBuilder.``SurfaceProfile`

  Returns or sets the analysis surface profile fitting type

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

  Getter Method

  Signature `SurfaceProfile`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SurfaceProfile`

  Parameters: | surfaceProfile (`NXOpen.CAM.InspectionMethodBuilderSurfaceProfileTypes`) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## ToleranceName

`InspectionAnalyzeBuilder.``ToleranceName`

  Returns or sets the tolerance defining the DOF limits

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

  Getter Method

  Signature `ToleranceName`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ToleranceName`

  Parameters: | toleranceName (str) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## Tx

`InspectionAnalyzeBuilder.``Tx`

  Returns or sets the DOF setting in the X Translation direction

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

  Getter Method

  Signature `Tx`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Tx`

  Parameters: | tx (`NXOpen.CAM.InspectionAnalyzeBuilderDofTypes`) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## TxLower

`InspectionAnalyzeBuilder.``TxLower`

  Returns or sets the translation in X DOF lower limit

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

  Getter Method

  Signature `TxLower`

  Returns: |
  Return type: | float

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `TxLower`

  Parameters: | txLower (float) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## TxUpper

`InspectionAnalyzeBuilder.``TxUpper`

  Returns or sets the translation in X DOF upper limit

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

  Getter Method

  Signature `TxUpper`

  Returns: |
  Return type: | float

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `TxUpper`

  Parameters: | txUpper (float) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## Ty

`InspectionAnalyzeBuilder.``Ty`

  Returns or sets the DOF setting in the Y Translation direction

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

  Getter Method

  Signature `Ty`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Ty`

  Parameters: | ty (`NXOpen.CAM.InspectionAnalyzeBuilderDofTypes`) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## TyLower

`InspectionAnalyzeBuilder.``TyLower`

  Returns or sets the translation in Y DOF lower limit

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

  Getter Method

  Signature `TyLower`

  Returns: |
  Return type: | float

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `TyLower`

  Parameters: | tyLower (float) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## TyUpper

`InspectionAnalyzeBuilder.``TyUpper`

  Returns or sets the translation in Y DOF upper limit

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

  Getter Method

  Signature `TyUpper`

  Returns: |
  Return type: | float

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `TyUpper`

  Parameters: | tyUpper (float) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## Tz

`InspectionAnalyzeBuilder.``Tz`

  Returns or sets the DOF setting in the Z Translation direction

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

  Getter Method

  Signature `Tz`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Tz`

  Parameters: | tz (`NXOpen.CAM.InspectionAnalyzeBuilderDofTypes`) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## TzLower

`InspectionAnalyzeBuilder.``TzLower`

  Returns or sets the translation in Z DOF lower limit

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

  Getter Method

  Signature `TzLower`

  Returns: |
  Return type: | float

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `TzLower`

  Parameters: | tzLower (float) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## TzUpper

`InspectionAnalyzeBuilder.``TzUpper`

  Returns or sets the translation in Z DOF upper limit

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

  Getter Method

  Signature `TzUpper`

  Returns: |
  Return type: | float

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `TzUpper`

  Parameters: | tzUpper (float) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

# Method Detail

## AnalyzeAll

`InspectionAnalyzeBuilder.``AnalyzeAll`

  Run Analysis for All Operations

  Signature `AnalyzeAll()`

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## AnalyzeSelected

`InspectionAnalyzeBuilder.``AnalyzeSelected`

  Run Analysis for Selected Operations

  Signature `AnalyzeSelected(objects)`

  Parameters: | objects (list of `NXOpen.CAM.CAMObject`) – array of operations

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## UseDefault

`InspectionAnalyzeBuilder.``UseDefault`

  Reset to use Tolerance

  Signature `UseDefault()`

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## Validate

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