UndersizeBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# UndersizeBuilder Class

class `NXOpen.Tooling.``UndersizeBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Tooling.UndersizeBuilder`

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

  Default values.

  Property | Value
  --- | ---
  Angle.Value | 90 (millimeters part), 90 (inches part)
  OrbitSize.Value | 0.05 (millimeters part), 0.002 (inches part)
  OrbitType | Circular
  SparkGap.Value | 0.05 (millimeters part), 0.002 (inches part)

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
Angle | Returns the angle which is between two distribution electrodes
ElectrodeBodies | Returns the electrode body to do undersize
OrbitPointList | Returns the points to be used as copy positions to undersize electrode
OrbitSize | Returns the orbit size which determines the radius of the distribution circle
OrbitType | Returns or sets the orbit type
PointSpecify | Returns or sets the reference point which is the center of the distribution circle
SelectElectrodeBlock | Returns the body will be used as electrode body to do undersize
SelectPoints | Returns the points will be used as copy positions to undersize electrode
SparkGap | Returns the spark gap which is the gap between the electrode head and the work piece
Tag | Returns the Tag for this object.

# 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

UndersizeBuilderOrbit Enumeration | Represents the orbit type

# Property Detail

## Angle

`UndersizeBuilder.``Angle`

  Returns the angle which is between two distribution electrodes

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

  Getter Method

  Signature `Angle`

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

  New in version NX6.0.0.

  License requirements: None.

## ElectrodeBodies

`UndersizeBuilder.``ElectrodeBodies`

  Returns the electrode body to do undersize

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

  Getter Method

  Signature `ElectrodeBodies`

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

  New in version NX10.0.0.

  License requirements: None.

## OrbitPointList

`UndersizeBuilder.``OrbitPointList`

  Returns the points to be used as copy positions to undersize electrode

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

  Getter Method

  Signature `OrbitPointList`

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

  New in version NX10.0.0.

  License requirements: None.

## OrbitSize

`UndersizeBuilder.``OrbitSize`

  Returns the orbit size which determines the radius of the distribution circle

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

  Getter Method

  Signature `OrbitSize`

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

  New in version NX6.0.0.

  License requirements: None.

## OrbitType

`UndersizeBuilder.``OrbitType`

  Returns or sets the orbit type

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

  Getter Method

  Signature `OrbitType`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OrbitType`

  Parameters: | orbitType (`NXOpen.Tooling.UndersizeBuilderOrbit`) –

  New in version NX6.0.0.

  License requirements: None.

## PointSpecify

`UndersizeBuilder.``PointSpecify`

  Returns or sets the reference point which is the center of the distribution circle

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

  Getter Method

  Signature `PointSpecify`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PointSpecify`

  Parameters: | pointSpecify (`NXOpen.Point`) –

  New in version NX6.0.0.

  License requirements: None.

## SelectElectrodeBlock

`UndersizeBuilder.``SelectElectrodeBlock`

  Returns the body will be used as electrode body to do undersize

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

  Getter Method

  Signature `SelectElectrodeBlock`

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

  New in version NX6.0.0.

  Deprecated since version NX10.0.0: Use `Tooling.UndersizeBuilder.ElectrodeBodies()` instead.

  License requirements: None.

## SelectPoints

`UndersizeBuilder.``SelectPoints`

  Returns the points will be used as copy positions to undersize electrode

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

  Getter Method

  Signature `SelectPoints`

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

  New in version NX6.0.0.

  Deprecated since version NX10.0.0: Use `Tooling.UndersizeBuilder.OrbitPointList()` instead.

  License requirements: None.

## SparkGap

`UndersizeBuilder.``SparkGap`

  Returns the spark gap which is the gap between the electrode head and the work piece

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

  Getter Method

  Signature `SparkGap`

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

  New in version NX6.0.0.

  License requirements: None.

# Method Detail

## Validate

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