HoleParentBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# HoleParentBuilder Class

class `NXOpen.Die.``HoleParentBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a Die Hole 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 holes.
CounterBoreDiameter | Returns or sets the counter bore diameter of die holes.
CreateWithPad | Returns or sets the create with pad switch of die holes, if true a pad will be created around the holes, if false the pad will not be created.
Depth | Returns or sets the depth of die holes.
DesignStatus | Returns or sets the design status of die holes, if true the holes will be built into the model, if false they will not.
Diameter | Returns or sets the diameter of die holes.
DisplayHoles | Returns or sets the display holes switch of die holes, if true the holes will be built into the model, if false they will not.
DisplayStatus | Returns or sets the display status of die holes, if true input data to the holes will be displayed, if false the input data will not be displayed.
DropThruDiameter | Returns or sets the drop thru diameter of die holes.
PadDiameter | Returns or sets the pad diameter of die holes.
PadHeight | Returns or sets the pad height of die holes.
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
PlaneOffset | Returns or sets the plane offset of die holes.
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
CreateChild | Creates a child hole.
DeleteChild | Deletes a child hole.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetChildren | Outputs the child holes.
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.
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
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

`HoleParentBuilder.``BuildStatus`

  Returns the build status of die holes.

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

  Getter Method

  Signature `BuildStatus`

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

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## CounterBoreDiameter

`HoleParentBuilder.``CounterBoreDiameter`

  Returns or sets the counter bore diameter of die holes.

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

  Getter Method

  Signature `CounterBoreDiameter`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `CounterBoreDiameter`

  Parameters: | counterBoreDiameter (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## CreateWithPad

`HoleParentBuilder.``CreateWithPad`

  Returns or sets the create with pad switch of die holes, if true a pad will be created around the holes, if false the pad will not be created.

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

  Getter Method

  Signature `CreateWithPad`

  Returns: |
  Return type: | bool

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `CreateWithPad`

  Parameters: | createWithPad (bool) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## Depth

`HoleParentBuilder.``Depth`

  Returns or sets the depth of die holes.

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

  Getter Method

  Signature `Depth`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `Depth`

  Parameters: | depth (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## DesignStatus

`HoleParentBuilder.``DesignStatus`

  Returns or sets the design status of die holes, if true the holes 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

`HoleParentBuilder.``Diameter`

  Returns or sets the diameter of die holes.

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

  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”)

## DisplayHoles

`HoleParentBuilder.``DisplayHoles`

  Returns or sets the display holes switch of die holes, if true the holes will be built into the model, if false they will not.

  Note that this setting has the same affect as design status, unless the create with pad switch is true.

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

  Getter Method

  Signature `DisplayHoles`

  Returns: |
  Return type: | bool

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `DisplayHoles`

  Parameters: | displayHoles (bool) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## DisplayStatus

`HoleParentBuilder.``DisplayStatus`

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

## DropThruDiameter

`HoleParentBuilder.``DropThruDiameter`

  Returns or sets the drop thru diameter of die holes.

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

  Getter Method

  Signature `DropThruDiameter`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `DropThruDiameter`

  Parameters: | dropThruDiameter (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## PadDiameter

`HoleParentBuilder.``PadDiameter`

  Returns or sets the pad diameter of die holes.

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

  Getter Method

  Signature `PadDiameter`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `PadDiameter`

  Parameters: | padDiameter (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## PadHeight

`HoleParentBuilder.``PadHeight`

  Returns or sets the pad height of die holes.

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

  Getter Method

  Signature `PadHeight`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `PadHeight`

  Parameters: | padHeight (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## PlaneOffset

`HoleParentBuilder.``PlaneOffset`

  Returns or sets the plane offset of die holes.

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

  Getter Method

  Signature `PlaneOffset`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `PlaneOffset`

  Parameters: | planeOffset (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

# Method Detail

## CreateChild

`HoleParentBuilder.``CreateChild`

  Creates a child hole.

  Signature `CreateChild()`

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

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## DeleteChild

`HoleParentBuilder.``DeleteChild`

  Deletes a child hole.

  Signature `DeleteChild(dieholechild)`

  Parameters: | dieholechild (`NXOpen.Die.HoleChildBuilder`) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## GetChildren

`HoleParentBuilder.``GetChildren`

  Outputs the child holes.

  Signature `GetChildren()`

  Returns: | The child holes.
  Return type: | list of `NXOpen.Die.HoleChildBuilder`

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## GetHoleAttributes

`HoleParentBuilder.``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, depthTitle, counterBoreDiameterTitle) 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. depthTitle is a str. Title for depth attribute. counterBoreDiameterTitle is a str. Title for counter bore diameter attribute.

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## GetPadAttributes

`HoleParentBuilder.``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”)

## SetHoleAttributes

`HoleParentBuilder.``SetHoleAttributes`

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

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

  Parameters:

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

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## SetPadAttributes

`HoleParentBuilder.``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”)

## Validate

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