ProbeControlParametersBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ProbeControlParametersBuilder Class

class `NXOpen.CAM.``ProbeControlParametersBuilder`

  Bases: `NXOpen.TaggedObject`

  Represents a `NXOpen.CAM.ProbeControlParametersBuilder`

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
Adjustment | Returns or sets the output adjustment option
Experience | Returns or sets the experience value location
OutputExperience | Returns or sets the option to output the experience value location
OutputOvertravel | Returns or sets the option to output the probe overtravel distance
OutputPercentFeedback | Returns or sets the option to output the percent feedback
OutputToolOffset | Returns or sets the option to output the tool offset to update
OutputWorkOffset | Returns or sets the option to output the work offset to update
Overtravel | Returns or sets the probe overtravel distance
PercentFeedback | Returns or sets the percent feedback
Print | Returns or sets the print option
Tag | Returns the Tag for this object.
ToolOffset | Returns or sets the tool offset to update
WorkOffset | Returns or sets the work offset to update

# Methods

# Enumerations

ProbeControlParametersBuilderAdjustmentTypes Enumeration | the output adjustment method types
ProbeControlParametersBuilderPrintType Enumeration | the print type flag

# Property Detail

## Adjustment

`ProbeControlParametersBuilder.``Adjustment`

  Returns or sets the output adjustment option

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

  Getter Method

  Signature `Adjustment`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Adjustment`

  Parameters: | newValue (`NXOpen.CAM.ProbeControlParametersBuilderAdjustmentTypes`) –

  New in version NX5.0.0.

  License requirements: None.

## Experience

`ProbeControlParametersBuilder.``Experience`

  Returns or sets the experience value location

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

  Getter Method

  Signature `Experience`

  Returns: |
  Return type: | int

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Experience`

  Parameters: | experience (int) –

  New in version NX5.0.0.

  License requirements: None.

## OutputExperience

`ProbeControlParametersBuilder.``OutputExperience`

  Returns or sets the option to output the experience value location

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

  Getter Method

  Signature `OutputExperience`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OutputExperience`

  Parameters: | newValue (bool) –

  New in version NX5.0.0.

  License requirements: None.

## OutputOvertravel

`ProbeControlParametersBuilder.``OutputOvertravel`

  Returns or sets the option to output the probe overtravel distance

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

  Getter Method

  Signature `OutputOvertravel`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OutputOvertravel`

  Parameters: | newValue (bool) –

  New in version NX5.0.0.

  License requirements: None.

## OutputPercentFeedback

`ProbeControlParametersBuilder.``OutputPercentFeedback`

  Returns or sets the option to output the percent feedback

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

  Getter Method

  Signature `OutputPercentFeedback`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OutputPercentFeedback`

  Parameters: | newValue (bool) –

  New in version NX5.0.0.

  License requirements: None.

## OutputToolOffset

`ProbeControlParametersBuilder.``OutputToolOffset`

  Returns or sets the option to output the tool offset to update

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

  Getter Method

  Signature `OutputToolOffset`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OutputToolOffset`

  Parameters: | newValue (bool) –

  New in version NX5.0.0.

  License requirements: None.

## OutputWorkOffset

`ProbeControlParametersBuilder.``OutputWorkOffset`

  Returns or sets the option to output the work offset to update

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

  Getter Method

  Signature `OutputWorkOffset`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OutputWorkOffset`

  Parameters: | newValue (bool) –

  New in version NX5.0.0.

  License requirements: None.

## Overtravel

`ProbeControlParametersBuilder.``Overtravel`

  Returns or sets the probe overtravel distance

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

  Getter Method

  Signature `Overtravel`

  Returns: |
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Overtravel`

  Parameters: | overtravel (float) –

  New in version NX5.0.0.

  License requirements: None.

## PercentFeedback

`ProbeControlParametersBuilder.``PercentFeedback`

  Returns or sets the percent feedback

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

  Getter Method

  Signature `PercentFeedback`

  Returns: |
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PercentFeedback`

  Parameters: | percentFeedback (float) –

  New in version NX5.0.0.

  License requirements: None.

## Print

`ProbeControlParametersBuilder.``Print`

  Returns or sets the print option

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

  Getter Method

  Signature `Print`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Print`

  Parameters: | newValue (`NXOpen.CAM.ProbeControlParametersBuilderPrintType`) –

  New in version NX5.0.0.

  License requirements: None.

## ToolOffset

`ProbeControlParametersBuilder.``ToolOffset`

  Returns or sets the tool offset to update

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

  Getter Method

  Signature `ToolOffset`

  Returns: |
  Return type: | int

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ToolOffset`

  Parameters: | toolOffset (int) –

  New in version NX5.0.0.

  License requirements: None.

## WorkOffset

`ProbeControlParametersBuilder.``WorkOffset`

  Returns or sets the work offset to update

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

  Getter Method

  Signature `WorkOffset`

  Returns: |
  Return type: | int

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `WorkOffset`

  Parameters: | workOffset (int) –

  New in version NX5.0.0.

  License requirements: None.