ExternalConnectionElementBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ExternalConnectionElementBuilder Class

class `NXOpen.Mechatronics.``ExternalConnectionElementBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Mechatronics.ExternalConnectionElementBuilder` builder

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

  New in version NX8.0.1.

# Properties

Property | Description
--- | ---
ConditionOption | Returns or sets the condition type.
ConditionValue | Returns or sets the condition value.
Inverse | Returns or sets whether to inverse the logic value.
Multiplier | Returns or sets the multiplier.
OffsetValue | Returns or sets the offset value.
PropertyDataType | Returns or sets the data type of physics property.
PropertyId | Returns or sets the property ID of physics object.
SignalDataType | Returns or sets the data type of signal.
SignalName | Returns or sets the name of signal.
StreamOption | Returns or sets the data stream type.
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.

# Enumerations

ExternalConnectionElementBuilderConditionType Enumeration | the condition type.
ExternalConnectionElementBuilderDataType Enumeration | the data type.
ExternalConnectionElementBuilderStreamType Enumeration | the stream type.

# Property Detail

## ConditionOption

`ExternalConnectionElementBuilder.``ConditionOption`

  Returns or sets the condition type.

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

  Getter Method

  Signature `ConditionOption`

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

  New in version NX8.0.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `ConditionOption`

  Parameters: | type (`NXOpen.Mechatronics.ExternalConnectionElementBuilderConditionType`) –

  New in version NX8.0.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## ConditionValue

`ExternalConnectionElementBuilder.``ConditionValue`

  Returns or sets the condition value.

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

  Getter Method

  Signature `ConditionValue`

  Returns: |
  Return type: | float

  New in version NX8.0.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `ConditionValue`

  Parameters: | conditionValue (float) –

  New in version NX8.0.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Inverse

`ExternalConnectionElementBuilder.``Inverse`

  Returns or sets whether to inverse the logic value.

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

  Getter Method

  Signature `Inverse`

  Returns: |
  Return type: | bool

  New in version NX8.0.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `Inverse`

  Parameters: | inverse (bool) –

  New in version NX8.0.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Multiplier

`ExternalConnectionElementBuilder.``Multiplier`

  Returns or sets the multiplier.

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

  Getter Method

  Signature `Multiplier`

  Returns: |
  Return type: | float

  New in version NX8.0.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `Multiplier`

  Parameters: | multiplier (float) –

  New in version NX8.0.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## OffsetValue

`ExternalConnectionElementBuilder.``OffsetValue`

  Returns or sets the offset value.

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

  Getter Method

  Signature `OffsetValue`

  Returns: |
  Return type: | float

  New in version NX8.0.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `OffsetValue`

  Parameters: | offset (float) –

  New in version NX8.0.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## PropertyDataType

`ExternalConnectionElementBuilder.``PropertyDataType`

  Returns or sets the data type of physics property.

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

  Getter Method

  Signature `PropertyDataType`

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

  New in version NX8.0.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `PropertyDataType`

  Parameters: | dataType (`NXOpen.Mechatronics.ExternalConnectionElementBuilderDataType`) –

  New in version NX8.0.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## PropertyId

`ExternalConnectionElementBuilder.``PropertyId`

  Returns or sets the property ID of physics object.

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

  Getter Method

  Signature `PropertyId`

  Returns: |
  Return type: | int

  New in version NX8.0.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `PropertyId`

  Parameters: | propId (int) –

  New in version NX8.0.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## SignalDataType

`ExternalConnectionElementBuilder.``SignalDataType`

  Returns or sets the data type of signal.

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

  Getter Method

  Signature `SignalDataType`

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

  New in version NX8.0.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `SignalDataType`

  Parameters: | dataType (`NXOpen.Mechatronics.ExternalConnectionElementBuilderDataType`) –

  New in version NX8.0.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## SignalName

`ExternalConnectionElementBuilder.``SignalName`

  Returns or sets the name of signal.

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

  Getter Method

  Signature `SignalName`

  Returns: |
  Return type: | str

  New in version NX8.0.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `SignalName`

  Parameters: | name (str) –

  New in version NX8.0.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## StreamOption

`ExternalConnectionElementBuilder.``StreamOption`

  Returns or sets the data stream type.

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

  Getter Method

  Signature `StreamOption`

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

  New in version NX8.0.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `StreamOption`

  Parameters: | streamType (`NXOpen.Mechatronics.ExternalConnectionElementBuilderStreamType`) –

  New in version NX8.0.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

# Method Detail

## Validate

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