InspectionMoveBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# InspectionMoveBuilder Class

class `NXOpen.CAM.``InspectionMoveBuilder`

  Bases: `NXOpen.Builder`

  Represents CMM Inspection Move Builder

  This cannot be instantiated

  New in version NX7.0.0.

# Properties

Property | Description
--- | ---
AngleA | Returns or sets the A angle for an indexable head
AngleB | Returns or sets the B angle for an indexable head
ApproachDistance | Returns or sets the approach distance
MotionType | Returns or sets the motion type
ProbeTipType | Returns or sets the preferred probe tip type
ProbeTipTypeBuilder | Returns the Probe Tip Type Builder
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
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

# 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.
LockMove | Set lock to prevent move parameters from being changed programmatically.
SetParent | Set parent
SetProbeAngles | Set default values for probe angles based on feature type.
SetProbeTip | Set default probe tip based on preferred tip type and probe angles.
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

InspectionMoveBuilderDepthMethodTypes Enumeration | the depth method
InspectionMoveBuilderProbeTipTypes Enumeration | the preferred probe tip type
InspectionMoveBuilderSensorStrategyTypes Enumeration | the sensor selection strategy
InspectionMoveBuilderTipAngleTypes Enumeration | the tip angle selection mode
InspectionMoveBuilderTipModeTypes Enumeration | the tip selection mode

# Property Detail

## AngleA

`InspectionMoveBuilder.``AngleA`

  Returns or sets the A angle for an indexable head

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

  Getter Method

  Signature `AngleA`

  Returns: |
  Return type: | float

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AngleA`

  Parameters: | angle (float) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## AngleB

`InspectionMoveBuilder.``AngleB`

  Returns or sets the B angle for an indexable head

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

  Getter Method

  Signature `AngleB`

  Returns: |
  Return type: | float

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AngleB`

  Parameters: | angle (float) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## ApproachDistance

`InspectionMoveBuilder.``ApproachDistance`

  Returns or sets the approach distance

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

  Getter Method

  Signature `ApproachDistance`

  Returns: |
  Return type: | float

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ApproachDistance`

  Parameters: | distance (float) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## MotionType

`InspectionMoveBuilder.``MotionType`

  Returns or sets the motion type

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

  Getter Method

  Signature `MotionType`

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

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MotionType`

  Parameters: | motionType (`NXOpen.CAM.MoveBuilderMotion`) –

  New in version NX7.0.0.

  License requirements: None.

## ProbeTipType

`InspectionMoveBuilder.``ProbeTipType`

  Returns or sets the preferred probe tip type

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

  Getter Method

  Signature `ProbeTipType`

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

  New in version NX9.0.1.

  License requirements: None.

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

  Setter Method

  Signature `ProbeTipType`

  Parameters: | tipType (`NXOpen.CAM.InspectionMoveBuilderProbeTipTypes`) –

  New in version NX9.0.1.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## ProbeTipTypeBuilder

`InspectionMoveBuilder.``ProbeTipTypeBuilder`

  Returns the Probe Tip Type Builder

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

  Getter Method

  Signature `ProbeTipTypeBuilder`

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

  New in version NX9.0.1.

  License requirements: None.

## RetractDistance

`InspectionMoveBuilder.``RetractDistance`

  Returns or sets the retract distance

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

  Getter Method

  Signature `RetractDistance`

  Returns: |
  Return type: | float

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RetractDistance`

  Parameters: | distance (float) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SensorOpName

`InspectionMoveBuilder.``SensorOpName`

  Returns or sets the inspection sensor operation name

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

  Getter Method

  Signature `SensorOpName`

  Returns: |
  Return type: | str

  New in version NX7.5.1.

  License requirements: None.

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

  Setter Method

  Signature `SensorOpName`

  Parameters: | sensorOpName (str) –

  New in version NX7.5.1.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SensorStrategy

`InspectionMoveBuilder.``SensorStrategy`

  Returns or sets the sensor selection strategy

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

  Getter Method

  Signature `SensorStrategy`

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

  New in version NX7.5.1.

  License requirements: None.

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

  Setter Method

  Signature `SensorStrategy`

  Parameters: | sensorStrategy (`NXOpen.CAM.InspectionMoveBuilderSensorStrategyTypes`) –

  New in version NX7.5.1.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SensorStrategyBuilder

`InspectionMoveBuilder.``SensorStrategyBuilder`

  Returns the Sensor Strategy Enum Builder

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

  Getter Method

  Signature `SensorStrategyBuilder`

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

  New in version NX9.0.0.

  License requirements: None.

## TipAngleMode

`InspectionMoveBuilder.``TipAngleMode`

  Returns or sets the tip angle selection mode

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

  Getter Method

  Signature `TipAngleMode`

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

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `TipAngleMode`

  Parameters: | tipAngleMode (`NXOpen.CAM.InspectionMoveBuilderTipAngleTypes`) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## TipMode

`InspectionMoveBuilder.``TipMode`

  Returns or sets the probe tip selection mode

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

  Getter Method

  Signature `TipMode`

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

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `TipMode`

  Parameters: | tipMode (`NXOpen.CAM.InspectionMoveBuilderTipModeTypes`) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## TipNumber

`InspectionMoveBuilder.``TipNumber`

  Returns or sets the probe tip number

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

  Getter Method

  Signature `TipNumber`

  Returns: |
  Return type: | int

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `TipNumber`

  Parameters: | tipNumber (int) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

# Method Detail

## LockMove

`InspectionMoveBuilder.``LockMove`

  Set lock to prevent move parameters from being changed programmatically.

  Signature `LockMove(lock)`

  Parameters: | lock (bool) –

  New in version NX11.0.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SetParent

`InspectionMoveBuilder.``SetParent`

  Set parent

  Signature `SetParent(parent)`

  Parameters: | parent (`NXOpen.CAM.CAMObject`) – the parent object

  New in version NX7.0.0.

  License requirements: None.

## SetProbeAngles

`InspectionMoveBuilder.``SetProbeAngles`

  Set default values for probe angles based on feature type.

  Signature `SetProbeAngles()`

  New in version NX7.5.1.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SetProbeTip

`InspectionMoveBuilder.``SetProbeTip`

  Set default probe tip based on preferred tip type and probe angles.

  Signature `SetProbeTip()`

  New in version NX9.0.1.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SetSibling

`InspectionMoveBuilder.``SetSibling`

  Set sibling

  Signature `SetSibling(sibling)`

  Parameters: | sibling (`NXOpen.CAM.CAMObject`) – the sibling object

  New in version NX7.0.0.

  License requirements: None.

## Validate

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