TurnProbeInspectPointMoveBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# TurnProbeInspectPointMoveBuilder Class

class `NXOpen.CAM.``TurnProbeInspectPointMoveBuilder`

  Bases: `NXOpen.CAM.MoveBuilder`

  Represents the Turn Probe Inspect Point Move Builder

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

  New in version NX8.5.1.

# Properties

Property | Description
--- | ---
Direction | Returns or sets the probing direction
FeedRate | Returns or sets the feed rate
FeedType | Returns or sets the feed type
FeedUnit | Returns or sets the feed unit
MotionType | Returns or sets the motion type
NumberOfUserParameters | Returns the number of user parameters
Point | Returns or sets the point to probe
ProbeControlParameters | Returns the probe control parameters builder
ProbeProtectedParameters | Returns the probe protected parameters builder
ProbeStockParameters | Returns the probe stock parameters builder
ProbeToleranceParameters | Returns the probe tolerance parameters builder
ProtectedMove | Returns or sets the protected move status
SubopLabel | Returns or sets the subop label
Tag | Returns the Tag for this object.
Vector | Returns or sets the vector to define probing direction

# 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.
GetUserParameter | Returns the custom parameter with the given name.
ReverseDirection | Reversing the probing direction
SetParent | Set parent
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

TurnProbeInspectPointMoveBuilderDirectionTypes Enumeration | the probing direction type

# Property Detail

## Direction

`TurnProbeInspectPointMoveBuilder.``Direction`

  Returns or sets the probing direction

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

  Getter Method

  Signature `Direction`

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

  New in version NX8.5.1.

  License requirements: None.

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

  Setter Method

  Signature `Direction`

  Parameters: | dirType (`NXOpen.CAM.TurnProbeInspectPointMoveBuilderDirectionTypes`) –

  New in version NX8.5.1.

  License requirements: cam_base (“CAM BASE”)

## Point

`TurnProbeInspectPointMoveBuilder.``Point`

  Returns or sets the point to probe

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

  Getter Method

  Signature `Point`

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

  New in version NX8.5.1.

  License requirements: None.

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

  Setter Method

  Signature `Point`

  Parameters: | point (`NXOpen.Point`) –

  New in version NX8.5.1.

  License requirements: cam_base (“CAM BASE”)

## ProbeControlParameters

`TurnProbeInspectPointMoveBuilder.``ProbeControlParameters`

  Returns the probe control parameters builder

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

  Getter Method

  Signature `ProbeControlParameters`

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

  New in version NX8.5.1.

  License requirements: None.

## ProbeProtectedParameters

`TurnProbeInspectPointMoveBuilder.``ProbeProtectedParameters`

  Returns the probe protected parameters builder

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

  Getter Method

  Signature `ProbeProtectedParameters`

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

  New in version NX8.5.1.

  License requirements: None.

## ProbeStockParameters

`TurnProbeInspectPointMoveBuilder.``ProbeStockParameters`

  Returns the probe stock parameters builder

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

  Getter Method

  Signature `ProbeStockParameters`

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

  New in version NX8.5.1.

  License requirements: None.

## ProbeToleranceParameters

`TurnProbeInspectPointMoveBuilder.``ProbeToleranceParameters`

  Returns the probe tolerance parameters builder

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

  Getter Method

  Signature `ProbeToleranceParameters`

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

  New in version NX8.5.1.

  License requirements: None.

## Vector

`TurnProbeInspectPointMoveBuilder.``Vector`

  Returns or sets the vector to define probing direction

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

  Getter Method

  Signature `Vector`

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

  New in version NX8.5.1.

  License requirements: None.

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

  Setter Method

  Signature `Vector`

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

  New in version NX8.5.1.

  License requirements: None.

# Method Detail

## ReverseDirection

`TurnProbeInspectPointMoveBuilder.``ReverseDirection`

  Reversing the probing direction

  Signature `ReverseDirection()`

  New in version NX10.0.0.

  License requirements: None.

## Validate

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