LineupBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# LineupBuilder Class

class `NXOpen.Die.``LineupBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a Lineup feature builder

  To create a new instance of this class, use `NXOpen.Die.DieCollection.Lineup()`

  New in version NX4.0.0.

# Properties

Property | Description
--- | ---
FlowDirection | Returns or sets the flow direction of the lineup
Origin | Returns or sets the origin of the lineup
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag | Returns or sets the patch solution flag
PatchSurfaceFilename | Returns or sets the patch surface filename
PressDirection | Returns or sets the press direction of the lineup
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
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.
GetDetails | Gets the detailed description of the lineup
GetFeature | Returns the feature currently being edited by this builder.
GetObject | Returns the object currently being edited by this builder.
GetProductBodies | Gets the product sheet bodies of the lineup
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetDetails | Sets the detailed description of the lineup
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
SetProductBodies | Sets the product sheet bodies of the lineup
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## FlowDirection

`LineupBuilder.``FlowDirection`

  Returns or sets the flow direction of the lineup

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

  Getter Method

  Signature `FlowDirection`

  Returns: |
  Return type: | `NXOpen.Vector3d`

  New in version NX7.5.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `FlowDirection`

  Parameters: | flowDirection (`NXOpen.Vector3d`) –

  New in version NX7.5.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## Origin

`LineupBuilder.``Origin`

  Returns or sets the origin of the lineup

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

  Getter Method

  Signature `Origin`

  Returns: |
  Return type: | `NXOpen.Point3d`

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `Origin`

  Parameters: | origin (`NXOpen.Point3d`) –

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## PressDirection

`LineupBuilder.``PressDirection`

  Returns or sets the press direction of the lineup

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

  Getter Method

  Signature `PressDirection`

  Returns: |
  Return type: | `NXOpen.Vector3d`

  New in version NX7.5.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `PressDirection`

  Parameters: | pressDirection (`NXOpen.Vector3d`) –

  New in version NX7.5.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

# Method Detail

## GetDetails

`LineupBuilder.``GetDetails`

  Gets the detailed description of the lineup

  Signature `GetDetails()`

  Returns: | detail strings
  Return type: | list of str

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## GetProductBodies

`LineupBuilder.``GetProductBodies`

  Gets the product sheet bodies of the lineup

  Signature `GetProductBodies()`

  Returns: |
  Return type: | list of `NXOpen.Body`

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## SetDetails

`LineupBuilder.``SetDetails`

  Sets the detailed description of the lineup

  Signature `SetDetails(strings)`

  Parameters: | strings (list of str) – detail strings

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## SetProductBodies

`LineupBuilder.``SetProductBodies`

  Sets the product sheet bodies of the lineup

  Signature `SetProductBodies(objects)`

  Parameters: | objects (list of `NXOpen.Body`) –

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## Validate

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