ElbowSnapSettings Class — NXOpen Python API Reference 12.0.0 documentation

# ElbowSnapSettings Class

class `NXOpen.Routing.``ElbowSnapSettings`

  Bases: `NXOpen.Builder`

  Helper object used the by `NXOpen.Routing.LinearPathBuilder` builder.

  Determines whether or not elbow snapping should occur in the “Create Linear Path” UI, and if so, what the angle tolerance should be.

  To create a new instance of this class, use `NXOpen.Routing.RouteManager.CreateElbowSnapSettings()`

  Default values.

  Property | Value
  --- | ---
  AngleTolerance | 5.0
  SnapToElbowAngles | True

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
AngleTolerance | Returns or sets the tolerance within which to search for elbow angles.
SnapToElbowAngles | Returns or sets whether or not to snap control points to the nearest valid elbow angle.
Tag | Returns the Tag for this object.

# 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.
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

## AngleTolerance

`ElbowSnapSettings.``AngleTolerance`

  Returns or sets the tolerance within which to search for elbow angles.

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

  Getter Method

  Signature `AngleTolerance`

  Returns: |
  Return type: | float

  New in version NX5.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Setter Method

  Signature `AngleTolerance`

  Parameters: | tolerance (float) –

  New in version NX5.0.0.

  License requirements: routing_base (“Routing Basic”)

## SnapToElbowAngles

`ElbowSnapSettings.``SnapToElbowAngles`

  Returns or sets whether or not to snap control points to the nearest valid elbow angle.

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

  Getter Method

  Signature `SnapToElbowAngles`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Setter Method

  Signature `SnapToElbowAngles`

  Parameters: | doSnap (bool) –

  New in version NX5.0.0.

  License requirements: routing_base (“Routing Basic”)

# Method Detail

## Validate

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