ModelTerminalsBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ModelTerminalsBuilder Class

class `NXOpen.Routing.``ModelTerminalsBuilder`

  Bases: `NXOpen.Builder`

  The Builder to Model/UnModel the Terminals

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

  Default values.

  Property | Value
  --- | ---
  CutbackOption | FromCharacteristic
  ExtensionOption | FromCharacteristic
  PreviewToggle | 0

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
CutbackOption | Returns or sets the cutback option
ExtensionOption | Returns or sets the extension option
List | Returns the List Containing the Terminals and their properties.
MultiPort | Returns or sets the MultiPort of the selected object
PortSelection | Returns the port selection
PreviewToggle | Returns or sets the preview
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.
Model | The Model the selected Terminals
ModelAll | The Model all the terminals
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnModel | The UnModel the selected terminals
UnModelAll | Unmodel all of the terminals
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

ModelTerminalsBuilderCutBackLocationOption Enumeration | The Enum for selecting the CutBack Option
ModelTerminalsBuilderExtensionValueOption Enumeration | The Enum for selecting the ExtensionValue Option

# Property Detail

## CutbackOption

`ModelTerminalsBuilder.``CutbackOption`

  Returns or sets the cutback option

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

  Getter Method

  Signature `CutbackOption`

  Returns: |
  Return type: | `NXOpen.Routing.ModelTerminalsBuilderCutBackLocationOption`

  New in version NX7.5.0.

  License requirements: routing_harness (“Routing Harness”)

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

  Setter Method

  Signature `CutbackOption`

  Parameters: | cutbackOption (`NXOpen.Routing.ModelTerminalsBuilderCutBackLocationOption`) –

  New in version NX7.5.0.

  License requirements: routing_harness (“Routing Harness”)

## ExtensionOption

`ModelTerminalsBuilder.``ExtensionOption`

  Returns or sets the extension option

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

  Getter Method

  Signature `ExtensionOption`

  Returns: |
  Return type: | `NXOpen.Routing.ModelTerminalsBuilderExtensionValueOption`

  New in version NX7.5.0.

  License requirements: routing_harness (“Routing Harness”)

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

  Setter Method

  Signature `ExtensionOption`

  Parameters: | extensionOption (`NXOpen.Routing.ModelTerminalsBuilderExtensionValueOption`) –

  New in version NX7.5.0.

  License requirements: routing_harness (“Routing Harness”)

## List

`ModelTerminalsBuilder.``List`

  Returns the List Containing the Terminals and their properties.

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

  Getter Method

  Signature `List`

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

  New in version NX7.5.0.

  License requirements: routing_harness (“Routing Harness”)

## MultiPort

`ModelTerminalsBuilder.``MultiPort`

  Returns or sets the MultiPort of the selected object

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

  Getter Method

  Signature `MultiPort`

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

  New in version NX7.5.0.

  License requirements: routing_harness (“Routing Harness”)

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

  Setter Method

  Signature `MultiPort`

  Parameters: | port (`NXOpen.NXObject`) – Routing Port

  New in version NX7.5.0.

  License requirements: routing_harness (“Routing Harness”)

## PortSelection

`ModelTerminalsBuilder.``PortSelection`

  Returns the port selection

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

  Getter Method

  Signature `PortSelection`

  Returns: |
  Return type: | `NXOpen.Routing.SelectPort`

  New in version NX7.5.0.

  License requirements: routing_harness (“Routing Harness”)

## PreviewToggle

`ModelTerminalsBuilder.``PreviewToggle`

  Returns or sets the preview

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

  Getter Method

  Signature `PreviewToggle`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: routing_harness (“Routing Harness”)

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

  Setter Method

  Signature `PreviewToggle`

  Parameters: | preview (bool) –

  New in version NX7.5.0.

  License requirements: routing_harness (“Routing Harness”)

# Method Detail

## Model

`ModelTerminalsBuilder.``Model`

  The Model the selected Terminals

  Signature `Model()`

  New in version NX7.5.0.

  License requirements: routing_harness (“Routing Harness”)

## ModelAll

`ModelTerminalsBuilder.``ModelAll`

  The Model all the terminals

  Signature `ModelAll()`

  New in version NX7.5.0.

  License requirements: routing_harness (“Routing Harness”)

## UnModel

`ModelTerminalsBuilder.``UnModel`

  The UnModel the selected terminals

  Signature `UnModel()`

  New in version NX7.5.0.

  License requirements: routing_harness (“Routing Harness”)

## UnModelAll

`ModelTerminalsBuilder.``UnModelAll`

  Unmodel all of the terminals

  Signature `UnModelAll()`

  New in version NX7.5.0.

  License requirements: routing_harness (“Routing Harness”)

## Validate

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