ExternalConnectionBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ExternalConnectionBuilder Class

class `NXOpen.Mechatronics.``ExternalConnectionBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Mechatronics.ExternalConnection` builder

  To create a new instance of this class, use `NXOpen.Mechatronics.ExternalConnectionCollection.CreateExternalConnectionBuilder()`

  New in version NX8.0.0.

# Properties

Property | Description
--- | ---
ConnectionList | Returns the connection element list.
Name | Returns or sets the name.
SelectPhysics | Returns the select physics.
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
AddElement | Add one element.
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.
RemoveAllElements | Remove all elements.
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

ExternalConnectionBuilderConditionType Enumeration | the condition type.

# Property Detail

## ConnectionList

`ExternalConnectionBuilder.``ConnectionList`

  Returns the connection element list.

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

  Getter Method

  Signature `ConnectionList`

  Returns: |
  Return type: | `NXOpen.Mechatronics.ExternalConnectionElementBuilderList`

  New in version NX8.0.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Name

`ExternalConnectionBuilder.``Name`

  Returns or sets the name.

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

  Getter Method

  Signature `Name`

  Returns: |
  Return type: | str

  New in version NX8.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `Name`

  Parameters: | name (str) –

  New in version NX8.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## SelectPhysics

`ExternalConnectionBuilder.``SelectPhysics`

  Returns the select physics.

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

  Getter Method

  Signature `SelectPhysics`

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

  New in version NX8.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

# Method Detail

## AddElement

`ExternalConnectionBuilder.``AddElement`

  Add one element.

  Signature `AddElement(propTag, signalType, signalName, propertyType, streamIO, conditionType, conditionValue, multiplier, offsetValue, boolOperator)`

  Parameters:

  - propTag (int) –
  - signalType (int) –
  - signalName (str) –
  - propertyType (int) –
  - streamIO (int) –
  - conditionType (int) –
  - conditionValue (float) –
  - multiplier (float) –
  - offsetValue (float) –
  - boolOperator (int) –

  New in version NX8.0.0.

  Deprecated since version NX8.0.1: Please use `NXOpen.Mechatronics.ExternalConnectionElementBuilder` instead.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## RemoveAllElements

`ExternalConnectionBuilder.``RemoveAllElements`

  Remove all elements.

  Signature `RemoveAllElements()`

  New in version NX8.0.0.

  Deprecated since version NX8.0.1: Please use `NXOpen.Mechatronics.ExternalConnectionElementBuilder` instead.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Validate

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