InspectionCreatePathsBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# InspectionCreatePathsBuilder Class

class `NXOpen.CAM.``InspectionCreatePathsBuilder`

  Bases: `NXOpen.Builder`

  Create Paths Dialog builder

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

  New in version NX7.0.0.

# Properties

Property | Description
--- | ---
AngleA | Returns or sets the A angle
AngleB | Returns or sets the B angle
AngleString | Returns or sets the angle specification
GeometryGroup | Returns or sets the geometry group
ProbeTipType | Returns or sets the preferred probe tip type
ProgramGroup | Returns or sets the program group
ProgramLocationString | Returns or sets the program location
SelectFeatures | Returns the select features button
SensorGroup | Returns or sets the sensor group
SensorOpName | Returns or sets the inspection sensor operation name
SensorStrategy | Returns or sets the sensor selection strategy
Setup | Returns or sets the setup
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
TipString | Returns or sets the tip to use for inspection
ToolGroup | Returns or sets the tool group
ToolString | Returns or sets the tool to use for inspection
TypeName | Returns or sets the method type name

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CreatePaths | Creates paths for the selected features.
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.
GetFeatureMethods | Returns the selected features method
GetObject | Returns the object currently being edited by this builder.
GetSelectedFeatures | Returns the selected features.
SetFeatureMethods | Sets the selected features method
SetSelectedFeatures | Sets the selected features.
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.

# Property Detail

## AngleA

`InspectionCreatePathsBuilder.``AngleA`

  Returns or sets the A angle

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

  Getter Method

  Signature `AngleA`

  Returns: |
  Return type: | float

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AngleA`

  Parameters: | angleA (float) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## AngleB

`InspectionCreatePathsBuilder.``AngleB`

  Returns or sets the B angle

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

  Getter Method

  Signature `AngleB`

  Returns: |
  Return type: | float

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AngleB`

  Parameters: | angleB (float) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## AngleString

`InspectionCreatePathsBuilder.``AngleString`

  Returns or sets the angle specification

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

  Getter Method

  Signature `AngleString`

  Returns: |
  Return type: | str

  New in version NX7.0.0.

  Deprecated since version NX9.0.0: Use AngleA and AngleB instead.

  License requirements: None.

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

  Setter Method

  Signature `AngleString`

  Parameters: | angleString (str) –

  New in version NX7.0.0.

  Deprecated since version NX9.0.0: Use AngleA and AngleB instead.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## GeometryGroup

`InspectionCreatePathsBuilder.``GeometryGroup`

  Returns or sets the geometry group

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

  Getter Method

  Signature `GeometryGroup`

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

  New in version NX7.5.3.

  License requirements: None.

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

  Setter Method

  Signature `GeometryGroup`

  Parameters: | geomGroup (`NXOpen.CAM.InspectionGroup`) –

  New in version NX7.5.3.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## ProbeTipType

`InspectionCreatePathsBuilder.``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”)

## ProgramGroup

`InspectionCreatePathsBuilder.``ProgramGroup`

  Returns or sets the program group

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

  Getter Method

  Signature `ProgramGroup`

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

  New in version NX7.5.3.

  License requirements: None.

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

  Setter Method

  Signature `ProgramGroup`

  Parameters: | progGroup (`NXOpen.CAM.InspectionGroup`) –

  New in version NX7.5.3.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## ProgramLocationString

`InspectionCreatePathsBuilder.``ProgramLocationString`

  Returns or sets the program location

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

  Getter Method

  Signature `ProgramLocationString`

  Returns: |
  Return type: | str

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ProgramLocationString`

  Parameters: | programLocationString (str) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SelectFeatures

`InspectionCreatePathsBuilder.``SelectFeatures`

  Returns the select features button

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

  Getter Method

  Signature `SelectFeatures`

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

  New in version NX7.0.0.

  License requirements: None.

## SensorGroup

`InspectionCreatePathsBuilder.``SensorGroup`

  Returns or sets the sensor group

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

  Getter Method

  Signature `SensorGroup`

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

  New in version NX7.5.3.

  License requirements: None.

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

  Setter Method

  Signature `SensorGroup`

  Parameters: | sensorGroup (`NXOpen.CAM.InspectionGroup`) –

  New in version NX7.5.3.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SensorOpName

`InspectionCreatePathsBuilder.``SensorOpName`

  Returns or sets the inspection sensor operation name

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

  Getter Method

  Signature `SensorOpName`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SensorOpName`

  Parameters: | sensorOpName (str) –

  New in version NX9.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SensorStrategy

`InspectionCreatePathsBuilder.``SensorStrategy`

  Returns or sets the sensor selection strategy

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

  Getter Method

  Signature `SensorStrategy`

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

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SensorStrategy`

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

  New in version NX9.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## Setup

`InspectionCreatePathsBuilder.``Setup`

  Returns or sets the setup

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

  Getter Method

  Signature `Setup`

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

  New in version NX7.5.3.

  License requirements: None.

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

  Setter Method

  Signature `Setup`

  Parameters: | setup (`NXOpen.CAM.InspectionSetup`) –

  New in version NX7.5.3.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## TipAngleMode

`InspectionCreatePathsBuilder.``TipAngleMode`

  Returns or sets the tip angle selection mode

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

  Getter Method

  Signature `TipAngleMode`

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

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `TipAngleMode`

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

  New in version NX9.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## TipMode

`InspectionCreatePathsBuilder.``TipMode`

  Returns or sets the probe tip selection mode

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

  Getter Method

  Signature `TipMode`

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

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `TipMode`

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

  New in version NX9.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## TipNumber

`InspectionCreatePathsBuilder.``TipNumber`

  Returns or sets the probe tip number

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

  Getter Method

  Signature `TipNumber`

  Returns: |
  Return type: | int

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `TipNumber`

  Parameters: | tipNumber (int) –

  New in version NX9.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## TipString

`InspectionCreatePathsBuilder.``TipString`

  Returns or sets the tip to use for inspection

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

  Getter Method

  Signature `TipString`

  Returns: |
  Return type: | str

  New in version NX7.0.0.

  Deprecated since version NX9.0.0: Use TipNumber instead.

  License requirements: None.

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

  Setter Method

  Signature `TipString`

  Parameters: | tipString (str) –

  New in version NX7.0.0.

  Deprecated since version NX9.0.0: Use TipNumber instead.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## ToolGroup

`InspectionCreatePathsBuilder.``ToolGroup`

  Returns or sets the tool group

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

  Getter Method

  Signature `ToolGroup`

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

  New in version NX7.5.3.

  License requirements: None.

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

  Setter Method

  Signature `ToolGroup`

  Parameters: | toolGroup (`NXOpen.CAM.InspectionGroup`) –

  New in version NX7.5.3.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## ToolString

`InspectionCreatePathsBuilder.``ToolString`

  Returns or sets the tool to use for inspection

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

  Getter Method

  Signature `ToolString`

  Returns: |
  Return type: | str

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ToolString`

  Parameters: | toolString (str) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## TypeName

`InspectionCreatePathsBuilder.``TypeName`

  Returns or sets the method type name

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

  Getter Method

  Signature `TypeName`

  Returns: |
  Return type: | str

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `TypeName`

  Parameters: | typeName (str) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

# Method Detail

## CreatePaths

`InspectionCreatePathsBuilder.``CreatePaths`

  Creates paths for the selected features.

  Signature `CreatePaths()`

  New in version NX7.5.3.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## GetFeatureMethods

`InspectionCreatePathsBuilder.``GetFeatureMethods`

  Returns the selected features method

  Signature `GetFeatureMethods()`

  Returns: | Selected feature method tags
  Return type: | list of `NXOpen.CAM.InspectionGroup`

  New in version NX7.5.3.

  License requirements: None.

## GetSelectedFeatures

`InspectionCreatePathsBuilder.``GetSelectedFeatures`

  Returns the selected features.

  Signature `GetSelectedFeatures()`

  Returns: | Selected features
  Return type: | list of str

  New in version NX7.5.2.

  License requirements: None.

## SetFeatureMethods

`InspectionCreatePathsBuilder.``SetFeatureMethods`

  Sets the selected features method

  Signature `SetFeatureMethods(featureMethods)`

  Parameters: | featureMethods (list of `NXOpen.CAM.InspectionGroup`) – Selected feature method tags

  New in version NX7.5.3.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SetSelectedFeatures

`InspectionCreatePathsBuilder.``SetSelectedFeatures`

  Sets the selected features.

  Signature `SetSelectedFeatures(selectedFeatures)`

  Parameters: | selectedFeatures (list of str) – Selected features

  New in version NX7.5.2.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## Validate

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