SignalAdapterBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SignalAdapterBuilder Class

class `NXOpen.Mechatronics.``SignalAdapterBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Mechatronics.SignalAdapterBuilder`.

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

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
MaxSignalId | Returns or sets the maximum signal id.
Name | Returns or sets the name.
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.
GetParameterData | Gets all parameter data.
GetSignalData | Gets all signal data.
SetParameterData | Sets all parameter data.
SetSignalData | Sets all signal data.
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

SignalAdapterBuilderDataPortType Enumeration | Represents the data port type.
SignalAdapterBuilderDataType Enumeration | Represents the data type.

# Structs

SignalAdapterBuilderParameterData_Struct Struct | Defines the parameter data.
SignalAdapterBuilderSignalData_Struct Struct | Defines the signal data.

# Property Detail

## MaxSignalId

`SignalAdapterBuilder.``MaxSignalId`

  Returns or sets the maximum signal id.

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

  Getter Method

  Signature `MaxSignalId`

  Returns: |
  Return type: | int

  New in version NX8.5.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `MaxSignalId`

  Parameters: | maxSignalId (int) –

  New in version NX8.5.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Name

`SignalAdapterBuilder.``Name`

  Returns or sets the name.

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

  Getter Method

  Signature `Name`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `Name`

  Parameters: | name (str) –

  New in version NX8.5.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

# Method Detail

## GetParameterData

`SignalAdapterBuilder.``GetParameterData`

  Gets all parameter data.

  Signature `GetParameterData()`

  Returns: | Array of parameter data
  Return type: | list of `NXOpen.Mechatronics.SignalAdapterBuilderParameterData_Struct`

  New in version NX8.5.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## GetSignalData

`SignalAdapterBuilder.``GetSignalData`

  Gets all signal data.

  Signature `GetSignalData()`

  Returns: | Array of signal data
  Return type: | list of `NXOpen.Mechatronics.SignalAdapterBuilderSignalData_Struct`

  New in version NX8.5.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## SetParameterData

`SignalAdapterBuilder.``SetParameterData`

  Sets all parameter data.

  Signature `SetParameterData(parameterData)`

  Parameters: | parameterData (list of `NXOpen.Mechatronics.SignalAdapterBuilderParameterData_Struct`) – Array of parameter data

  New in version NX8.5.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## SetSignalData

`SignalAdapterBuilder.``SetSignalData`

  Sets all signal data.

  Signature `SetSignalData(signalData)`

  Parameters: | signalData (list of `NXOpen.Mechatronics.SignalAdapterBuilderSignalData_Struct`) – Array of signal data

  New in version NX8.5.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Validate

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