InspectionPolarGridBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# InspectionPolarGridBuilder Class

class `NXOpen.CAM.``InspectionPolarGridBuilder`

  Bases: `NXOpen.CAM.InspectionMoveBuilder`

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

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

  New in version NX11.0.2.

# 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
AngleEndPoint | Returns or sets the angle end point
AngleMode | Returns or sets the angle mode
AngleStartPoint | Returns or sets the angle start point
ApproachDist | Returns the approach distance
ApproachDistance | Returns or sets the approach distance
CenterPoint | Returns or sets the center point
MaximumRadius | Returns the maximum radius
MaximumRadiusMode | Returns or sets the maximum radius mode
MaximumRadiusPoint | Returns or sets the maximum radius point
MeasuredGeometry | Returns or sets the measured geometry
MinimumRadius | Returns the minimum radius
MinimumRadiusMode | Returns or sets the minimum radius mode
MinimumRadiusPoint | Returns or sets the minimum radius point
MotionType | Returns or sets the motion type
NumberOfAngularPoints | Returns the number of angular points
NumberOfRadialPoints | Returns the number of radial points
OffsetEndAngle | Returns the offset in degrees from end vector
OffsetMaximumRadius | Returns the offset from maximum radius
OffsetMinimumRadius | Returns the offset from minimum radius
OffsetStartAngle | Returns the offset in degrees from start vector
PointSequence | Returns or sets the point sequence mode
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
SensorOpName | Returns or sets the inspection sensor operation name
SensorStrategy | Returns or sets the sensor selection strategy
SensorStrategyBuilder | Returns the Sensor Strategy Enum Builder
SequenceDirection | Returns or sets the point sequence start direction
SequenceStart | Returns or sets the point sequence start location
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.
UpdateFromSubOperation | Update point grid parameters based on another sub-operation
UpdateParamsFromGeometry | Update point grid parameters based on geometry
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## AlignMachineAxes

`InspectionPolarGridBuilder.``AlignMachineAxes`

  Returns or sets the flag to align with machine axes

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

  Getter Method

  Signature `AlignMachineAxes`

  Returns: |
  Return type: | bool

  New in version NX11.0.2.

  License requirements: None.

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

  Setter Method

  Signature `AlignMachineAxes`

  Parameters: | flag (bool) –

  New in version NX11.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## AngleEndPoint

`InspectionPolarGridBuilder.``AngleEndPoint`

  Returns or sets the angle end point

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

  Getter Method

  Signature `AngleEndPoint`

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

  New in version NX11.0.2.

  License requirements: None.

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

  Setter Method

  Signature `AngleEndPoint`

  Parameters: | point (`NXOpen.Point`) –

  New in version NX11.0.2.

  License requirements: None.

## AngleMode

`InspectionPolarGridBuilder.``AngleMode`

  Returns or sets the angle mode

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

  Getter Method

  Signature `AngleMode`

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

  New in version NX11.0.2.

  License requirements: None.

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

  Setter Method

  Signature `AngleMode`

  Parameters: | angleMode (`NXOpen.CAM.InspectionMethodBuilderPolarAngleModeTypes`) –

  New in version NX11.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## AngleStartPoint

`InspectionPolarGridBuilder.``AngleStartPoint`

  Returns or sets the angle start point

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

  Getter Method

  Signature `AngleStartPoint`

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

  New in version NX11.0.2.

  License requirements: None.

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

  Setter Method

  Signature `AngleStartPoint`

  Parameters: | point (`NXOpen.Point`) –

  New in version NX11.0.2.

  License requirements: None.

## ApproachDist

`InspectionPolarGridBuilder.``ApproachDist`

  Returns the approach distance

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

  Getter Method

  Signature `ApproachDist`

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

  New in version NX11.0.2.

  License requirements: None.

## CenterPoint

`InspectionPolarGridBuilder.``CenterPoint`

  Returns or sets the center point

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

  Getter Method

  Signature `CenterPoint`

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

  New in version NX11.0.2.

  License requirements: None.

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

  Setter Method

  Signature `CenterPoint`

  Parameters: | point (`NXOpen.Point`) –

  New in version NX11.0.2.

  License requirements: None.

## MaximumRadius

`InspectionPolarGridBuilder.``MaximumRadius`

  Returns the maximum radius

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

  Getter Method

  Signature `MaximumRadius`

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

  New in version NX11.0.2.

  License requirements: None.

## MaximumRadiusMode

`InspectionPolarGridBuilder.``MaximumRadiusMode`

  Returns or sets the maximum radius mode

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

  Getter Method

  Signature `MaximumRadiusMode`

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

  New in version NX11.0.2.

  License requirements: None.

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

  Setter Method

  Signature `MaximumRadiusMode`

  Parameters: | radiusMode (`NXOpen.CAM.InspectionMethodBuilderPolarRadiusModeTypes`) –

  New in version NX11.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## MaximumRadiusPoint

`InspectionPolarGridBuilder.``MaximumRadiusPoint`

  Returns or sets the maximum radius point

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

  Getter Method

  Signature `MaximumRadiusPoint`

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

  New in version NX11.0.2.

  License requirements: None.

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

  Setter Method

  Signature `MaximumRadiusPoint`

  Parameters: | point (`NXOpen.Point`) –

  New in version NX11.0.2.

  License requirements: None.

## MeasuredGeometry

`InspectionPolarGridBuilder.``MeasuredGeometry`

  Returns or sets the measured geometry

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

  Getter Method

  Signature `MeasuredGeometry`

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

  New in version NX11.0.2.

  License requirements: None.

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

  Setter Method

  Signature `MeasuredGeometry`

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

  New in version NX11.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## MinimumRadius

`InspectionPolarGridBuilder.``MinimumRadius`

  Returns the minimum radius

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

  Getter Method

  Signature `MinimumRadius`

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

  New in version NX11.0.2.

  License requirements: None.

## MinimumRadiusMode

`InspectionPolarGridBuilder.``MinimumRadiusMode`

  Returns or sets the minimum radius mode

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

  Getter Method

  Signature `MinimumRadiusMode`

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

  New in version NX11.0.2.

  License requirements: None.

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

  Setter Method

  Signature `MinimumRadiusMode`

  Parameters: | radiusMode (`NXOpen.CAM.InspectionMethodBuilderPolarRadiusModeTypes`) –

  New in version NX11.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## MinimumRadiusPoint

`InspectionPolarGridBuilder.``MinimumRadiusPoint`

  Returns or sets the minimum radius point

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

  Getter Method

  Signature `MinimumRadiusPoint`

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

  New in version NX11.0.2.

  License requirements: None.

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

  Setter Method

  Signature `MinimumRadiusPoint`

  Parameters: | point (`NXOpen.Point`) –

  New in version NX11.0.2.

  License requirements: None.

## NumberOfAngularPoints

`InspectionPolarGridBuilder.``NumberOfAngularPoints`

  Returns the number of angular points

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

  Getter Method

  Signature `NumberOfAngularPoints`

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

  New in version NX11.0.2.

  License requirements: None.

## NumberOfRadialPoints

`InspectionPolarGridBuilder.``NumberOfRadialPoints`

  Returns the number of radial points

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

  Getter Method

  Signature `NumberOfRadialPoints`

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

  New in version NX11.0.2.

  License requirements: None.

## OffsetEndAngle

`InspectionPolarGridBuilder.``OffsetEndAngle`

  Returns the offset in degrees from end vector

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

  Getter Method

  Signature `OffsetEndAngle`

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

  New in version NX11.0.2.

  License requirements: None.

## OffsetMaximumRadius

`InspectionPolarGridBuilder.``OffsetMaximumRadius`

  Returns the offset from maximum radius

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

  Getter Method

  Signature `OffsetMaximumRadius`

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

  New in version NX11.0.2.

  License requirements: None.

## OffsetMinimumRadius

`InspectionPolarGridBuilder.``OffsetMinimumRadius`

  Returns the offset from minimum radius

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

  Getter Method

  Signature `OffsetMinimumRadius`

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

  New in version NX11.0.2.

  License requirements: None.

## OffsetStartAngle

`InspectionPolarGridBuilder.``OffsetStartAngle`

  Returns the offset in degrees from start vector

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

  Getter Method

  Signature `OffsetStartAngle`

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

  New in version NX11.0.2.

  License requirements: None.

## PointSequence

`InspectionPolarGridBuilder.``PointSequence`

  Returns or sets the point sequence mode

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

  Getter Method

  Signature `PointSequence`

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

  New in version NX11.0.2.

  License requirements: None.

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

  Setter Method

  Signature `PointSequence`

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

  New in version NX11.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## RetractDist

`InspectionPolarGridBuilder.``RetractDist`

  Returns the retract distance

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

  Getter Method

  Signature `RetractDist`

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

  New in version NX11.0.2.

  License requirements: None.

## SequenceDirection

`InspectionPolarGridBuilder.``SequenceDirection`

  Returns or sets the point sequence start direction

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

  Getter Method

  Signature `SequenceDirection`

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

  New in version NX11.0.2.

  License requirements: None.

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

  Setter Method

  Signature `SequenceDirection`

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

  New in version NX11.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SequenceStart

`InspectionPolarGridBuilder.``SequenceStart`

  Returns or sets the point sequence start location

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

  Getter Method

  Signature `SequenceStart`

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

  New in version NX11.0.2.

  License requirements: None.

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

  Setter Method

  Signature `SequenceStart`

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

  New in version NX11.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## UseFeatureCollisionAvoidance

`InspectionPolarGridBuilder.``UseFeatureCollisionAvoidance`

  Returns or sets the flag to use feature collision avoidance

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

  Getter Method

  Signature `UseFeatureCollisionAvoidance`

  Returns: |
  Return type: | bool

  New in version NX11.0.2.

  License requirements: None.

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

  Setter Method

  Signature `UseFeatureCollisionAvoidance`

  Parameters: | flag (bool) –

  New in version NX11.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## UsePartCollisionAvoidance

`InspectionPolarGridBuilder.``UsePartCollisionAvoidance`

  Returns or sets the flag to use part collision avoidance

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

  Getter Method

  Signature `UsePartCollisionAvoidance`

  Returns: |
  Return type: | bool

  New in version NX11.0.2.

  License requirements: None.

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

  Setter Method

  Signature `UsePartCollisionAvoidance`

  Parameters: | flag (bool) –

  New in version NX11.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

# Method Detail

## CopyAttributes

`InspectionPolarGridBuilder.``CopyAttributes`

  Copy point grid parameters

  Signature `CopyAttributes(target)`

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

  New in version NX11.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SetAppDistChanged

`InspectionPolarGridBuilder.``SetAppDistChanged`

  Flag indicating whether approach distance changed.

  Signature `SetAppDistChanged(flag)`

  Parameters: | flag (bool) –

  New in version NX11.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SetLayoutChanged

`InspectionPolarGridBuilder.``SetLayoutChanged`

  Flag indicating whether layout changed.

  Signature `SetLayoutChanged(flag)`

  Parameters: | flag (bool) –

  New in version NX11.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SetPointCoverageChanged

`InspectionPolarGridBuilder.``SetPointCoverageChanged`

  Flag indicating whether point coverage changed.

  Signature `SetPointCoverageChanged(flag)`

  Parameters: | flag (bool) –

  New in version NX11.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SetPointSequenceChanged

`InspectionPolarGridBuilder.``SetPointSequenceChanged`

  Flag indicating whether point sequence changed.

  Signature `SetPointSequenceChanged(flag)`

  Parameters: | flag (bool) –

  New in version NX11.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SetRetDistChanged

`InspectionPolarGridBuilder.``SetRetDistChanged`

  Flag indicating whether retract distance changed.

  Signature `SetRetDistChanged(flag)`

  Parameters: | flag (bool) –

  New in version NX11.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## UpdateFromSubOperation

`InspectionPolarGridBuilder.``UpdateFromSubOperation`

  Update point grid parameters based on another sub-operation

  Signature `UpdateFromSubOperation(source)`

  Parameters: | source (`NXOpen.CAM.InspectionMoveSubop`) –

  New in version NX11.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## UpdateParamsFromGeometry

`InspectionPolarGridBuilder.``UpdateParamsFromGeometry`

  Update point grid parameters based on geometry

  Signature `UpdateParamsFromGeometry()`

  New in version NX11.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## Validate

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