BurringInsertBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# BurringInsertBuilder Class

class `NXOpen.Tooling.``BurringInsertBuilder`

  Bases: `NXOpen.Builder`

  Progressive Die Wizard builder to design burring punch and die insert

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

  Default values.

  Property | Value
  --- | ---
  ArcRadius.Value | 0 (millimeters part), 0 (inches part)
  BurringDirection | BurringDownwards
  CircularOrNonCircular | Circular
  DesignOption | BurringPunch
  EndValue.Value | 0 (millimeters part), 0 (inches part)
  ParentPart | DieBase
  PlateClearanceFirst | 0
  PlateClearanceSecond | 0
  PlateClearanceThird | 0
  PunchHeadHeight.Value | 0 (millimeters part), 0 (inches part)
  StartValue.Value | 0 (millimeters part), 0 (inches part)
  UsePlateClearanceFirst | 0
  UsePlateClearanceSecond | 0
  UsePlateClearanceThird | 0

  New in version NX8.0.0.

# Properties

Property | Description
--- | ---
ArcRadius | Returns the arc radius value.
BlankProfile | Returns the blank profile to extrude the punch or die.
BurringDirection | Returns or sets the burring direction downwards or upwards.
BurringPunchType | Returns or sets the burring punch type to create.
CircularOrNonCircular | Returns or sets the circular or non circular type.
DesignOption | Returns or sets the design option to design punch or die.
EndValue | Returns the end height value of blank.
ParentPart | Returns or sets the parent part to create blank.
ParentPartName | Returns or sets the parent part name to create blank.
PlateClearanceFirst | Returns or sets the value of plate clearance first.
PlateClearanceSecond | Returns or sets the value of plate clearance second.
PlateClearanceThird | Returns or sets the value of plate clearance third.
PunchHeadHeight | Returns the punch head height value of blank.
PunchOrDieToEdit | Returns the punch or die to edit
RenameComponent | Returns or sets the option whether rename component.
SelectFaces | Returns the burring face of burring region.
StartValue | Returns the start height value of blank.
Tag | Returns the Tag for this object.
UsePlateClearanceFirst | Returns or sets the option to use plate clearance first.
UsePlateClearanceSecond | Returns or sets the option to use plate clearance second.
UsePlateClearanceThird | Returns or sets the option to use plate clearance third.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CreateNewComponent | Create new component.
DeletePunchOrDieComponent | The action to delete the selected punch or die component
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.
RevolveSketchedCurve | Extract burring region.
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

BurringInsertBuilderBurringDirections Enumeration | Specifies the burring direction.
BurringInsertBuilderBurringPunchTypes Enumeration | Specifies the burring punch type.
BurringInsertBuilderCircularOrNonCircularType Enumeration | Specifies the circular or non-circular type.
BurringInsertBuilderDesignOptions Enumeration | Specifies the design type.
BurringInsertBuilderParentTypes Enumeration | Specifies the parent part type.

# Property Detail

## ArcRadius

`BurringInsertBuilder.``ArcRadius`

  Returns the arc radius value.

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

  Getter Method

  Signature `ArcRadius`

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

  New in version NX8.0.0.

  License requirements: None.

## BlankProfile

`BurringInsertBuilder.``BlankProfile`

  Returns the blank profile to extrude the punch or die.

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

  Getter Method

  Signature `BlankProfile`

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

  New in version NX8.0.0.

  License requirements: None.

## BurringDirection

`BurringInsertBuilder.``BurringDirection`

  Returns or sets the burring direction downwards or upwards.

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

  Getter Method

  Signature `BurringDirection`

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

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `BurringDirection`

  Parameters: | burringDirection (`NXOpen.Tooling.BurringInsertBuilderBurringDirections`) –

  New in version NX8.0.0.

  License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

## BurringPunchType

`BurringInsertBuilder.``BurringPunchType`

  Returns or sets the burring punch type to create.

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

  Getter Method

  Signature `BurringPunchType`

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

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `BurringPunchType`

  Parameters: | burringPunchType (`NXOpen.Tooling.BurringInsertBuilderBurringPunchTypes`) –

  New in version NX8.0.0.

  License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

## CircularOrNonCircular

`BurringInsertBuilder.``CircularOrNonCircular`

  Returns or sets the circular or non circular type.

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

  Getter Method

  Signature `CircularOrNonCircular`

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

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CircularOrNonCircular`

  Parameters: | circularOrNonCircular (`NXOpen.Tooling.BurringInsertBuilderCircularOrNonCircularType`) –

  New in version NX10.0.0.

  License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

## DesignOption

`BurringInsertBuilder.``DesignOption`

  Returns or sets the design option to design punch or die.

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

  Getter Method

  Signature `DesignOption`

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

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DesignOption`

  Parameters: | designOption (`NXOpen.Tooling.BurringInsertBuilderDesignOptions`) –

  New in version NX8.0.0.

  License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

## EndValue

`BurringInsertBuilder.``EndValue`

  Returns the end height value of blank.

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

  Getter Method

  Signature `EndValue`

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

  New in version NX8.0.0.

  License requirements: None.

## ParentPart

`BurringInsertBuilder.``ParentPart`

  Returns or sets the parent part to create blank.

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

  Getter Method

  Signature `ParentPart`

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

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ParentPart`

  Parameters: | parentPart (`NXOpen.Tooling.BurringInsertBuilderParentTypes`) –

  New in version NX8.0.0.

  License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

## ParentPartName

`BurringInsertBuilder.``ParentPartName`

  Returns or sets the parent part name to create blank.

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

  Getter Method

  Signature `ParentPartName`

  Returns: | Retruns parent part name
  Return type: | str

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ParentPartName`

  Parameters: | parentPart (str) – Specifies the parent part name

  New in version NX8.0.0.

  License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

## PlateClearanceFirst

`BurringInsertBuilder.``PlateClearanceFirst`

  Returns or sets the value of plate clearance first.

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

  Getter Method

  Signature `PlateClearanceFirst`

  Returns: |
  Return type: | float

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PlateClearanceFirst`

  Parameters: | plateClearanceFirst (float) –

  New in version NX8.0.0.

  License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

## PlateClearanceSecond

`BurringInsertBuilder.``PlateClearanceSecond`

  Returns or sets the value of plate clearance second.

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

  Getter Method

  Signature `PlateClearanceSecond`

  Returns: |
  Return type: | float

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PlateClearanceSecond`

  Parameters: | plateClearanceSecond (float) –

  New in version NX8.0.0.

  License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

## PlateClearanceThird

`BurringInsertBuilder.``PlateClearanceThird`

  Returns or sets the value of plate clearance third.

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

  Getter Method

  Signature `PlateClearanceThird`

  Returns: |
  Return type: | float

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PlateClearanceThird`

  Parameters: | plateClearanceThird (float) –

  New in version NX8.0.0.

  License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

## PunchHeadHeight

`BurringInsertBuilder.``PunchHeadHeight`

  Returns the punch head height value of blank.

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

  Getter Method

  Signature `PunchHeadHeight`

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

  New in version NX8.0.0.

  License requirements: None.

## PunchOrDieToEdit

`BurringInsertBuilder.``PunchOrDieToEdit`

  Returns the punch or die to edit

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

  Getter Method

  Signature `PunchOrDieToEdit`

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

  New in version NX8.0.0.

  License requirements: None.

## RenameComponent

`BurringInsertBuilder.``RenameComponent`

  Returns or sets the option whether rename component.

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

  Getter Method

  Signature `RenameComponent`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RenameComponent`

  Parameters: | renameComponent (bool) –

  New in version NX8.0.0.

  License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

## SelectFaces

`BurringInsertBuilder.``SelectFaces`

  Returns the burring face of burring region.

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

  Getter Method

  Signature `SelectFaces`

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

  New in version NX8.0.0.

  License requirements: None.

## StartValue

`BurringInsertBuilder.``StartValue`

  Returns the start height value of blank.

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

  Getter Method

  Signature `StartValue`

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

  New in version NX8.0.0.

  License requirements: None.

## UsePlateClearanceFirst

`BurringInsertBuilder.``UsePlateClearanceFirst`

  Returns or sets the option to use plate clearance first.

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

  Getter Method

  Signature `UsePlateClearanceFirst`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UsePlateClearanceFirst`

  Parameters: | usePlateClearanceFirst (bool) –

  New in version NX8.0.0.

  License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

## UsePlateClearanceSecond

`BurringInsertBuilder.``UsePlateClearanceSecond`

  Returns or sets the option to use plate clearance second.

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

  Getter Method

  Signature `UsePlateClearanceSecond`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UsePlateClearanceSecond`

  Parameters: | usePlateClearanceSecond (bool) –

  New in version NX8.0.0.

  License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

## UsePlateClearanceThird

`BurringInsertBuilder.``UsePlateClearanceThird`

  Returns or sets the option to use plate clearance third.

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

  Getter Method

  Signature `UsePlateClearanceThird`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UsePlateClearanceThird`

  Parameters: | usePlateClearanceThird (bool) –

  New in version NX8.0.0.

  License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

# Method Detail

## CreateNewComponent

`BurringInsertBuilder.``CreateNewComponent`

  Create new component.

  Signature `CreateNewComponent(parentTag, origin)`

  Parameters:

  - parentTag (`NXOpen.TaggedObject`) – the parent part
  - origin (`NXOpen.Point3d`) – the origin point to add

  Returns: | the new part instance
  Return type: | `NXOpen.TaggedObject`

  New in version NX8.0.0.

  License requirements: None.

## DeletePunchOrDieComponent

`BurringInsertBuilder.``DeletePunchOrDieComponent`

  The action to delete the selected punch or die component

  Signature `DeletePunchOrDieComponent()`

  New in version NX8.0.0.

  License requirements: None.

## RevolveSketchedCurve

`BurringInsertBuilder.``RevolveSketchedCurve`

  Extract burring region.

  Signature `RevolveSketchedCurve()`

  New in version NX8.0.0.

  License requirements: None.

## Validate

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