PadParentBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PadParentBuilder Class

class `NXOpen.Die.``PadParentBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a Die Pad Parent sub feature.

  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 die pads.
CenterHole | Returns or sets the center hole switch of die pads, if true the center hole will be created in the pads, if false they will not.
DesignStatus | Returns or sets the design status of die pads, if true the pads will be built into the model, if false they will not.
Diameter | Returns or sets the diameter of die pads.
DisplayStatus | Returns or sets the display status of die pads, if true input data to the pads will be displayed, if false the input data will not be displayed.
Height | Returns or sets the height of die pads.
HoleDiameter | Returns or sets the hole diameter of die pads.
Length | Returns or sets the length of die pads.
LocationOffset | Returns or sets the location offset of die pads.
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
Relief | Returns or sets the relief switch of die pads, if true the relief will be built around the pads, if false they will not.
ReliefDepth | Returns or sets the relief depth of die pads.
ReliefWidth | Returns or sets the relief width of die pads.
ShapeType | Returns or sets the shape type of die pads.
SurfaceOffset | Returns or sets the surface offset of die pads.
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Width | Returns or sets the width of die pads.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
CreateChild | Creates a child pad.
DeleteChild | Deletes a child pad.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetChildren | Outputs the child pads.
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.
GetHoleAttributes | Gets the hole attributes, note existance of attributes depends on usage in main feature.
GetObject | Returns the object currently being edited by this builder.
GetPadAttributes | Gets the pad attributes, note existance of attributes depends on usage in main feature.
GetReliefAttributes | Gets the relief attributes, note existance of attributes depends on usage in main feature.
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetHoleAttributes | Sets the hole attributes, note existance of attributes depends on usage in main feature.
SetPadAttributes | Sets the pad attributes, note existance of attributes depends on usage in main feature.
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
SetReliefAttributes | Sets the relief attributes, note existance of attributes depends on usage in main feature.
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.

# Enumerations

PadParentBuilderShapeTypeOption Enumeration | Settings for the shape type of the die pads.

# Property Detail

## BuildStatus

`PadParentBuilder.``BuildStatus`

  Returns the build status of die pads.

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

  Getter Method

  Signature `BuildStatus`

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

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## CenterHole

`PadParentBuilder.``CenterHole`

  Returns or sets the center hole switch of die pads, if true the center hole will be created in the pads, if false they will not.

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

  Getter Method

  Signature `CenterHole`

  Returns: |
  Return type: | bool

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `CenterHole`

  Parameters: | centerHole (bool) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## DesignStatus

`PadParentBuilder.``DesignStatus`

  Returns or sets the design status of die pads, if true the pads will be built into the model, if false they 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”)

## Diameter

`PadParentBuilder.``Diameter`

  Returns or sets the diameter of die pads.

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

  Getter Method

  Signature `Diameter`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `Diameter`

  Parameters: | diameter (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## DisplayStatus

`PadParentBuilder.``DisplayStatus`

  Returns or sets the display status of die pads, if true input data to the pads 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”)

## Height

`PadParentBuilder.``Height`

  Returns or sets the height of die pads.

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

  Getter Method

  Signature `Height`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `Height`

  Parameters: | height (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## HoleDiameter

`PadParentBuilder.``HoleDiameter`

  Returns or sets the hole diameter of die pads.

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

  Getter Method

  Signature `HoleDiameter`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `HoleDiameter`

  Parameters: | holeDiameter (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## Length

`PadParentBuilder.``Length`

  Returns or sets the length of die pads.

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

  Getter Method

  Signature `Length`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `Length`

  Parameters: | length (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## LocationOffset

`PadParentBuilder.``LocationOffset`

  Returns or sets the location offset of die pads.

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

  Getter Method

  Signature `LocationOffset`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `LocationOffset`

  Parameters: | locationOffset (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## Relief

`PadParentBuilder.``Relief`

  Returns or sets the relief switch of die pads, if true the relief will be built around the pads, if false they will not.

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

  Getter Method

  Signature `Relief`

  Returns: |
  Return type: | bool

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `Relief`

  Parameters: | relief (bool) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## ReliefDepth

`PadParentBuilder.``ReliefDepth`

  Returns or sets the relief depth of die pads.

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

  Getter Method

  Signature `ReliefDepth`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `ReliefDepth`

  Parameters: | reliefDepth (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## ReliefWidth

`PadParentBuilder.``ReliefWidth`

  Returns or sets the relief width of die pads.

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

  Getter Method

  Signature `ReliefWidth`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `ReliefWidth`

  Parameters: | reliefWidth (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## ShapeType

`PadParentBuilder.``ShapeType`

  Returns or sets the shape type of die pads.

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

  Getter Method

  Signature `ShapeType`

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

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `ShapeType`

  Parameters: | shapeType (`NXOpen.Die.PadParentBuilderShapeTypeOption`) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## SurfaceOffset

`PadParentBuilder.``SurfaceOffset`

  Returns or sets the surface offset of die pads.

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

  Getter Method

  Signature `SurfaceOffset`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `SurfaceOffset`

  Parameters: | surfaceOffset (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## Width

`PadParentBuilder.``Width`

  Returns or sets the width of die pads.

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

  Getter Method

  Signature `Width`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `Width`

  Parameters: | width (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

# Method Detail

## CreateChild

`PadParentBuilder.``CreateChild`

  Creates a child pad.

  Signature `CreateChild()`

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

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## DeleteChild

`PadParentBuilder.``DeleteChild`

  Deletes a child pad.

  Signature `DeleteChild(diepadchild)`

  Parameters: | diepadchild (`NXOpen.Die.PadChildBuilder`) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## GetChildren

`PadParentBuilder.``GetChildren`

  Outputs the child pads.

  Signature `GetChildren()`

  Returns: | The child pads.
  Return type: | list of `NXOpen.Die.PadChildBuilder`

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## GetHoleAttributes

`PadParentBuilder.``GetHoleAttributes`

  Gets the hole attributes, note existance of attributes depends on usage in main feature.

  Signature `GetHoleAttributes()`

  Returns: | a tuple
  Return type: | A tuple consisting of (title, value, color, diameterTitle) title is a str. Title for attribute. value is a str. Value of attribute. color is a int. Color of hole faces. diameterTitle is a str. Title for diameter attribute.

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## GetPadAttributes

`PadParentBuilder.``GetPadAttributes`

  Gets the pad attributes, note existance of attributes depends on usage in main feature.

  Signature `GetPadAttributes()`

  Returns: | a tuple
  Return type: | A tuple consisting of (title, value, color) title is a str. Title for attribute. value is a str. Value of attribute. color is a int. Color of pad faces.

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## GetReliefAttributes

`PadParentBuilder.``GetReliefAttributes`

  Gets the relief attributes, note existance of attributes depends on usage in main feature.

  Signature `GetReliefAttributes()`

  Returns: | a tuple
  Return type: | A tuple consisting of (title, value, color) title is a str. Title for attribute. value is a str. Value of attribute. color is a int. Color of relief faces.

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## SetHoleAttributes

`PadParentBuilder.``SetHoleAttributes`

  Sets the hole attributes, note existance of attributes depends on usage in main feature.

  Signature `SetHoleAttributes(title, value, color, diameterTitle)`

  Parameters:

  - title (str) – Title for attribute.
  - value (str) – Value of attribute.
  - color (int) – Color of hole faces.
  - diameterTitle (str) – Title for diameter attribute.

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## SetPadAttributes

`PadParentBuilder.``SetPadAttributes`

  Sets the pad attributes, note existance of attributes depends on usage in main feature.

  Signature `SetPadAttributes(title, value, color)`

  Parameters:

  - title (str) – Title for attribute.
  - value (str) – Value of attribute.
  - color (int) – Color of pad faces.

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## SetReliefAttributes

`PadParentBuilder.``SetReliefAttributes`

  Sets the relief attributes, note existance of attributes depends on usage in main feature.

  Signature `SetReliefAttributes(title, value, color)`

  Parameters:

  - title (str) – Title for attribute.
  - value (str) – Value of attribute.
  - color (int) – Color of relief faces.

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## Validate

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