FormboardFrameCollection Class — NXOpen Python API Reference 12.0.0 documentation

# FormboardFrameCollection Class

class `NXOpen.Routing.``FormboardFrameCollection`

  Bases: `object`

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

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

  New in version NX4.0.0.

# Methods

Method | Description
--- | ---
CreateFormboardFrameByRectangle | Creates a `NXOpen.Routing.FormboardFrame` object using a rectangle defined by a `NXOpen.Point` object and two `NXOpen.Scalar` objects that represent the height and width.
ImportPattern | Creates a `NXOpen.Routing.FormboardFrame` object by importing formboard frame pattern

# Method Detail

## CreateFormboardFrameByRectangle

`FormboardFrameCollection.``CreateFormboardFrameByRectangle`

  Creates a `NXOpen.Routing.FormboardFrame` object using a rectangle defined by a `NXOpen.Point` object and two `NXOpen.Scalar` objects that represent the height and width.

  Signature `CreateFormboardFrameByRectangle(point, height, width)`

  Parameters:

  - point (`NXOpen.Point`) – Lower left corner
  - height (`NXOpen.Scalar`) –
  - width (`NXOpen.Scalar`) –

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

  New in version NX4.0.0.

  License requirements: routing_harness (“Routing Harness”)

## ImportPattern

`FormboardFrameCollection.``ImportPattern`

  Creates a `NXOpen.Routing.FormboardFrame` object by importing formboard frame pattern

  Signature `ImportPattern(filename, type, frameName)`

  Parameters:

  - filename (str) – Filename of the file to be imported
  - type (int) – Type of file imported
  - frameName (str) – new name of frame

  Returns: | a tuple
  Return type: | A tuple consisting of (newFrame, group)

  newFrame is a `NXOpen.Routing.FormboardFrame`. returning new frame group is a `NXOpen.DisplayableObject`. returning the geometry of imported file .. versionadded:: NX5.0.0

  License requirements: routing_harness (“Routing Harness”)