LinearPathSettings Class — NXOpen Python API Reference 12.0.0 documentation

# LinearPathSettings Class

class `NXOpen.Routing.``LinearPathSettings`

  Bases: `NXOpen.Builder`

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

  Determines various settings to be applied when the path is created.

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

  Default values.

  Property | Value
  --- | ---
  LockToSelectedObject | True

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
AllowCutElbow | Returns or sets a flag indicating whether or not to allow cut elbow placement
AssignDefaultCorner | Returns or sets the preference to assign the current default corner to new segments.
AssignDefaultElbow | Returns or sets the preference to find and assign a default elbow to new segments.
LockAngle | Returns or sets the preference to determine if the angle between segments should be constrained.
LockLength | Returns or sets the preference to determine if the length of new segments should be constrained.
LockToSelectedObject | Returns or sets the preference to determine if the new segments and control points should be constrained to the objects selected by the user.
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

## AllowCutElbow

`LinearPathSettings.``AllowCutElbow`

  Returns or sets a flag indicating whether or not to allow cut elbow placement

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

  Getter Method

  Signature `AllowCutElbow`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: routing_pipetube (“Routing Piping and Tubing”)

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

  Setter Method

  Signature `AllowCutElbow`

  Parameters: | assign (bool) –

  New in version NX8.0.0.

  License requirements: routing_pipetube (“Routing Piping and Tubing”)

## AssignDefaultCorner

`LinearPathSettings.``AssignDefaultCorner`

  Returns or sets the preference to assign the current default corner to new segments.

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

  Getter Method

  Signature `AssignDefaultCorner`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Setter Method

  Signature `AssignDefaultCorner`

  Parameters: | assign (bool) –

  New in version NX5.0.0.

  License requirements: routing_base (“Routing Basic”)

## AssignDefaultElbow

`LinearPathSettings.``AssignDefaultElbow`

  Returns or sets the preference to find and assign a default elbow to new segments.

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

  Getter Method

  Signature `AssignDefaultElbow`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Setter Method

  Signature `AssignDefaultElbow`

  Parameters: | assign (bool) –

  New in version NX5.0.0.

  License requirements: routing_base (“Routing Basic”)

## LockAngle

`LinearPathSettings.``LockAngle`

  Returns or sets the preference to determine if the angle between segments should be constrained.

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

  Getter Method

  Signature `LockAngle`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Setter Method

  Signature `LockAngle`

  Parameters: | lock (bool) –

  New in version NX5.0.0.

  License requirements: routing_base (“Routing Basic”)

## LockLength

`LinearPathSettings.``LockLength`

  Returns or sets the preference to determine if the length of new segments should be constrained.

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

  Getter Method

  Signature `LockLength`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Setter Method

  Signature `LockLength`

  Parameters: | lock (bool) –

  New in version NX5.0.0.

  License requirements: routing_base (“Routing Basic”)

## LockToSelectedObject

`LinearPathSettings.``LockToSelectedObject`

  Returns or sets the preference to determine if the new segments and control points should be constrained to the objects selected by the user.

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

  Getter Method

  Signature `LockToSelectedObject`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Setter Method

  Signature `LockToSelectedObject`

  Parameters: | lock (bool) –

  New in version NX5.0.0.

  License requirements: routing_base (“Routing Basic”)

# Method Detail

## Validate

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