DieDesPierceInsertBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# DieDesPierceInsertBuilder Class

class `NXOpen.Tooling.``DieDesPierceInsertBuilder`

  Bases: `NXOpen.Builder`

  Represents Die Design Pierce Insert builder.

  To create a new instance of this class, use `NXOpen.Tooling.AutoDieCollection.CreateDieDesPierceInsertBuilder()`

  Default values.

  Property | Value
  --- | ---
  ThicknessDirectionOption | Upper
  ThicknessValue | 0.8

  New in version NX8.0.0.

# Properties

Property | Description
--- | ---
BoudaryCurveSelection | Returns the boundary curve selection.
ClearanceCoefficient | Returns or sets the clearance coefficient value.
DiePenetration | Returns or sets the die penetration value.
DownToleranceForLength | Returns or sets the down tolerance value for length.
DownToleranceForWidth | Returns or sets the down tolerance value for width.
PunchPenetration | Returns or sets the punch penetration value.
Tag | Returns the Tag for this object.
ThicknessDirectionOption | Returns or sets the thickness direction option.
ThicknessValue | Returns or sets the thickness value.
ToleranceCoefficient | Returns or sets the tolerance coefficient value.
UpToleranceForLength | Returns or sets the up tolerance value for length.
UpToleranceForWidth | Returns or sets the up tolerance value for width.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
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.
GetObject | Returns the object currently being edited by this builder.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

DieDesPierceInsertBuilderDirection Enumeration | Represents the thickness direction.
DieDesPierceInsertBuilderHoleShapeTypes Enumeration | Represents the hole shape type.

# Property Detail

## BoudaryCurveSelection

`DieDesPierceInsertBuilder.``BoudaryCurveSelection`

  Returns the boundary curve selection.

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

  Getter Method

  Signature `BoudaryCurveSelection`

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

  New in version NX8.0.0.

  License requirements: None.

## ClearanceCoefficient

`DieDesPierceInsertBuilder.``ClearanceCoefficient`

  Returns or sets the clearance coefficient value.

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

  Getter Method

  Signature `ClearanceCoefficient`

  Returns: |
  Return type: | float

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ClearanceCoefficient`

  Parameters: | clearanceCoefficient (float) –

  New in version NX8.0.0.

  License requirements: ug_die_design (“Die Design”)

## DiePenetration

`DieDesPierceInsertBuilder.``DiePenetration`

  Returns or sets the die penetration value.

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

  Getter Method

  Signature `DiePenetration`

  Returns: |
  Return type: | float

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DiePenetration`

  Parameters: | diePenetration (float) –

  New in version NX8.0.0.

  License requirements: ug_die_design (“Die Design”)

## DownToleranceForLength

`DieDesPierceInsertBuilder.``DownToleranceForLength`

  Returns or sets the down tolerance value for length.

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

  Getter Method

  Signature `DownToleranceForLength`

  Returns: |
  Return type: | float

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DownToleranceForLength`

  Parameters: | downToleranceForLength (float) –

  New in version NX8.0.0.

  License requirements: ug_die_design (“Die Design”)

## DownToleranceForWidth

`DieDesPierceInsertBuilder.``DownToleranceForWidth`

  Returns or sets the down tolerance value for width.

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

  Getter Method

  Signature `DownToleranceForWidth`

  Returns: |
  Return type: | float

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DownToleranceForWidth`

  Parameters: | downToleranceForWidth (float) –

  New in version NX8.0.0.

  License requirements: ug_die_design (“Die Design”)

## PunchPenetration

`DieDesPierceInsertBuilder.``PunchPenetration`

  Returns or sets the punch penetration value.

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

  Getter Method

  Signature `PunchPenetration`

  Returns: |
  Return type: | float

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PunchPenetration`

  Parameters: | punchPenetration (float) –

  New in version NX8.0.0.

  License requirements: ug_die_design (“Die Design”)

## ThicknessDirectionOption

`DieDesPierceInsertBuilder.``ThicknessDirectionOption`

  Returns or sets the thickness direction option.

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

  Getter Method

  Signature `ThicknessDirectionOption`

  Returns: |
  Return type: | `NXOpen.Tooling.DieDesPierceInsertBuilderDirection`

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ThicknessDirectionOption`

  Parameters: | thicknessDirectionOption (`NXOpen.Tooling.DieDesPierceInsertBuilderDirection`) –

  New in version NX8.0.0.

  License requirements: ug_die_design (“Die Design”)

## ThicknessValue

`DieDesPierceInsertBuilder.``ThicknessValue`

  Returns or sets the thickness value.

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

  Getter Method

  Signature `ThicknessValue`

  Returns: |
  Return type: | float

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ThicknessValue`

  Parameters: | thicknessValue (float) –

  New in version NX8.0.0.

  License requirements: ug_die_design (“Die Design”)

## ToleranceCoefficient

`DieDesPierceInsertBuilder.``ToleranceCoefficient`

  Returns or sets the tolerance coefficient value.

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

  Getter Method

  Signature `ToleranceCoefficient`

  Returns: |
  Return type: | float

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ToleranceCoefficient`

  Parameters: | toleranceCoefficient (float) –

  New in version NX8.0.0.

  License requirements: ug_die_design (“Die Design”)

## UpToleranceForLength

`DieDesPierceInsertBuilder.``UpToleranceForLength`

  Returns or sets the up tolerance value for length.

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

  Getter Method

  Signature `UpToleranceForLength`

  Returns: |
  Return type: | float

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UpToleranceForLength`

  Parameters: | upToleranceForLength (float) –

  New in version NX8.0.0.

  License requirements: ug_die_design (“Die Design”)

## UpToleranceForWidth

`DieDesPierceInsertBuilder.``UpToleranceForWidth`

  Returns or sets the up tolerance value for width.

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

  Getter Method

  Signature `UpToleranceForWidth`

  Returns: |
  Return type: | float

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UpToleranceForWidth`

  Parameters: | upToleranceForWidth (float) –

  New in version NX8.0.0.

  License requirements: ug_die_design (“Die Design”)

# Method Detail

## Validate

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