KeywayBuilder Class

class NXOpen.Die.KeywayBuilder

Bases: NXOpen.Features.FeatureBuilder

Represents a NXOpen.Die.KeywayBuilder builder

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

Default values.

Property Value
AngleTolerance 0.5
CreateWithPad 1
DeckThickness.Value 0 (millimeters part), 0 (inches part)
DistanceTolerance 0.0254 (millimeters part), 0.001 (inches part)
Location PositiveX
MinimumRibHeight.Value 200 (millimeters part), 8 (inches part)
Offset.Value 0 (millimeters part), 0 (inches part)
PadHeight.Value 65 (millimeters part), 2.6 (inches part)
PadWidth.Value 60 (millimeters part), 2.4 (inches part)
PlacementOffset.Value 0 (millimeters part), 0 (inches part)
RunoffDepth.Value 40 (millimeters part), 1.6 (inches part)
RunoffLength.Value 60 (millimeters part), 2.4 (inches part)
RunoffRadius.Value 30 (millimeters part), 1.2 (inches part)
RunoffWidth.Value 16 (millimeters part), 0.625 (inches part)
SlotDepth.Value 20 (millimeters part), 0.8 (inches part)
SlotLength.Value 100 (millimeters part), 4 (inches part)
SlotWidth.Value 25 (millimeters part), 1 (inches part)

New in version NX6.0.0.

Properties

Property Description
AngleTolerance Returns or sets the angle tolerance
BaseFlange Returns the closed loop section representing the base flange
BaseOrientation Returns the bottom orientation plane of the keyway pad
CreateWithPad Returns or sets the value, true or false) to decide if the pad should be created for the keyway
DeckThickness Returns the expression for the deck thickness
DieCenterlineCoordinateSystem Returns the die centerline coordinate system for orienting the keyway
DistanceTolerance Returns or sets the distance tolerance
InteriorProfile Returns the closed loop section representing the interior profile of the casting
Location Returns or sets the location for the keyway
MinimumRibHeight Returns the expression for the minimum rib height
Offset Returns the amount to offset the keyway perpendicular to the slot orientation
PadAttributes Returns the pad attributes
PadHeight Returns the expression for the pad height
PadWidth Returns the expression for the pad width
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 the amount to offset the base orientation
RunoffDepth Returns the expression for the runoff depth
RunoffLength Returns the expression for the runoff length
RunoffRadius Returns the expression for the runoff radius
RunoffWidth Returns the expression for the runoff width
SheetMetal Returns the sheet metal being formed by the casting.
SlotAttributes Returns the slot attributes
SlotDepth Returns the expression for the slot depth
SlotLength Returns the expression for the slot length
SlotWidth Returns the expression for the slot width
SurroundingPatchSurfaceFilename Returns or sets the surrounding patch surface filename
Tag Returns the Tag for this object.
Target Returns the target solid the keyway will be united with
Type Returns or sets the type of the keyway runoff

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

KeywayBuilderLocationType Enumeration Keyway location direction relative to the die centerline coordinate system
KeywayBuilderTypes Enumeration Keyway runoff types

Property Detail

AngleTolerance

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

BaseFlange

KeywayBuilder.BaseFlange

Returns the closed loop section representing the base flange

-------------------------------------

Getter Method

Signature BaseFlange

Returns:
Return type:NXOpen.Section

New in version NX6.0.0.

License requirements: None.

BaseOrientation

KeywayBuilder.BaseOrientation

Returns the bottom orientation plane of the keyway pad

-------------------------------------

Getter Method

Signature BaseOrientation

Returns:
Return type:NXOpen.Die.DiePlaneBuilder

New in version NX6.0.0.

License requirements: None.

CreateWithPad

KeywayBuilder.CreateWithPad

Returns or sets the value, true or false) to decide if the pad should be created for the keyway

-------------------------------------

Getter Method

Signature CreateWithPad

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CreateWithPad

Parameters:createWithPad (bool) –

New in version NX6.0.0.

License requirements: ug_die_design (“Die Design”)

DeckThickness

KeywayBuilder.DeckThickness

Returns the expression for the deck thickness

-------------------------------------

Getter Method

Signature DeckThickness

Returns:
Return type:NXOpen.Expression

New in version NX6.0.0.

License requirements: None.

DieCenterlineCoordinateSystem

KeywayBuilder.DieCenterlineCoordinateSystem

Returns the die centerline coordinate system for orienting the keyway

-------------------------------------

Getter Method

Signature DieCenterlineCoordinateSystem

Returns:
Return type:NXOpen.SelectCartesianCoordinateSystem

New in version NX6.0.0.

License requirements: None.

DistanceTolerance

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

InteriorProfile

KeywayBuilder.InteriorProfile

Returns the closed loop section representing the interior profile of the casting

-------------------------------------

Getter Method

Signature InteriorProfile

Returns:
Return type:NXOpen.Section

New in version NX6.0.0.

License requirements: None.

Location

KeywayBuilder.Location

Returns or sets the location for the keyway

-------------------------------------

Getter Method

Signature Location

Returns:
Return type:NXOpen.Die.KeywayBuilderLocationType

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Location

Parameters:location (NXOpen.Die.KeywayBuilderLocationType) –

New in version NX6.0.0.

License requirements: ug_die_design (“Die Design”)

MinimumRibHeight

KeywayBuilder.MinimumRibHeight

Returns the expression for the minimum rib height

-------------------------------------

Getter Method

Signature MinimumRibHeight

Returns:
Return type:NXOpen.Expression

New in version NX6.0.0.

License requirements: None.

Offset

KeywayBuilder.Offset

Returns the amount to offset the keyway perpendicular to the slot orientation

-------------------------------------

Getter Method

Signature Offset

Returns:
Return type:NXOpen.Expression

New in version NX6.0.0.

License requirements: None.

PadAttributes

KeywayBuilder.PadAttributes

Returns the pad attributes

-------------------------------------

Getter Method

Signature PadAttributes

Returns:
Return type:NXOpen.Die.DieAttributesBuilder

New in version NX6.0.0.

License requirements: None.

PadHeight

KeywayBuilder.PadHeight

Returns the expression for the pad height

-------------------------------------

Getter Method

Signature PadHeight

Returns:
Return type:NXOpen.Expression

New in version NX6.0.0.

License requirements: None.

PadWidth

KeywayBuilder.PadWidth

Returns the expression for the pad width

-------------------------------------

Getter Method

Signature PadWidth

Returns:
Return type:NXOpen.Expression

New in version NX6.0.0.

License requirements: None.

PlacementOffset

KeywayBuilder.PlacementOffset

Returns the amount to offset the base orientation

-------------------------------------

Getter Method

Signature PlacementOffset

Returns:
Return type:NXOpen.Expression

New in version NX6.0.0.

License requirements: None.

RunoffDepth

KeywayBuilder.RunoffDepth

Returns the expression for the runoff depth

-------------------------------------

Getter Method

Signature RunoffDepth

Returns:
Return type:NXOpen.Expression

New in version NX6.0.0.

License requirements: None.

RunoffLength

KeywayBuilder.RunoffLength

Returns the expression for the runoff length

-------------------------------------

Getter Method

Signature RunoffLength

Returns:
Return type:NXOpen.Expression

New in version NX6.0.0.

License requirements: None.

RunoffRadius

KeywayBuilder.RunoffRadius

Returns the expression for the runoff radius

-------------------------------------

Getter Method

Signature RunoffRadius

Returns:
Return type:NXOpen.Expression

New in version NX6.0.0.

License requirements: None.

RunoffWidth

KeywayBuilder.RunoffWidth

Returns the expression for the runoff width

-------------------------------------

Getter Method

Signature RunoffWidth

Returns:
Return type:NXOpen.Expression

New in version NX6.0.0.

License requirements: None.

SheetMetal

KeywayBuilder.SheetMetal

Returns the sheet metal being formed by the casting.

Used to measure the height.

-------------------------------------

Getter Method

Signature SheetMetal

Returns:
Return type:NXOpen.SelectNXObject

New in version NX6.0.0.

License requirements: None.

SlotAttributes

KeywayBuilder.SlotAttributes

Returns the slot attributes

-------------------------------------

Getter Method

Signature SlotAttributes

Returns:
Return type:NXOpen.Die.DieAttributesBuilder

New in version NX6.0.0.

License requirements: None.

SlotDepth

KeywayBuilder.SlotDepth

Returns the expression for the slot depth

-------------------------------------

Getter Method

Signature SlotDepth

Returns:
Return type:NXOpen.Expression

New in version NX6.0.0.

License requirements: None.

SlotLength

KeywayBuilder.SlotLength

Returns the expression for the slot length

-------------------------------------

Getter Method

Signature SlotLength

Returns:
Return type:NXOpen.Expression

New in version NX6.0.0.

License requirements: None.

SlotWidth

KeywayBuilder.SlotWidth

Returns the expression for the slot width

-------------------------------------

Getter Method

Signature SlotWidth

Returns:
Return type:NXOpen.Expression

New in version NX6.0.0.

License requirements: None.

Target

KeywayBuilder.Target

Returns the target solid the keyway will be united with

-------------------------------------

Getter Method

Signature Target

Returns:
Return type:NXOpen.SelectNXObject

New in version NX6.0.0.

License requirements: None.

Type

KeywayBuilder.Type

Returns or sets the type of the keyway runoff

-------------------------------------

Getter Method

Signature Type

Returns:
Return type:NXOpen.Die.KeywayBuilderTypes

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Type

Parameters:type (NXOpen.Die.KeywayBuilderTypes) –

New in version NX6.0.0.

License requirements: ug_die_design (“Die Design”)

Method Detail

Validate

KeywayBuilder.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.