InputPortAssociation Class — NXOpen Python API Reference 12.0.0 documentation

# InputPortAssociation Class

class `NXOpen.Motion.``InputPortAssociation`

  Bases: `NXOpen.Motion.PortAssociation`

  Represents a `Motion.InputPortAssociation`.

  This class contains the port association for the inputs of a mechatronics element To create a new instance of this class, use `NXOpen.Motion.MechatronicsBuilder.NewInputListItem()`

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
AssociatedPortName | Returns the created and associated port name
Name | Returns or sets the mechatronics port name
Offset | Returns the offset
Port | Returns or sets the associated port
ScaleFactor | Returns the scale factor
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## AssociatedPortName

`InputPortAssociation.``AssociatedPortName`

  Returns the created and associated port name

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

  Getter Method

  Signature `AssociatedPortName`

  Returns: |
  Return type: | str

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## Port

`InputPortAssociation.``Port`

  Returns or sets the associated port

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

  Getter Method

  Signature `Port`

  Returns: |
  Return type: | `NXOpen.Motion.ControlPort`

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

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

  Setter Method

  Signature `Port`

  Parameters: | port (`NXOpen.Motion.ControlPort`) –

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

# Method Detail

## Validate

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