InspectionScanLineBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# InspectionScanLineBuilder Class

class `NXOpen.CAM.``InspectionScanLineBuilder`

  Bases: `NXOpen.CAM.InspectionMoveBuilder`

  Represents the builder for the CMM Inspection sub-operation Scan Line.

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

  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
ApproachDist | Returns the builder for approach distance
ApproachDistance | Returns or sets the approach distance
DepthDistance | Returns or sets the depth distance
DepthMethod | Returns or sets the depth method
EndDistance | Returns or sets the End Distance of the Scan Line
EndDistanceBuilder | Returns the End Distance of the Scan Line
EndPercentage | Returns the End Percentage of the Scan Line
Line | Returns or sets the line
MotionType | Returns or sets the motion type
ProbeTipType | Returns or sets the preferred probe tip type
ProbeTipTypeBuilder | Returns the Probe Tip Type Builder
RetractDist | Returns the builder for retract distance
RetractDistance | Returns or sets the retract distance
Reversedirection | Returns or sets the Reverse Direction flag on the line
ScanModeType | Returns or sets the 3,5 axis mode type
ScanSpeed | Returns the builder for scan speed
SensorOpName | Returns or sets the inspection sensor operation name
SensorStrategy | Returns or sets the sensor selection strategy
SensorStrategyBuilder | Returns the Sensor Strategy Enum Builder
StartDistance | Returns or sets the Start Distance of the Scan Line
StartDistanceBuilder | Returns the Start Distance of the Scan Line
StartEndMode | Returns or sets the start/end mode
StartPercentage | Returns the Start Percentage of the Scan Line
StepSize | Returns the builder for step sizee
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.

# Property Detail

## ApproachDist

`InspectionScanLineBuilder.``ApproachDist`

  Returns the builder for approach distance

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

  Getter Method

  Signature `ApproachDist`

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

  New in version NX9.0.2.

  License requirements: None.

## DepthDistance

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

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

## EndDistance

`InspectionScanLineBuilder.``EndDistance`

  Returns or sets the End Distance of the Scan Line

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

  Getter Method

  Signature `EndDistance`

  Returns: |
  Return type: | float

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `EndDistance`

  Parameters: | distance (float) –

  New in version NX7.0.0.

  License requirements: None.

## EndDistanceBuilder

`InspectionScanLineBuilder.``EndDistanceBuilder`

  Returns the End Distance of the Scan Line

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

  Getter Method

  Signature `EndDistanceBuilder`

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

  New in version NX8.5.0.

  License requirements: None.

## EndPercentage

`InspectionScanLineBuilder.``EndPercentage`

  Returns the End Percentage of the Scan Line

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

  Getter Method

  Signature `EndPercentage`

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

  New in version NX8.5.0.

  License requirements: None.

## Line

`InspectionScanLineBuilder.``Line`

  Returns or sets the line

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

  Getter Method

  Signature `Line`

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

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Line`

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

  New in version NX7.0.0.

  License requirements: None.

## RetractDist

`InspectionScanLineBuilder.``RetractDist`

  Returns the builder for retract distance

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

  Getter Method

  Signature `RetractDist`

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

  New in version NX9.0.2.

  License requirements: None.

## Reversedirection

`InspectionScanLineBuilder.``Reversedirection`

  Returns or sets the Reverse Direction flag on the line

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

  Getter Method

  Signature `Reversedirection`

  Returns: |
  Return type: | bool

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Reversedirection`

  Parameters: | reversedir (bool) –

  New in version NX7.0.0.

  License requirements: None.

## ScanModeType

`InspectionScanLineBuilder.``ScanModeType`

  Returns or sets the 3,5 axis mode type

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

  Getter Method

  Signature `ScanModeType`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ScanModeType`

  Parameters: | modeType (`NXOpen.CAM.InspectionMethodBuilderScanModeTypes`) –

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## ScanSpeed

`InspectionScanLineBuilder.``ScanSpeed`

  Returns the builder for scan speed

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

  Getter Method

  Signature `ScanSpeed`

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

  New in version NX11.0.0.

  License requirements: None.

## StartDistance

`InspectionScanLineBuilder.``StartDistance`

  Returns or sets the Start Distance of the Scan Line

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

  Getter Method

  Signature `StartDistance`

  Returns: |
  Return type: | float

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StartDistance`

  Parameters: | distance (float) –

  New in version NX7.0.0.

  License requirements: None.

## StartDistanceBuilder

`InspectionScanLineBuilder.``StartDistanceBuilder`

  Returns the Start Distance of the Scan Line

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

  Getter Method

  Signature `StartDistanceBuilder`

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

  New in version NX8.5.0.

  License requirements: None.

## StartEndMode

`InspectionScanLineBuilder.``StartEndMode`

  Returns or sets the start/end mode

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

  Getter Method

  Signature `StartEndMode`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `StartEndMode`

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

  New in version NX8.5.0.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## StartPercentage

`InspectionScanLineBuilder.``StartPercentage`

  Returns the Start Percentage of the Scan Line

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

  Getter Method

  Signature `StartPercentage`

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

  New in version NX8.5.0.

  License requirements: None.

## StepSize

`InspectionScanLineBuilder.``StepSize`

  Returns the builder for step sizee

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

  Getter Method

  Signature `StepSize`

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

  New in version NX11.0.0.

  License requirements: None.

# Method Detail

## Validate

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