KeywayChildBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# KeywayChildBuilder Class

class `NXOpen.Die.``KeywayChildBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a Die Keyway Child 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 the keyway.
Depth | Returns or sets the depth of the keyway.
DesignStatus | Returns or sets the design status of the keyway, if true the keyway will be built into the model, if false it will not.
DisplayStatus | Returns or sets the display status of the keyway, if true input data to the keyway will be displayed, if false the input data will not be displayed.
Length | Returns or sets the length of the keyway.
Location | Returns or sets the location of the keyway.
MinimumRibHeight | Returns or sets the minimum rib height of the keyway.
Offset | Returns or sets the offset of the keyway.
PadHeight | Returns or sets the pad height of the keyway.
PadWidth | Returns or sets the pad width of the keyway.
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
PlacementOffset | Returns or sets the placement offset of the keyway.
Plane | Returns or sets the plane of the keyway.
ReverseOrientation | Returns or sets the value to reverse the orientation of the orientation plane, if true the keyway orientation normal will be reversed, if false it will not.
RunoffDepth | Returns or sets the runoff depth of the keyway.
RunoffDiameter | Returns or sets the runoff diameter of the keyway.
RunoffLength | Returns or sets the runoff length of the keyway.
RunoffType | Returns or sets the runoff type of the keyway.
RunoffWidth | Returns or sets the runoff width of the keyway.
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Width | Returns or sets the width of the keyway.

# 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.
GetPadAttributes | Gets the pad attributes, note existance of attributes depends on usage in main feature.
GetSlotAttributes | Gets the slot 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.
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
SetSlotAttributes | Sets the slot attributes, note existance of attributes depends on usage in main feature.
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

KeywayChildBuilderLocationOption Enumeration | Settings for the location of the keyway.
KeywayChildBuilderRunoffTypeOption Enumeration | Settings for the runoff type of the keyway.

# Property Detail

## BuildStatus

`KeywayChildBuilder.``BuildStatus`

  Returns the build status of the keyway.

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

  Getter Method

  Signature `BuildStatus`

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

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## Depth

`KeywayChildBuilder.``Depth`

  Returns or sets the depth of the keyway.

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

  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

`KeywayChildBuilder.``DesignStatus`

  Returns or sets the design status of the keyway, if true the keyway will be built into the model, if false it 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”)

## DisplayStatus

`KeywayChildBuilder.``DisplayStatus`

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

## Length

`KeywayChildBuilder.``Length`

  Returns or sets the length of the keyway.

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

  Getter Method

  Signature `Length`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `Length`

  Parameters: | length (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## Location

`KeywayChildBuilder.``Location`

  Returns or sets the location of the keyway.

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

  Getter Method

  Signature `Location`

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

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `Location`

  Parameters: | location (`NXOpen.Die.KeywayChildBuilderLocationOption`) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## MinimumRibHeight

`KeywayChildBuilder.``MinimumRibHeight`

  Returns or sets the minimum rib height of the keyway.

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

  Getter Method

  Signature `MinimumRibHeight`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `MinimumRibHeight`

  Parameters: | minimumRibHeight (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## Offset

`KeywayChildBuilder.``Offset`

  Returns or sets the offset of the keyway.

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

  Getter Method

  Signature `Offset`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `Offset`

  Parameters: | offset (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## PadHeight

`KeywayChildBuilder.``PadHeight`

  Returns or sets the pad height of the keyway.

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

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

## PadWidth

`KeywayChildBuilder.``PadWidth`

  Returns or sets the pad width of the keyway.

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

  Getter Method

  Signature `PadWidth`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `PadWidth`

  Parameters: | padWidth (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## PlacementOffset

`KeywayChildBuilder.``PlacementOffset`

  Returns or sets the placement offset of the keyway.

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

  Getter Method

  Signature `PlacementOffset`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `PlacementOffset`

  Parameters: | placementOffset (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## Plane

`KeywayChildBuilder.``Plane`

  Returns or sets the plane of the keyway.

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

  Getter Method

  Signature `Plane`

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

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `Plane`

  Parameters: | plane (`NXOpen.IOrientation`) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## ReverseOrientation

`KeywayChildBuilder.``ReverseOrientation`

  Returns or sets the value to reverse the orientation of the orientation plane, if true the keyway orientation normal will be reversed, if false it will not.

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

  Getter Method

  Signature `ReverseOrientation`

  Returns: |
  Return type: | bool

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `ReverseOrientation`

  Parameters: | reverseOrientation (bool) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## RunoffDepth

`KeywayChildBuilder.``RunoffDepth`

  Returns or sets the runoff depth of the keyway.

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

  Getter Method

  Signature `RunoffDepth`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `RunoffDepth`

  Parameters: | runoffDepth (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## RunoffDiameter

`KeywayChildBuilder.``RunoffDiameter`

  Returns or sets the runoff diameter of the keyway.

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

  Getter Method

  Signature `RunoffDiameter`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `RunoffDiameter`

  Parameters: | runoffDiameter (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## RunoffLength

`KeywayChildBuilder.``RunoffLength`

  Returns or sets the runoff length of the keyway.

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

  Getter Method

  Signature `RunoffLength`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `RunoffLength`

  Parameters: | runoffLength (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## RunoffType

`KeywayChildBuilder.``RunoffType`

  Returns or sets the runoff type of the keyway.

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

  Getter Method

  Signature `RunoffType`

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

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `RunoffType`

  Parameters: | runoffType (`NXOpen.Die.KeywayChildBuilderRunoffTypeOption`) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## RunoffWidth

`KeywayChildBuilder.``RunoffWidth`

  Returns or sets the runoff width of the keyway.

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

  Getter Method

  Signature `RunoffWidth`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `RunoffWidth`

  Parameters: | runoffWidth (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## Width

`KeywayChildBuilder.``Width`

  Returns or sets the width of the keyway.

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

  Getter Method

  Signature `Width`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `Width`

  Parameters: | width (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

# Method Detail

## GetPadAttributes

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

## GetSlotAttributes

`KeywayChildBuilder.``GetSlotAttributes`

  Gets the slot attributes, note existance of attributes depends on usage in main feature.

  Signature `GetSlotAttributes()`

  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 slot faces.

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## SetPadAttributes

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

## SetSlotAttributes

`KeywayChildBuilder.``SetSlotAttributes`

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

  Signature `SetSlotAttributes(title, value, color)`

  Parameters:

  - title (str) – Title for attribute.
  - value (str) – Value of attribute.
  - color (int) – Color of slot faces.

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## Validate

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