InspectionSensorBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# InspectionSensorBuilder Class

class `NXOpen.CAM.``InspectionSensorBuilder`

  Bases: `NXOpen.CAM.OperationBuilder`

  Represents the builder for a CMM Inspection Sensor.

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

  New in version NX7.0.0.

# Properties

Property | Description
--- | ---
AngleA | Returns or sets the sensor tip location tilt angle component
AngleB | Returns or sets the sensor tip location rotation angle component
ChannelName | Returns or sets the channel’s name
CycleEvent | Returns the cycle event
CycleTable | Returns the cycle
Description | Returns or sets the description
EndOfPath | Returns the end event builder
EndUdeSet | Returns the end ude set
Geometry | Returns the geometry builder
GougeChecking | Returns or sets the gouge checking flag
HoleAxisType | Returns or sets the Hole Axis Type
HoleDepth | Returns the max depth distance builder
HoleDepthType | Returns or sets the Hole Depth Type
LayoutAndLayer | Returns the Layer and Layout
MasterOpLabel | Returns or sets the master sensor label
MotionOutputBuilder | Returns the motion output builder
Notes | Returns the notes builder
OptimizationBasedOn | Returns or sets the optimization based on in operation
OptimizationDistanceMethod | Returns or sets the optimization distance method in operation
OptimizationLevel | Returns or sets the optimization level in operation
OptimizationMethod | Returns or sets the optim method
PathDisplayOptions | Returns the path display options builder
PostToolPathExit | Returns or sets the environment variable that points to the post tool path generation library which has the exit
RetractDistance | Returns the Retract Distance builder (inheritable double)
RetractDistanceOnToolAxisChange | Returns the Retract Distance on Tool Axis Change builder (inheritable double)
SafeClearance | Returns the safe clearance builder
SelectToolFlag | Returns or sets the user selected tool
SensorOpLabel | Returns or sets the sensor label
SensorOpName | Returns or sets the inspection sensor operation name
SensorTipDiameter | Returns or sets the sensor tip diameter
SensorTipLength | Returns or sets the sensor tip length
SensorTipLocation | Returns or sets the sensor tip location method
SensorTipSize | Returns or sets the sensor tip size
SensorTipType | Returns or sets the sensor tip type
SensorType | Returns or sets the sensor type
StartOfPath | Returns the start event builder
StartUdeSet | Returns the start ude set
Tag | Returns the Tag for this object.
TipNumber | Returns or sets the probe tip number
ToolChangeSetting | Returns the tool change builder
ToolName | Returns or sets the inspection probe tool name
ToolPathEditor | Returns the Tool Path Editor Builder
ToolPathSplitParametersBuilder | Returns the tool path split Parameters

# 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.
GetCustomizableItemBuilder | Returns the customizable item builder for the given customizable item name
GetCustomizableItemNames | Returns the names for all customizable item ids
GetHoleAxisValues | Get the Hole Axis values
GetObject | Returns the object currently being edited by this builder.
GetSensorTipIjk | Get the sensor tip location vector coordinates
GetSensorTipXyz | Get the sensor tip location cartesian coordinates
SetHoleAxisValues | Set the Hole Axis values
SetSensorTipIjk | Set the sensor tip location vector coordinates
SetSensorTipXyz | Set the sensor tip location cartesian coordinates
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

InspectionSensorBuilderSensorTipLocationTypes Enumeration | the sensor tip location method
InspectionSensorBuilderSensorTipTypes Enumeration | the sensor tip type
InspectionSensorBuilderSensorTypes Enumeration | the sensor type

# Property Detail

## AngleA

`InspectionSensorBuilder.``AngleA`

  Returns or sets the sensor tip location tilt angle component

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

  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

`InspectionSensorBuilder.``AngleB`

  Returns or sets the sensor tip location rotation angle component

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

  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”)

## MasterOpLabel

`InspectionSensorBuilder.``MasterOpLabel`

  Returns or sets the master sensor label

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

  Getter Method

  Signature `MasterOpLabel`

  Returns: |
  Return type: | str

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MasterOpLabel`

  Parameters: | label (str) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SensorOpLabel

`InspectionSensorBuilder.``SensorOpLabel`

  Returns or sets the sensor label

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

  Getter Method

  Signature `SensorOpLabel`

  Returns: |
  Return type: | str

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SensorOpLabel`

  Parameters: | label (str) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SensorOpName

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

## SensorTipDiameter

`InspectionSensorBuilder.``SensorTipDiameter`

  Returns or sets the sensor tip diameter

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

  Getter Method

  Signature `SensorTipDiameter`

  Returns: |
  Return type: | float

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SensorTipDiameter`

  Parameters: | diameter (float) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SensorTipLength

`InspectionSensorBuilder.``SensorTipLength`

  Returns or sets the sensor tip length

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

  Getter Method

  Signature `SensorTipLength`

  Returns: |
  Return type: | float

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SensorTipLength`

  Parameters: | length (float) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SensorTipLocation

`InspectionSensorBuilder.``SensorTipLocation`

  Returns or sets the sensor tip location method

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

  Getter Method

  Signature `SensorTipLocation`

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

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SensorTipLocation`

  Parameters: | type (`NXOpen.CAM.InspectionSensorBuilderSensorTipLocationTypes`) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SensorTipSize

`InspectionSensorBuilder.``SensorTipSize`

  Returns or sets the sensor tip size

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

  Getter Method

  Signature `SensorTipSize`

  Returns: |
  Return type: | float

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SensorTipSize`

  Parameters: | size (float) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SensorTipType

`InspectionSensorBuilder.``SensorTipType`

  Returns or sets the sensor tip type

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

  Getter Method

  Signature `SensorTipType`

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

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SensorTipType`

  Parameters: | type (`NXOpen.CAM.InspectionSensorBuilderSensorTipTypes`) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SensorType

`InspectionSensorBuilder.``SensorType`

  Returns or sets the sensor type

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

  Getter Method

  Signature `SensorType`

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

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SensorType`

  Parameters: | type (`NXOpen.CAM.InspectionSensorBuilderSensorTypes`) –

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## TipNumber

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

## ToolName

`InspectionSensorBuilder.``ToolName`

  Returns or sets the inspection probe tool name

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

  Getter Method

  Signature `ToolName`

  Returns: |
  Return type: | str

  New in version NX7.5.1.

  License requirements: None.

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

  Setter Method

  Signature `ToolName`

  Parameters: | toolName (str) –

  New in version NX7.5.1.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

# Method Detail

## GetSensorTipIjk

`InspectionSensorBuilder.``GetSensorTipIjk`

  Get the sensor tip location vector coordinates

  Signature `GetSensorTipIjk()`

  Returns: | the ijk values
  Return type: | list of float

  New in version NX7.0.0.

  License requirements: None.

## GetSensorTipXyz

`InspectionSensorBuilder.``GetSensorTipXyz`

  Get the sensor tip location cartesian coordinates

  Signature `GetSensorTipXyz()`

  Returns: | the xyz values
  Return type: | list of float

  New in version NX7.0.0.

  License requirements: None.

## SetSensorTipIjk

`InspectionSensorBuilder.``SetSensorTipIjk`

  Set the sensor tip location vector coordinates

  Signature `SetSensorTipIjk(ijk)`

  Parameters: | ijk (list of float) – the ijk values

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## SetSensorTipXyz

`InspectionSensorBuilder.``SetSensorTipXyz`

  Set the sensor tip location cartesian coordinates

  Signature `SetSensorTipXyz(xyz)`

  Parameters: | xyz (list of float) – the xyz values

  New in version NX7.0.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## Validate

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