DeckParentBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# DeckParentBuilder Class

class `NXOpen.Die.``DeckParentBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a Die Deck Feature sub feature.

  Used by the Upper Draw Die and Draw Die Punch to capture the deck definition. Unless specified, the attributes and methods are generic and can be applied to any type of deck. This sub feature is created via the main feature builder.

  New in version NX4.0.0.

# Properties

Property | Description
--- | ---
BuildStatus | Returns the build status of deck.
DesignStatus | Returns or sets the design status of deck, if true the deck will be built into the model, if false it will not.
DisplayStatus | Returns or sets the display status of deck, if true input data to the deck will be displayed, if false the input data will not be displayed.
InnerDeckSheet | Returns or sets the inner deck sheet of deck.
IntermediateDeckOrientation | Returns or sets the intermediate deck orientation of the deck.
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
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.
GetBaseFlange | Gets the base flange profile of the draw die punch.
GetBinderEdge | Gets the binder edge profile of the upper draw die deck.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetFeature | Returns the feature currently being edited by this builder.
GetIntermediateDeck | Gets the intermediate deck profile of the deck.
GetMainDeck | Gets the main deck profile of the upper draw die deck.
GetMainWallCenterline | Gets the main wall centerline profile of the draw die punch.
GetObject | Returns the object currently being edited by this builder.
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetBaseFlange | Sets the base flange profile of the draw die punch.
SetBinderEdge | Sets the binder edge profile of the upper draw die deck.
SetIntermediateDeck | Sets the intermediate deck profile of the deck.
SetMainDeck | Sets the main deck profile of the upper draw die deck.
SetMainWallCenterline | Sets the main wall centerline profile of the draw die punch.
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
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

## BuildStatus

`DeckParentBuilder.``BuildStatus`

  Returns the build status of deck.

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

  Getter Method

  Signature `BuildStatus`

  Returns: |
  Return type: | `NXOpen.Die.DieBuildStatusOption`

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## DesignStatus

`DeckParentBuilder.``DesignStatus`

  Returns or sets the design status of deck, if true the deck will be built into the model, if false it will not.

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

  Getter Method

  Signature `DesignStatus`

  Returns: |
  Return type: | bool

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `DesignStatus`

  Parameters: | designStatus (bool) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## DisplayStatus

`DeckParentBuilder.``DisplayStatus`

  Returns or sets the display status of deck, if true input data to the deck will be displayed, if false the input data will not be displayed.

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

  Getter Method

  Signature `DisplayStatus`

  Returns: |
  Return type: | bool

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `DisplayStatus`

  Parameters: | displayStatus (bool) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## InnerDeckSheet

`DeckParentBuilder.``InnerDeckSheet`

  Returns or sets the inner deck sheet of deck.

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

  Getter Method

  Signature `InnerDeckSheet`

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

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `InnerDeckSheet`

  Parameters: | innerDeckSheet (`NXOpen.Body`) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## IntermediateDeckOrientation

`DeckParentBuilder.``IntermediateDeckOrientation`

  Returns or sets the intermediate deck orientation of the deck.

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

  Getter Method

  Signature `IntermediateDeckOrientation`

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

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `IntermediateDeckOrientation`

  Parameters: | intermediateDeckOrientation (`NXOpen.ISurface`) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

# Method Detail

## GetBaseFlange

`DeckParentBuilder.``GetBaseFlange`

  Gets the base flange profile of the draw die punch.

  Knowledge Fusion: Binder Edge of Upper Draw Die.

  Signature `GetBaseFlange()`

  Returns: | a tuple
  Return type: | A tuple consisting of (profileEntries, direction). profileEntries is a list of `NXOpen.IProfile`. The profile entries, will be curves, edges, faces, sketches or curve features. direction is a `NXOpen.Die.DirectionOption`. Profile direction.

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## GetBinderEdge

`DeckParentBuilder.``GetBinderEdge`

  Gets the binder edge profile of the upper draw die deck.

  Signature `GetBinderEdge()`

  Returns: | a tuple
  Return type: | A tuple consisting of (profileEntries, direction). profileEntries is a list of `NXOpen.IProfile`. The profile entries, will be curves, edges, faces, sketches or curve features. direction is a `NXOpen.Die.DirectionOption`. Profile direction.

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## GetIntermediateDeck

`DeckParentBuilder.``GetIntermediateDeck`

  Gets the intermediate deck profile of the deck.

  Signature `GetIntermediateDeck()`

  Returns: | a tuple
  Return type: | A tuple consisting of (profileEntries, direction). profileEntries is a list of `NXOpen.IProfile`. The profile entries, will be curves, edges, faces, sketches or curve features. direction is a `NXOpen.Die.DirectionOption`. Profile direction.

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## GetMainDeck

`DeckParentBuilder.``GetMainDeck`

  Gets the main deck profile of the upper draw die deck.

  Signature `GetMainDeck()`

  Returns: | a tuple
  Return type: | A tuple consisting of (profileEntries, direction). profileEntries is a list of `NXOpen.IProfile`. The profile entries, will be curves, edges, faces, sketches or curve features. direction is a `NXOpen.Die.DirectionOption`. Profile direction.

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## GetMainWallCenterline

`DeckParentBuilder.``GetMainWallCenterline`

  Gets the main wall centerline profile of the draw die punch.

  Knowledge Fusion: Main Deck of Upper Draw Die.

  Signature `GetMainWallCenterline()`

  Returns: | a tuple
  Return type: | A tuple consisting of (profileEntries, direction). profileEntries is a list of `NXOpen.IProfile`. The profile entries, will be curves, edges, faces, sketches or curve features. direction is a `NXOpen.Die.DirectionOption`. Profile direction.

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## SetBaseFlange

`DeckParentBuilder.``SetBaseFlange`

  Sets the base flange profile of the draw die punch.

  Knowledge Fusion: Binder Edge of Upper Draw Die.

  Signature `SetBaseFlange(direction, profileEntries)`

  Parameters:

  - direction (`NXOpen.Die.DirectionOption`) – Profile direction.
  - profileEntries (list of `NXOpen.IProfile`) – The profile entries, can be curves, edges, faces, sketches or curve features.

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## SetBinderEdge

`DeckParentBuilder.``SetBinderEdge`

  Sets the binder edge profile of the upper draw die deck.

  Signature `SetBinderEdge(direction, profileEntries)`

  Parameters:

  - direction (`NXOpen.Die.DirectionOption`) – Profile direction.
  - profileEntries (list of `NXOpen.IProfile`) – The profile entries, can be curves, edges, faces, sketches or curve features.

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## SetIntermediateDeck

`DeckParentBuilder.``SetIntermediateDeck`

  Sets the intermediate deck profile of the deck.

  Signature `SetIntermediateDeck(direction, profileEntries)`

  Parameters:

  - direction (`NXOpen.Die.DirectionOption`) – Profile direction.
  - profileEntries (list of `NXOpen.IProfile`) – The profile entries, can be curves, edges, faces, sketches or curve features.

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## SetMainDeck

`DeckParentBuilder.``SetMainDeck`

  Sets the main deck profile of the upper draw die deck.

  Signature `SetMainDeck(direction, profileEntries)`

  Parameters:

  - direction (`NXOpen.Die.DirectionOption`) – Profile direction.
  - profileEntries (list of `NXOpen.IProfile`) – The profile entries, can be curves, edges, faces, sketches or curve features.

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## SetMainWallCenterline

`DeckParentBuilder.``SetMainWallCenterline`

  Sets the main wall centerline profile of the draw die punch.

  Knowledge Fusion: Main Deck of Upper Draw Die.

  Signature `SetMainWallCenterline(direction, profileEntries)`

  Parameters:

  - direction (`NXOpen.Die.DirectionOption`) – Profile direction.
  - profileEntries (list of `NXOpen.IProfile`) – The profile entries, can be curves, edges, faces, sketches or curve features.

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## Validate

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