HeelpostBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# HeelpostBuilder Class

class `NXOpen.Die.``HeelpostBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Die.HeelpostBuilder` builder

  To create a new instance of this class, use `NXOpen.Die.DieCollection.Heelpost()`

  Default values.

  Property | Value
  --- | ---
  AngleTolerance | 0.5
  BaseOffset.Value | 0 (millimeters part), 0 (inches part)
  Center.InputType | SelectLocation
  CreateFloor | 0
  Diameter.Value | 50 (millimeters part), 2 (inches part)
  DistanceTolerance | 0.0254
  FloorThickness.Value | 60 (millimeters part), 1.4 (inches part)
  Height.Value | 300 (millimeters part), 12 (inches part)
  Length.Value | 150 (millimeters part), 6 (inches part)
  LocationOffset.Value | 0 (millimeters part), 0 (inches part)
  PadOffset.Value | 0 (millimeters part), 0 (inches part)
  PadThickness.Value | 60 (millimeters part), 10.4 (inches part)
  ReliefDepth.Value | 5 (millimeters part), 0.2 (inches part)
  ReliefWidth.Value | 5 (millimeters part), 0.2 (inches part)
  UsePercent | 0
  WallACreate | 1
  WallAOffset.Value | 0 (millimeters part), 0 (inches part)
  WallARelief | 0
  WallAThickness.Value | 30 (millimeters part), 1.2 (inches part)
  WallBCreate | 1
  WallBOffset.Value | 0 (millimeters part), 0 (inches part)
  WallBRelief | 0
  WallBThickness.Value | 30 (millimeters part), 1.2 (inches part)
  WallCCreate | 1
  WallCOffset.Value | 0 (millimeters part), 0 (inches part)
  WallCRelief | 0
  WallCThickness.Value | 30 (millimeters part), 1.2 (inches part)
  WallDCreate | 1
  WallDOffset.Value | 0 (millimeters part), 0 (inches part)
  WallDRelief | 0
  WallDThickness.Value | 30 (millimeters part), 1.2 (inches part)
  WallPercentage.Value | 40
  Width.Value | 150 (millimeters part), 6 (inches part)
  XOffset.Value | 0 (millimeters part), 0 (inches part)
  YOffset.Value | 0 (millimeters part), 0 (inches part)

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
AngleTolerance | Returns or sets the angle tolerance
BaseOffset | Returns the offset to apply to the given base before building the heelpost
BaseOrientation | Returns the base of the heelpost
Center | Returns the location (center) for the heelpost
CreateFloor | Returns or sets the value (true or false) to decide if the floor of the post should be created
Diameter | Returns the diameter of the guide pin hole
DieCenterlineCoordinateSystem | Returns the die centerline coordinate system for orienting the heelpost
DistanceTolerance | Returns or sets the distance tolerance
FloorThickness | Returns the floor thickness
Height | Returns the height from the selected base orientation to the origin of the pad orientation, if the pad orientation is not specified.
HoleAttributes | Returns the hole attributes
HoleDiameterAttributes | Returns the hole diameter attributes (only the title is used)
Length | Returns the length with respect to the coordinate system
LocationOffset | Returns the offset value to apply in the offset direction to find the heelpost center
OffsetDirection | Returns the direction to apply to the location to determine the center of the heelpost
PadAttributes | Returns the pad attributes
PadOffset | Returns the offset value to apply to the pad orientation before building the heelpost
PadOrientation | Returns the orientation at the top of the heelpost
PadThickness | Returns the pad thickness at the top of the post
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
ReliefAttributes | Returns the relief attributes
ReliefDepth | Returns the relief depth
ReliefWidth | Returns the relief width
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Target | Returns the target solid the heelpost will be united with
Type | Returns or sets the post type
UsePercent | Returns or sets the value (true or false) to decide how to determine the wall thickness.
WallACreate | Returns or sets the value (true or false) to decide if the A wall should be created
WallAOffset | Returns the offset from the outside to be applied to the A wall
WallARelief | Returns or sets the value (true or false) to decide if relief should be created at the top of the A wall
WallAThickness | Returns the A wall thickness
WallBCreate | Returns or sets the value (true or false) to decide if the B wall should be created
WallBOffset | Returns the offset from the outside to be applied to the B wall
WallBRelief | Returns or sets the value (true or false) to decide if relief should be created at the top of the B wall
WallBThickness | Returns the B wall thickness
WallCCreate | Returns or sets the value (true or false) to decide if the C wall should be created
WallCOffset | Returns the offset from the outside to be applied to the C wall
WallCRelief | Returns or sets the value (true or false) to decide if relief should be created at the top of the C wall
WallCThickness | Returns the C wall thickness
WallDCreate | Returns or sets the value (true or false) to decide if the D wall should be created
WallDOffset | Returns the offset from the outside to be applied to the D wall
WallDRelief | Returns or sets the value (true or false) to decide if relief should be created at the top of the D wall
WallDThickness | Returns the D wall thickness
WallPercentage | Returns the percentage of the post area to be applied to determine the wall thicknesses
Width | Returns the width with respect to the coordinate system
XOffset | Returns the offset applied in the X direction to determine the hole center
YOffset | Returns the offset applied in the Y direction to determine the hole center

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
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.
GetFeature | Returns the feature currently being edited by this builder.
GetObject | Returns the object currently being edited by this builder.
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
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.

# Enumerations

HeelpostBuilderTypes Enumeration | Heelpost types

# Property Detail

## AngleTolerance

`HeelpostBuilder.``AngleTolerance`

  Returns or sets the angle tolerance

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

  Getter Method

  Signature `AngleTolerance`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AngleTolerance`

  Parameters: | angleTolerance (float) –

  New in version NX6.0.0.

  License requirements: ug_die_design (“Die Design”)

## BaseOffset

`HeelpostBuilder.``BaseOffset`

  Returns the offset to apply to the given base before building the heelpost

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

  Getter Method

  Signature `BaseOffset`

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

  New in version NX6.0.0.

  License requirements: None.

## BaseOrientation

`HeelpostBuilder.``BaseOrientation`

  Returns the base of the heelpost

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

  Getter Method

  Signature `BaseOrientation`

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

  New in version NX6.0.0.

  License requirements: None.

## Center

`HeelpostBuilder.``Center`

  Returns the location (center) for the heelpost

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

  Getter Method

  Signature `Center`

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

  New in version NX6.0.0.

  License requirements: None.

## CreateFloor

`HeelpostBuilder.``CreateFloor`

  Returns or sets the value (true or false) to decide if the floor of the post should be created

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

  Getter Method

  Signature `CreateFloor`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CreateFloor`

  Parameters: | createFloor (bool) –

  New in version NX6.0.0.

  License requirements: ug_die_design (“Die Design”)

## Diameter

`HeelpostBuilder.``Diameter`

  Returns the diameter of the guide pin hole

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

  Getter Method

  Signature `Diameter`

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

  New in version NX6.0.0.

  License requirements: None.

## DieCenterlineCoordinateSystem

`HeelpostBuilder.``DieCenterlineCoordinateSystem`

  Returns the die centerline coordinate system for orienting the heelpost

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

  Getter Method

  Signature `DieCenterlineCoordinateSystem`

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

  New in version NX6.0.0.

  License requirements: None.

## DistanceTolerance

`HeelpostBuilder.``DistanceTolerance`

  Returns or sets the distance tolerance

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

  Getter Method

  Signature `DistanceTolerance`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DistanceTolerance`

  Parameters: | distanceTolerance (float) –

  New in version NX6.0.0.

  License requirements: ug_die_design (“Die Design”)

## FloorThickness

`HeelpostBuilder.``FloorThickness`

  Returns the floor thickness

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

  Getter Method

  Signature `FloorThickness`

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

  New in version NX6.0.0.

  License requirements: None.

## Height

`HeelpostBuilder.``Height`

  Returns the height from the selected base orientation to the origin of the pad orientation, if the pad orientation is not specified.

  This is before application of any specified base and pad offsets.

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

  Getter Method

  Signature `Height`

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

  New in version NX6.0.0.

  License requirements: None.

## HoleAttributes

`HeelpostBuilder.``HoleAttributes`

  Returns the hole attributes

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

  Getter Method

  Signature `HoleAttributes`

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

  New in version NX6.0.0.

  License requirements: None.

## HoleDiameterAttributes

`HeelpostBuilder.``HoleDiameterAttributes`

  Returns the hole diameter attributes (only the title is used)

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

  Getter Method

  Signature `HoleDiameterAttributes`

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

  New in version NX6.0.0.

  License requirements: None.

## Length

`HeelpostBuilder.``Length`

  Returns the length with respect to the coordinate system

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

  Getter Method

  Signature `Length`

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

  New in version NX6.0.0.

  License requirements: None.

## LocationOffset

`HeelpostBuilder.``LocationOffset`

  Returns the offset value to apply in the offset direction to find the heelpost center

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

  Getter Method

  Signature `LocationOffset`

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

  New in version NX6.0.0.

  License requirements: None.

## OffsetDirection

`HeelpostBuilder.``OffsetDirection`

  Returns the direction to apply to the location to determine the center of the heelpost

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

  Getter Method

  Signature `OffsetDirection`

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

  New in version NX6.0.0.

  License requirements: None.

## PadAttributes

`HeelpostBuilder.``PadAttributes`

  Returns the pad attributes

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

  Getter Method

  Signature `PadAttributes`

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

  New in version NX6.0.0.

  License requirements: None.

## PadOffset

`HeelpostBuilder.``PadOffset`

  Returns the offset value to apply to the pad orientation before building the heelpost

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

  Getter Method

  Signature `PadOffset`

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

  New in version NX6.0.0.

  License requirements: None.

## PadOrientation

`HeelpostBuilder.``PadOrientation`

  Returns the orientation at the top of the heelpost

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

  Getter Method

  Signature `PadOrientation`

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

  New in version NX6.0.0.

  License requirements: None.

## PadThickness

`HeelpostBuilder.``PadThickness`

  Returns the pad thickness at the top of the post

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

  Getter Method

  Signature `PadThickness`

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

  New in version NX6.0.0.

  License requirements: None.

## ReliefAttributes

`HeelpostBuilder.``ReliefAttributes`

  Returns the relief attributes

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

  Getter Method

  Signature `ReliefAttributes`

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

  New in version NX6.0.0.

  License requirements: None.

## ReliefDepth

`HeelpostBuilder.``ReliefDepth`

  Returns the relief depth

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

  Getter Method

  Signature `ReliefDepth`

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

  New in version NX6.0.0.

  License requirements: None.

## ReliefWidth

`HeelpostBuilder.``ReliefWidth`

  Returns the relief width

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

  Getter Method

  Signature `ReliefWidth`

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

  New in version NX6.0.0.

  License requirements: None.

## Target

`HeelpostBuilder.``Target`

  Returns the target solid the heelpost will be united with

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

  Getter Method

  Signature `Target`

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

  New in version NX6.0.0.

  License requirements: None.

## Type

`HeelpostBuilder.``Type`

  Returns or sets the post type

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

  Getter Method

  Signature `Type`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Type`

  Parameters: | type (`NXOpen.Die.HeelpostBuilderTypes`) –

  New in version NX6.0.0.

  License requirements: ug_die_design (“Die Design”)

## UsePercent

`HeelpostBuilder.``UsePercent`

  Returns or sets the value (true or false) to decide how to determine the wall thickness.

  True will evaluate each wall based on the total area of the post

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

  Getter Method

  Signature `UsePercent`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UsePercent`

  Parameters: | usePercent (bool) –

  New in version NX6.0.0.

  License requirements: ug_die_design (“Die Design”)

## WallACreate

`HeelpostBuilder.``WallACreate`

  Returns or sets the value (true or false) to decide if the “A” wall should be created

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

  Getter Method

  Signature `WallACreate`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `WallACreate`

  Parameters: | wallACreate (bool) –

  New in version NX6.0.0.

  License requirements: ug_die_design (“Die Design”)

## WallAOffset

`HeelpostBuilder.``WallAOffset`

  Returns the offset from the outside to be applied to the “A” wall

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

  Getter Method

  Signature `WallAOffset`

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

  New in version NX6.0.0.

  License requirements: None.

## WallARelief

`HeelpostBuilder.``WallARelief`

  Returns or sets the value (true or false) to decide if relief should be created at the top of the “A” wall

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

  Getter Method

  Signature `WallARelief`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `WallARelief`

  Parameters: | wallARelief (bool) –

  New in version NX6.0.0.

  License requirements: ug_die_design (“Die Design”)

## WallAThickness

`HeelpostBuilder.``WallAThickness`

  Returns the “A” wall thickness

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

  Getter Method

  Signature `WallAThickness`

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

  New in version NX6.0.0.

  License requirements: None.

## WallBCreate

`HeelpostBuilder.``WallBCreate`

  Returns or sets the value (true or false) to decide if the “B” wall should be created

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

  Getter Method

  Signature `WallBCreate`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `WallBCreate`

  Parameters: | wallBCreate (bool) –

  New in version NX6.0.0.

  License requirements: ug_die_design (“Die Design”)

## WallBOffset

`HeelpostBuilder.``WallBOffset`

  Returns the offset from the outside to be applied to the “B wall

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

  Getter Method

  Signature `WallBOffset`

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

  New in version NX6.0.0.

  License requirements: None.

## WallBRelief

`HeelpostBuilder.``WallBRelief`

  Returns or sets the value (true or false) to decide if relief should be created at the top of the “B” wall

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

  Getter Method

  Signature `WallBRelief`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `WallBRelief`

  Parameters: | wallBRelief (bool) –

  New in version NX6.0.0.

  License requirements: ug_die_design (“Die Design”)

## WallBThickness

`HeelpostBuilder.``WallBThickness`

  Returns the “B” wall thickness

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

  Getter Method

  Signature `WallBThickness`

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

  New in version NX6.0.0.

  License requirements: None.

## WallCCreate

`HeelpostBuilder.``WallCCreate`

  Returns or sets the value (true or false) to decide if the “C” wall should be created

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

  Getter Method

  Signature `WallCCreate`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `WallCCreate`

  Parameters: | wallCCreate (bool) –

  New in version NX6.0.0.

  License requirements: ug_die_design (“Die Design”)

## WallCOffset

`HeelpostBuilder.``WallCOffset`

  Returns the offset from the outside to be applied to the “C” wall

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

  Getter Method

  Signature `WallCOffset`

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

  New in version NX6.0.0.

  License requirements: None.

## WallCRelief

`HeelpostBuilder.``WallCRelief`

  Returns or sets the value (true or false) to decide if relief should be created at the top of the “C” wall

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

  Getter Method

  Signature `WallCRelief`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `WallCRelief`

  Parameters: | wallCRelief (bool) –

  New in version NX6.0.0.

  License requirements: ug_die_design (“Die Design”)

## WallCThickness

`HeelpostBuilder.``WallCThickness`

  Returns the “C” wall thickness

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

  Getter Method

  Signature `WallCThickness`

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

  New in version NX6.0.0.

  License requirements: None.

## WallDCreate

`HeelpostBuilder.``WallDCreate`

  Returns or sets the value (true or false) to decide if the “D” wall should be created

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

  Getter Method

  Signature `WallDCreate`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `WallDCreate`

  Parameters: | wallDCreate (bool) –

  New in version NX6.0.0.

  License requirements: ug_die_design (“Die Design”)

## WallDOffset

`HeelpostBuilder.``WallDOffset`

  Returns the offset from the outside to be applied to the “D” wall

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

  Getter Method

  Signature `WallDOffset`

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

  New in version NX6.0.0.

  License requirements: None.

## WallDRelief

`HeelpostBuilder.``WallDRelief`

  Returns or sets the value (true or false) to decide if relief should be created at the top of the “D” wall

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

  Getter Method

  Signature `WallDRelief`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `WallDRelief`

  Parameters: | wallDRelief (bool) –

  New in version NX6.0.0.

  License requirements: ug_die_design (“Die Design”)

## WallDThickness

`HeelpostBuilder.``WallDThickness`

  Returns the “D” wall thickness

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

  Getter Method

  Signature `WallDThickness`

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

  New in version NX6.0.0.

  License requirements: None.

## WallPercentage

`HeelpostBuilder.``WallPercentage`

  Returns the percentage of the post area to be applied to determine the wall thicknesses

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

  Getter Method

  Signature `WallPercentage`

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

  New in version NX6.0.0.

  License requirements: None.

## Width

`HeelpostBuilder.``Width`

  Returns the width with respect to the coordinate system

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

  Getter Method

  Signature `Width`

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

  New in version NX6.0.0.

  License requirements: None.

## XOffset

`HeelpostBuilder.``XOffset`

  Returns the offset applied in the X direction to determine the hole center

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

  Getter Method

  Signature `XOffset`

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

  New in version NX6.0.0.

  License requirements: None.

## YOffset

`HeelpostBuilder.``YOffset`

  Returns the offset applied in the Y direction to determine the hole center

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

  Getter Method

  Signature `YOffset`

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

  New in version NX6.0.0.

  License requirements: None.

# Method Detail

## Validate

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