PortBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PortBuilder Class

class `NXOpen.AME.``PortBuilder`

  Bases: `NXOpen.Builder`

  builder for the software block properties dialog

  To create a new instance of this class, use `NXOpen.AME.AMEManager.CreatePortBuilder()`

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
ConnectableProxyObjectType | Returns or sets the connectable object type
CreationMode | Returns or sets the creation mode
EngObjectType | Returns the engineering object type
PortAttributeHolder | Returns the port attribute holder
PortName | Returns or sets the name of port
PortType | Returns or sets the type of port
ReuseLibraryItem | Returns the reuse library item
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.
SetPortCardinality | Set the cardinality
SetPortDirection | Set the direction
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

PortBuilderConnectableAttrProxyObjectType Enumeration | Represents the type of connectable attribute proxy object for typed port
PortBuilderCreationModeType Enumeration | Represents the type of creation mode
PortBuilderType Enumeration | the type of a port

# Property Detail

## ConnectableProxyObjectType

`PortBuilder.``ConnectableProxyObjectType`

  Returns or sets the connectable object type

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

  Getter Method

  Signature `ConnectableProxyObjectType`

  Returns: |
  Return type: | `NXOpen.AME.PortBuilderConnectableAttrProxyObjectType`

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

  Setter Method

  Signature `ConnectableProxyObjectType`

  Parameters: | connectableAttrObjectType (`NXOpen.AME.PortBuilderConnectableAttrProxyObjectType`) –

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## CreationMode

`PortBuilder.``CreationMode`

  Returns or sets the creation mode

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

  Getter Method

  Signature `CreationMode`

  Returns: |
  Return type: | `NXOpen.AME.PortBuilderCreationModeType`

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

  Setter Method

  Signature `CreationMode`

  Parameters: | creationMode (`NXOpen.AME.PortBuilderCreationModeType`) –

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## EngObjectType

`PortBuilder.``EngObjectType`

  Returns the engineering object type

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

  Getter Method

  Signature `EngObjectType`

  Returns: |
  Return type: | `NXOpen.AME.SelectionEngineeringObjectDefinitionBuilder`

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## PortAttributeHolder

`PortBuilder.``PortAttributeHolder`

  Returns the port attribute holder

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

  Getter Method

  Signature `PortAttributeHolder`

  Returns: |
  Return type: | `NXOpen.AME.PortAttributeHolder`

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## PortName

`PortBuilder.``PortName`

  Returns or sets the name of port

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

  Getter Method

  Signature `PortName`

  Returns: |
  Return type: | str

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

  Setter Method

  Signature `PortName`

  Parameters: | portName (str) –

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## PortType

`PortBuilder.``PortType`

  Returns or sets the type of port

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

  Getter Method

  Signature `PortType`

  Returns: |
  Return type: | str

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

  Setter Method

  Signature `PortType`

  Parameters: | type (str) –

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## ReuseLibraryItem

`PortBuilder.``ReuseLibraryItem`

  Returns the reuse library item

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

  Getter Method

  Signature `ReuseLibraryItem`

  Returns: |
  Return type: | `NXOpen.Tooling.SelectReuseLibraryItemBuilder`

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

# Method Detail

## SetPortCardinality

`PortBuilder.``SetPortCardinality`

  Set the cardinality

  Signature `SetPortCardinality(portCardinality)`

  Parameters: | portCardinality (str) –

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## SetPortDirection

`PortBuilder.``SetPortDirection`

  Set the direction

  Signature `SetPortDirection(portDirection)`

  Parameters: | portDirection (str) –

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## Validate

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