InspectionUVGridBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# InspectionUVGridBuilder Class

class `NXOpen.CAM.``InspectionUVGridBuilder`

  Bases: `NXOpen.CAM.InspectionMoveBuilder`

  Represents the builder for the CMM Inspection UV Grid sub-operation.

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

  New in version NX7.0.0.

# Properties

Property | Description
--- | ---
AlignMachineAxes | Returns or sets the flag to align with machine axes
AngleA | Returns or sets the A angle for an indexable head
AngleB | Returns or sets the B angle for an indexable head
ApproachDist | Returns the approach distance
ApproachDistance | Returns or sets the approach distance
DepthDistance | Returns or sets the depth distance
DepthMethod | Returns or sets the depth method
EndU | Returns the end value in U
EndUDeg | Returns the end degrees value in U
EndUDist | Returns the end distance value in U
EndUMode | Returns or sets the end U mode
EndUSweep | Returns the sweep value in U
EndV | Returns the end value in V
EndVDeg | Returns the end degrees value in V
EndVDist | Returns the end distance value in V
EndVMode | Returns or sets the end V mode
EndVSweep | Returns the sweep value in V
MeasuredGeometry | Returns or sets the measured geometry
MotionType | Returns or sets the motion type
NumberOfUPoints | Returns the number of points in U
NumberOfVPoints | Returns the number of points in V
NumberOfValidPoints | Returns or sets the number of valid points created for the UV Grid
PointSequenceDirection | Returns or sets the point sequence start direction
PointSequenceMode | Returns or sets the point sequence mode
PointSequenceStart | Returns or sets the point sequence start location
ProbeTipType | Returns or sets the preferred probe tip type
ProbeTipTypeBuilder | Returns the Probe Tip Type Builder
RetractDist | Returns the retract distance
RetractDistance | Returns or sets the retract distance
SearchDist | Returns the search distance
SensorOpName | Returns or sets the inspection sensor operation name
SensorStrategy | Returns or sets the sensor selection strategy
SensorStrategyBuilder | Returns the Sensor Strategy Enum Builder
SequenceOptimization | Returns or sets the path point sequence optimization setting
SphereAxisMethod | Returns or sets the method for determining the axis for a sphere
SphereAxisVector | Returns or sets the sphere axis vector
StartPointMode | Returns or sets the start point mode
StartU | Returns the start value in U
StartUDeg | Returns the start degrees value in U
StartUDist | Returns the start distance value in U
StartUMode | Returns or sets the start U mode
StartUSweep | Returns the start sweep value in U
StartV | Returns the start value in V
StartVDeg | Returns the start degrees value in V
StartVDist | Returns the start distance value in V
StartVMode | Returns or sets the start V mode
StartVSweep | Returns the start sweep value in V
Tag | Returns the Tag for this object.
TipAngleMode | Returns or sets the tip angle selection mode
TipMode | Returns or sets the probe tip selection mode
TipNumber | Returns or sets the probe tip number
UseFeatureCollisionAvoidance | Returns or sets the flag to use feature collision avoidance
UsePartCollisionAvoidance | Returns or sets the flag to use part collision avoidance

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CopyAttributes | Copy point grid parameters
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.
LockMove | Set lock to prevent move parameters from being changed programmatically.
SetAppDistChanged | Flag indicating whether approach distance changed.
SetLayoutChanged | Flag indicating whether layout changed.
SetParent | Set parent
SetPointCoverageChanged | Flag indicating whether point coverage changed.
SetPointSequenceChanged | Flag indicating whether point sequence changed.
SetProbeAngles | Set default values for probe angles based on feature type.
SetProbeTip | Set default probe tip based on preferred tip type and probe angles.
SetRetDistChanged | Flag indicating whether retract distance changed.
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

InspectionUVGridBuilderSphereAxisType Enumeration | the method for determining the axis for a sphere
InspectionUVGridBuilderStartPointType Enumeration | the start point mode

# Property Detail

## AlignMachineAxes

`InspectionUVGridBuilder.``AlignMachineAxes`

  Returns or sets the flag to align with machine axes

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

  Getter Method

  Signature `AlignMachineAxes`

  Returns: |
  Return type: | bool

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AlignMachineAxes`

  Parameters: | flag (bool) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## ApproachDist

`InspectionUVGridBuilder.``ApproachDist`

  Returns the approach distance

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

  Getter Method

  Signature `ApproachDist`

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

  New in version NX7.0.0.

  License requirements: None.

## DepthDistance

`InspectionUVGridBuilder.``DepthDistance`

  Returns or sets the depth distance

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

  Getter Method

  Signature `DepthDistance`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DepthDistance`

  Parameters: | distance (float) –

  New in version NX9.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## DepthMethod

`InspectionUVGridBuilder.``DepthMethod`

  Returns or sets the depth method

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

  Getter Method

  Signature `DepthMethod`

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

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DepthMethod`

  Parameters: | method (`NXOpen.CAM.InspectionMoveBuilderDepthMethodTypes`) –

  New in version NX9.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## EndU

`InspectionUVGridBuilder.``EndU`

  Returns the end value in U

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

  Getter Method

  Signature `EndU`

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

  New in version NX7.0.0.

  License requirements: None.

## EndUDeg

`InspectionUVGridBuilder.``EndUDeg`

  Returns the end degrees value in U

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

  Getter Method

  Signature `EndUDeg`

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

  New in version NX7.5.0.

  License requirements: None.

## EndUDist

`InspectionUVGridBuilder.``EndUDist`

  Returns the end distance value in U

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

  Getter Method

  Signature `EndUDist`

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

  New in version NX7.5.0.

  License requirements: None.

## EndUMode

`InspectionUVGridBuilder.``EndUMode`

  Returns or sets the end U mode

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

  Getter Method

  Signature `EndUMode`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `EndUMode`

  Parameters: | uvMode (`NXOpen.CAM.InspectionMethodBuilderUVModeTypes`) –

  New in version NX7.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## EndUSweep

`InspectionUVGridBuilder.``EndUSweep`

  Returns the sweep value in U

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

  Getter Method

  Signature `EndUSweep`

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

  New in version NX7.5.0.

  License requirements: None.

## EndV

`InspectionUVGridBuilder.``EndV`

  Returns the end value in V

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

  Getter Method

  Signature `EndV`

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

  New in version NX7.0.0.

  License requirements: None.

## EndVDeg

`InspectionUVGridBuilder.``EndVDeg`

  Returns the end degrees value in V

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

  Getter Method

  Signature `EndVDeg`

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

  New in version NX7.5.0.

  License requirements: None.

## EndVDist

`InspectionUVGridBuilder.``EndVDist`

  Returns the end distance value in V

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

  Getter Method

  Signature `EndVDist`

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

  New in version NX7.5.0.

  License requirements: None.

## EndVMode

`InspectionUVGridBuilder.``EndVMode`

  Returns or sets the end V mode

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

  Getter Method

  Signature `EndVMode`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `EndVMode`

  Parameters: | uvMode (`NXOpen.CAM.InspectionMethodBuilderUVModeTypes`) –

  New in version NX7.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## EndVSweep

`InspectionUVGridBuilder.``EndVSweep`

  Returns the sweep value in V

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

  Getter Method

  Signature `EndVSweep`

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

  New in version NX7.5.0.

  License requirements: None.

## MeasuredGeometry

`InspectionUVGridBuilder.``MeasuredGeometry`

  Returns or sets the measured geometry

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

  Getter Method

  Signature `MeasuredGeometry`

  Returns: |
  Return type: | `NXOpen.NXObject`

  New in version NX9.0.2.

  License requirements: None.

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

  Setter Method

  Signature `MeasuredGeometry`

  Parameters: | face (`NXOpen.NXObject`) –

  New in version NX9.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## NumberOfUPoints

`InspectionUVGridBuilder.``NumberOfUPoints`

  Returns the number of points in U

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

  Getter Method

  Signature `NumberOfUPoints`

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

  New in version NX7.0.0.

  License requirements: None.

## NumberOfVPoints

`InspectionUVGridBuilder.``NumberOfVPoints`

  Returns the number of points in V

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

  Getter Method

  Signature `NumberOfVPoints`

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

  New in version NX7.0.0.

  License requirements: None.

## NumberOfValidPoints

`InspectionUVGridBuilder.``NumberOfValidPoints`

  Returns or sets the number of valid points created for the UV Grid

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

  Getter Method

  Signature `NumberOfValidPoints`

  Returns: |
  Return type: | int

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NumberOfValidPoints`

  Parameters: | numPoints (int) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## PointSequenceDirection

`InspectionUVGridBuilder.``PointSequenceDirection`

  Returns or sets the point sequence start direction

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

  Getter Method

  Signature `PointSequenceDirection`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `PointSequenceDirection`

  Parameters: | ptSeqDir (`NXOpen.CAM.InspectionMethodBuilderPointSequenceDirectionTypes`) –

  New in version NX7.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## PointSequenceMode

`InspectionUVGridBuilder.``PointSequenceMode`

  Returns or sets the point sequence mode

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

  Getter Method

  Signature `PointSequenceMode`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `PointSequenceMode`

  Parameters: | ptSeqMode (`NXOpen.CAM.InspectionMethodBuilderPointSequenceModeTypes`) –

  New in version NX7.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## PointSequenceStart

`InspectionUVGridBuilder.``PointSequenceStart`

  Returns or sets the point sequence start location

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

  Getter Method

  Signature `PointSequenceStart`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `PointSequenceStart`

  Parameters: | ptSeqStart (`NXOpen.CAM.InspectionMethodBuilderPointSequenceStartTypes`) –

  New in version NX7.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## RetractDist

`InspectionUVGridBuilder.``RetractDist`

  Returns the retract distance

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

  Getter Method

  Signature `RetractDist`

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

  New in version NX7.0.0.

  License requirements: None.

## SearchDist

`InspectionUVGridBuilder.``SearchDist`

  Returns the search distance

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

  Getter Method

  Signature `SearchDist`

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

  New in version NX7.0.0.

  License requirements: None.

## SequenceOptimization

`InspectionUVGridBuilder.``SequenceOptimization`

  Returns or sets the path point sequence optimization setting

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

  Getter Method

  Signature `SequenceOptimization`

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

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SequenceOptimization`

  Parameters: | sequenceOpt (`NXOpen.CAM.InspectionPathBuilderSequenceType`) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SphereAxisMethod

`InspectionUVGridBuilder.``SphereAxisMethod`

  Returns or sets the method for determining the axis for a sphere

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

  Getter Method

  Signature `SphereAxisMethod`

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

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SphereAxisMethod`

  Parameters: | method (`NXOpen.CAM.InspectionUVGridBuilderSphereAxisType`) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SphereAxisVector

`InspectionUVGridBuilder.``SphereAxisVector`

  Returns or sets the sphere axis vector

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

  Getter Method

  Signature `SphereAxisVector`

  Returns: |
  Return type: | `NXOpen.Direction`

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SphereAxisVector`

  Parameters: | vector (`NXOpen.Direction`) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## StartPointMode

`InspectionUVGridBuilder.``StartPointMode`

  Returns or sets the start point mode

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

  Getter Method

  Signature `StartPointMode`

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

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StartPointMode`

  Parameters: | startMode (`NXOpen.CAM.InspectionUVGridBuilderStartPointType`) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## StartU

`InspectionUVGridBuilder.``StartU`

  Returns the start value in U

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

  Getter Method

  Signature `StartU`

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

  New in version NX7.0.0.

  License requirements: None.

## StartUDeg

`InspectionUVGridBuilder.``StartUDeg`

  Returns the start degrees value in U

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

  Getter Method

  Signature `StartUDeg`

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

  New in version NX7.5.0.

  License requirements: None.

## StartUDist

`InspectionUVGridBuilder.``StartUDist`

  Returns the start distance value in U

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

  Getter Method

  Signature `StartUDist`

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

  New in version NX7.5.0.

  License requirements: None.

## StartUMode

`InspectionUVGridBuilder.``StartUMode`

  Returns or sets the start U mode

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

  Getter Method

  Signature `StartUMode`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `StartUMode`

  Parameters: | uvMode (`NXOpen.CAM.InspectionMethodBuilderUVModeTypes`) –

  New in version NX7.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## StartUSweep

`InspectionUVGridBuilder.``StartUSweep`

  Returns the start sweep value in U

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

  Getter Method

  Signature `StartUSweep`

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

  New in version NX7.5.0.

  License requirements: None.

## StartV

`InspectionUVGridBuilder.``StartV`

  Returns the start value in V

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

  Getter Method

  Signature `StartV`

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

  New in version NX7.0.0.

  License requirements: None.

## StartVDeg

`InspectionUVGridBuilder.``StartVDeg`

  Returns the start degrees value in V

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

  Getter Method

  Signature `StartVDeg`

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

  New in version NX7.5.0.

  License requirements: None.

## StartVDist

`InspectionUVGridBuilder.``StartVDist`

  Returns the start distance value in V

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

  Getter Method

  Signature `StartVDist`

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

  New in version NX7.5.0.

  License requirements: None.

## StartVMode

`InspectionUVGridBuilder.``StartVMode`

  Returns or sets the start V mode

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

  Getter Method

  Signature `StartVMode`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `StartVMode`

  Parameters: | uvMode (`NXOpen.CAM.InspectionMethodBuilderUVModeTypes`) –

  New in version NX7.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## StartVSweep

`InspectionUVGridBuilder.``StartVSweep`

  Returns the start sweep value in V

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

  Getter Method

  Signature `StartVSweep`

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

  New in version NX7.5.0.

  License requirements: None.

## UseFeatureCollisionAvoidance

`InspectionUVGridBuilder.``UseFeatureCollisionAvoidance`

  Returns or sets the flag to use feature collision avoidance

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

  Getter Method

  Signature `UseFeatureCollisionAvoidance`

  Returns: |
  Return type: | bool

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UseFeatureCollisionAvoidance`

  Parameters: | flag (bool) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## UsePartCollisionAvoidance

`InspectionUVGridBuilder.``UsePartCollisionAvoidance`

  Returns or sets the flag to use part collision avoidance

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

  Getter Method

  Signature `UsePartCollisionAvoidance`

  Returns: |
  Return type: | bool

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UsePartCollisionAvoidance`

  Parameters: | flag (bool) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

# Method Detail

## CopyAttributes

`InspectionUVGridBuilder.``CopyAttributes`

  Copy point grid parameters

  Signature `CopyAttributes(target)`

  Parameters: | target (`NXOpen.CAM.InspectionUVGridBuilder`) –

  New in version NX9.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SetAppDistChanged

`InspectionUVGridBuilder.``SetAppDistChanged`

  Flag indicating whether approach distance changed.

  Signature `SetAppDistChanged(flag)`

  Parameters: | flag (bool) –

  New in version NX9.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SetLayoutChanged

`InspectionUVGridBuilder.``SetLayoutChanged`

  Flag indicating whether layout changed.

  Signature `SetLayoutChanged(flag)`

  Parameters: | flag (bool) –

  New in version NX9.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SetPointCoverageChanged

`InspectionUVGridBuilder.``SetPointCoverageChanged`

  Flag indicating whether point coverage changed.

  Signature `SetPointCoverageChanged(flag)`

  Parameters: | flag (bool) –

  New in version NX9.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SetPointSequenceChanged

`InspectionUVGridBuilder.``SetPointSequenceChanged`

  Flag indicating whether point sequence changed.

  Signature `SetPointSequenceChanged(flag)`

  Parameters: | flag (bool) –

  New in version NX9.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SetRetDistChanged

`InspectionUVGridBuilder.``SetRetDistChanged`

  Flag indicating whether retract distance changed.

  Signature `SetRetDistChanged(flag)`

  Parameters: | flag (bool) –

  New in version NX9.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## Validate

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