MultiPortCollection Class — NXOpen Python API Reference 12.0.0 documentation

# MultiPortCollection Class

class `NXOpen.Routing.``MultiPortCollection`

  Bases: `object`

  Represents a collection of `NXOpen.Routing.MultiPort` objects.

  To obtain an instance of this class, refer to `NXOpen.Routing.RouteManager`

  New in version NX4.0.0.

# Methods

Method | Description
--- | ---
CreateMultiPort | Creates a MultiPort with a rotation vector at an absolute location.

# Method Detail

## CreateMultiPort

`MultiPortCollection.``CreateMultiPort`

  Overloaded method CreateMultiPort

  - `CreateMultiPort(origin, alignmentVector, rotationVector, rotationObject, clockAngle)`
  - `CreateMultiPort(origin, alignmentVector)`
  - `CreateMultiPort(origin, alignmentVector, rotationVector, rotationObject, clockAngle, point)`
  - `CreateMultiPort(origin, alignmentVector, point)`
  - `CreateMultiPort(origin, alignmentVector, rotationVector, rotationObject, clockAngle, axis)`
  - `CreateMultiPort(origin, alignmentVector, derivationObject)`
  - `CreateMultiPort(origin, alignmentVector, rotationVector, rotationObject, clockAngle, allowMultipleConnections)`
  - `CreateMultiPort(origin, alignmentVector, allowMultipleConnections)`
  - `CreateMultiPort(origin, alignmentVector, rotationVector, rotationObject, clockAngle, point, allowMultipleConnections)`
  - `CreateMultiPort(origin, alignmentVector, point, allowMultipleConnections)`
  - `CreateMultiPort(origin, alignmentVector, rotationVector, rotationObject, clockAngle, axis, allowMultipleConnections)`
  - `CreateMultiPort(origin, alignmentVector, derivationObject, allowMultipleConnections)`

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

  Creates a MultiPort with a rotation vector at an absolute location. Default allows multiple connections to this port.

  Signature `CreateMultiPort(origin, alignmentVector, rotationVector, rotationObject, clockAngle)`

  Parameters:

  - origin (`NXOpen.Point3d`) – Origin of the multi port
  - alignmentVector (`NXOpen.Vector3d`) – Alignment vector of the multi port
  - rotationVector (`NXOpen.Vector3d`) – Rotation Vector of the multi port
  - rotationObject (`NXOpen.DisplayableObject`) – Rotation derivation object, may be NXOpen.DisplayableObject.NULL
  - clockAngle (float) – Clock angle increment in degrees for the rotation vector

  Returns: |
  Return type: | `NXOpen.Routing.MultiPort`

  New in version NX4.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Creates a MultiPort with no rotation vector at an absolute location. Default allows multiple connections to this port.

  Signature `CreateMultiPort(origin, alignmentVector)`

  Parameters:

  - origin (`NXOpen.Point3d`) – Origin of the multi port
  - alignmentVector (`NXOpen.Vector3d`) – Alignment vector of the multi port

  Returns: |
  Return type: | `NXOpen.Routing.MultiPort`

  New in version NX4.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Creates a MultiPort with a rotation vector at a point. Default allows multiple connections to this port.

  Signature `CreateMultiPort(origin, alignmentVector, rotationVector, rotationObject, clockAngle, point)`

  Parameters:

  - origin (`NXOpen.Point3d`) – Origin of the multi port
  - alignmentVector (`NXOpen.Vector3d`) – Alignment vector of the multi port
  - rotationVector (`NXOpen.Vector3d`) – Rotation Vector of the multi port
  - rotationObject (`NXOpen.DisplayableObject`) – Rotation derivation object, may be NXOpen.DisplayableObject.NULL
  - clockAngle (float) – Clock angle increment in degrees for the rotation vector
  - point (`NXOpen.Point`) – Multi Port derived from this point

  Returns: |
  Return type: | `NXOpen.Routing.MultiPort`

  New in version NX4.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Creates a MultiPort with no rotation vector at a point. Default allows multiple connections to this port.

  Signature `CreateMultiPort(origin, alignmentVector, point)`

  Parameters:

  - origin (`NXOpen.Point3d`) – Origin of the multi port
  - alignmentVector (`NXOpen.Vector3d`) – Alignment vector of the multi port
  - point (`NXOpen.Point`) – Multi Port derived from this point

  Returns: |
  Return type: | `NXOpen.Routing.MultiPort`

  New in version NX4.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Creates a MultiPort with a rotation vector on an axis. Default allows multiple connections to this port.

  Signature `CreateMultiPort(origin, alignmentVector, rotationVector, rotationObject, clockAngle, axis)`

  Parameters:

  - origin (`NXOpen.Point3d`) – Origin of the multi port
  - alignmentVector (`NXOpen.Vector3d`) – Alignment vector of the multi port
  - rotationVector (`NXOpen.Vector3d`) – Rotation Vector of the multi port
  - rotationObject (`NXOpen.DisplayableObject`) – Rotation derivation object, may be NXOpen.DisplayableObject.NULL
  - clockAngle (float) – Clock angle increment in degrees for the rotation vector
  - axis (`NXOpen.Axis`) – Multi Port derived from this axis

  Returns: |
  Return type: | `NXOpen.Routing.MultiPort`

  New in version NX4.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Creates a MultiPort with no rotation vector on an axis. Default allows multiple connections to this port.

  Signature `CreateMultiPort(origin, alignmentVector, derivationObject)`

  Parameters:

  - origin (`NXOpen.Point3d`) – Origin of the multi port
  - alignmentVector (`NXOpen.Vector3d`) – Alignment vector of the multi port
  - derivationObject (`NXOpen.Axis`) – Multi Port derived from this axis

  Returns: |
  Return type: | `NXOpen.Routing.MultiPort`

  New in version NX4.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Creates a MultiPort with a rotation vector at an absolute location

  Signature `CreateMultiPort(origin, alignmentVector, rotationVector, rotationObject, clockAngle, allowMultipleConnections)`

  Parameters:

  - origin (`NXOpen.Point3d`) – Origin of the multi port
  - alignmentVector (`NXOpen.Vector3d`) – Alignment vector of the multi port
  - rotationVector (`NXOpen.Vector3d`) – Rotation Vector of the multi port
  - rotationObject (`NXOpen.DisplayableObject`) – Rotation derivation object, may be NXOpen.DisplayableObject.NULL
  - clockAngle (float) – Clock angle increment in degrees for the rotation vector
  - allowMultipleConnections (bool) – Does this fitting port allow multiple wires to be routed to it?

  Returns: |
  Return type: | `NXOpen.Routing.MultiPort`

  New in version NX5.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Creates a MultiPort with no rotation vector at an absolute location

  Signature `CreateMultiPort(origin, alignmentVector, allowMultipleConnections)`

  Parameters:

  - origin (`NXOpen.Point3d`) – Origin of the multi port
  - alignmentVector (`NXOpen.Vector3d`) – Alignment vector of the multi port
  - allowMultipleConnections (bool) – Does this fitting port allow multiple wires to be routed to it?

  Returns: |
  Return type: | `NXOpen.Routing.MultiPort`

  New in version NX5.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Creates a MultiPort with a rotation vector at a point

  Signature `CreateMultiPort(origin, alignmentVector, rotationVector, rotationObject, clockAngle, point, allowMultipleConnections)`

  Parameters:

  - origin (`NXOpen.Point3d`) – Origin of the multi port
  - alignmentVector (`NXOpen.Vector3d`) – Alignment vector of the multi port
  - rotationVector (`NXOpen.Vector3d`) – Rotation Vector of the multi port
  - rotationObject (`NXOpen.DisplayableObject`) – Rotation derivation object, may be NXOpen.DisplayableObject.NULL
  - clockAngle (float) – Clock angle increment in degrees for the rotation vector
  - point (`NXOpen.Point`) – Multi Port derived from this point
  - allowMultipleConnections (bool) – Does this fitting port allow multiple wires to be routed to it?

  Returns: |
  Return type: | `NXOpen.Routing.MultiPort`

  New in version NX5.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Creates a MultiPort with no rotation vector at a point

  Signature `CreateMultiPort(origin, alignmentVector, point, allowMultipleConnections)`

  Parameters:

  - origin (`NXOpen.Point3d`) – Origin of the multi port
  - alignmentVector (`NXOpen.Vector3d`) – Alignment vector of the multi port
  - point (`NXOpen.Point`) – Multi Port derived from this point
  - allowMultipleConnections (bool) – Does this fitting port allow multiple wires to be routed to it?

  Returns: |
  Return type: | `NXOpen.Routing.MultiPort`

  New in version NX5.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Creates a MultiPort with a rotation vector on an axis

  Signature `CreateMultiPort(origin, alignmentVector, rotationVector, rotationObject, clockAngle, axis, allowMultipleConnections)`

  Parameters:

  - origin (`NXOpen.Point3d`) – Origin of the multi port
  - alignmentVector (`NXOpen.Vector3d`) – Alignment vector of the multi port
  - rotationVector (`NXOpen.Vector3d`) – Rotation Vector of the multi port
  - rotationObject (`NXOpen.DisplayableObject`) – Rotation derivation object, may be NXOpen.DisplayableObject.NULL
  - clockAngle (float) – Clock angle increment in degrees for the rotation vector
  - axis (`NXOpen.Axis`) – Multi Port derived from this axis
  - allowMultipleConnections (bool) – Does this fitting port allow multiple wires to be routed to it?

  Returns: |
  Return type: | `NXOpen.Routing.MultiPort`

  New in version NX5.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Creates a MultiPort with no rotation vector on an axis

  Signature `CreateMultiPort(origin, alignmentVector, derivationObject, allowMultipleConnections)`

  Parameters:

  - origin (`NXOpen.Point3d`) – Origin of the multi port
  - alignmentVector (`NXOpen.Vector3d`) – Alignment vector of the multi port
  - derivationObject (`NXOpen.Axis`) – Multi Port derived from this axis
  - allowMultipleConnections (bool) – Does this fitting port allow multiple wires to be routed to it?

  Returns: |
  Return type: | `NXOpen.Routing.MultiPort`

  New in version NX5.0.0.

  License requirements: routing_base (“Routing Basic”)

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