PierceHoleParentBuilder Class¶

class NXOpen.Die.PierceHoleParentBuilder¶

Bases: NXOpen.Features.FeatureBuilder

Represents a Pierce Hole Parent sub feature.

This sub feature is created via the main feature builder.

New in version NX4.0.0.

Properties¶

Property	Description
BreakerHoleDepth	Returns the breaker hole depth of pierce holes
BreakerHoleFactor	Returns the breaker hole factor of pierce holes
BreakerHoleOffset	Returns the breaker hole offset of pierce holes
BuildStatus	Returns the build status of pierce holes
CircularSlugHole	Returns or sets the circular slug hole switch of pierce holes
CommonSlugHole	Returns or sets the common slug hole switch of pierce holes
Depth	Returns the depth of pierce holes
DesignStatus	Returns or sets the design status of pierce holes
Diameter	Returns the diameter of pierce holes
DieClearance	Returns the die clearance of pierce holes
DisplayHoles	Returns or sets the display holes option of pierce holes
DisplayStatus	Returns or sets the display status of pierce holes
Length	Returns the length of pierce holes
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
ProfileBlendRadius	Returns the profile blend radius of pierce holes
SlugHoleDiameterIncrement	Returns the slug hole diameter increment of pierce holes
SlugHoleOffset	Returns the slug hole offset of pierce holes
SurroundingPatchSurfaceFilename	Returns or sets the surrounding patch surface filename
Tag	Returns the Tag for this object.
Width	Returns the width of pierce holes

Methods¶

Method	Description
Commit	Commits any edits that have been applied to the builder.
CommitFeature	Commits the feature parameters and creates the feature
CreateChild	Creates a child pierce hole
DeleteChild	Deletes a child pierce hole
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetBreakerHoleAttributes	Gets the breaker hole attributes, note existance of attributes depends on usage in main feature
GetChildren	Outputs the pierce hole children
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.
GetHoleAttributes	Gets the hole attributes, note existance of attributes depends on usage in main feature
GetObject	Returns the object currently being edited by this builder.
GetSlugHoleAttributes	Gets the slug hole 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.
SetBreakerHoleAttributes	Sets the breaker hole attributes, note existance of attributes depends on usage in main feature
SetBreakerHoleDepth
SetBreakerHoleFactor
SetBreakerHoleOffset
SetDepth
SetDiameter
SetDieClearance
SetHoleAttributes	Sets the hole attributes, note existance of attributes depends on usage in main feature
SetLength
SetParentFeatureInternal	Set the parent features which would be internal or slaves to the feature being created or commited
SetProfileBlendRadius
SetSlugHoleAttributes	Sets the slug hole attributes, note existance of attributes depends on usage in main feature
SetSlugHoleDiameterIncrement
SetSlugHoleOffset
SetWidth
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.

Property Detail¶

BreakerHoleDepth¶

PierceHoleParentBuilder.BreakerHoleDepth¶

Returns the breaker hole depth of pierce holes

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

Getter Method

Signature BreakerHoleDepth

Returns:
Return type:	`NXOpen.Expression`

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

BreakerHoleFactor¶

PierceHoleParentBuilder.BreakerHoleFactor¶

Returns the breaker hole factor of pierce holes

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

Getter Method

Signature BreakerHoleFactor

Returns:
Return type:	`NXOpen.Expression`

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

BreakerHoleOffset¶

PierceHoleParentBuilder.BreakerHoleOffset¶

Returns the breaker hole offset of pierce holes

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

Getter Method

Signature BreakerHoleOffset

Returns:
Return type:	`NXOpen.Expression`

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

BuildStatus¶

PierceHoleParentBuilder.BuildStatus¶

Returns the build status of pierce holes

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

Getter Method

Signature BuildStatus

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

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

CircularSlugHole¶

PierceHoleParentBuilder.CircularSlugHole¶

Returns or sets the circular slug hole switch of pierce holes

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

Getter Method

Signature CircularSlugHole

Returns:
Return type:	bool

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

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

Setter Method

Signature CircularSlugHole

Parameters:	circularSlugHole (bool) –

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

CommonSlugHole¶

PierceHoleParentBuilder.CommonSlugHole¶

Returns or sets the common slug hole switch of pierce holes

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

Getter Method

Signature CommonSlugHole

Returns:
Return type:	bool

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

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

Setter Method

Signature CommonSlugHole

Parameters:	commonSlugHole (bool) –

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

Depth¶

PierceHoleParentBuilder.Depth¶

Returns the depth of pierce holes

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

Getter Method

Signature Depth

Returns:
Return type:	`NXOpen.Expression`

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

DesignStatus¶

PierceHoleParentBuilder.DesignStatus¶

Returns or sets the design status of pierce holes

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

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

Diameter¶

PierceHoleParentBuilder.Diameter¶

Returns the diameter of pierce holes

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

Getter Method

Signature Diameter

Returns:
Return type:	`NXOpen.Expression`

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

DieClearance¶

PierceHoleParentBuilder.DieClearance¶

Returns the die clearance of pierce holes

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

Getter Method

Signature DieClearance

Returns:
Return type:	`NXOpen.Expression`

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

DisplayHoles¶

PierceHoleParentBuilder.DisplayHoles¶

Returns or sets the display holes option of pierce holes

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

Getter Method

Signature DisplayHoles

Returns:
Return type:	bool

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

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

Setter Method

Signature DisplayHoles

Parameters:	displayPierceHoles (bool) –

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

DisplayStatus¶

PierceHoleParentBuilder.DisplayStatus¶

Returns or sets the display status of pierce holes

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

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¶

PierceHoleParentBuilder.Length¶

Returns the length of pierce holes

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

Getter Method

Signature Length

Returns:
Return type:	`NXOpen.Expression`

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

ProfileBlendRadius¶

PierceHoleParentBuilder.ProfileBlendRadius¶

Returns the profile blend radius of pierce holes

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

Getter Method

Signature ProfileBlendRadius

Returns:
Return type:	`NXOpen.Expression`

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

SlugHoleDiameterIncrement¶

PierceHoleParentBuilder.SlugHoleDiameterIncrement¶

Returns the slug hole diameter increment of pierce holes

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

Getter Method

Signature SlugHoleDiameterIncrement

Returns:
Return type:	`NXOpen.Expression`

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

SlugHoleOffset¶

PierceHoleParentBuilder.SlugHoleOffset¶

Returns the slug hole offset of pierce holes

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

Getter Method

Signature SlugHoleOffset

Returns:
Return type:	`NXOpen.Expression`

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

Width¶

PierceHoleParentBuilder.Width¶

Returns the width of pierce holes

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

Getter Method

Signature Width

Returns:
Return type:	`NXOpen.Expression`

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

Method Detail¶

CreateChild¶

PierceHoleParentBuilder.CreateChild¶

Creates a child pierce hole

Signature CreateChild()

Returns:
Return type:	`NXOpen.Die.PierceHoleChildBuilder`

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

DeleteChild¶

PierceHoleParentBuilder.DeleteChild¶

Deletes a child pierce hole

Signature DeleteChild(dieholechild)

Parameters:	dieholechild (`NXOpen.Die.PierceHoleChildBuilder`) –

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

GetBreakerHoleAttributes¶

PierceHoleParentBuilder.GetBreakerHoleAttributes¶

Gets the breaker hole attributes, note existance of attributes depends on usage in main feature

Signature GetBreakerHoleAttributes()

Returns:	a tuple
Return type:	A tuple consisting of (title, value, color, diameterTitle) title is a str. title for attribute value is a str. value of attribute color is a int. color of hole faces diameterTitle is a str. title for diameter attribute

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

GetChildren¶

PierceHoleParentBuilder.GetChildren¶

Outputs the pierce hole children

Signature GetChildren()

Returns:	children
Return type:	list of `NXOpen.Die.PierceHoleChildBuilder`

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

GetHoleAttributes¶

PierceHoleParentBuilder.GetHoleAttributes¶

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

Signature GetHoleAttributes()

Returns:	a tuple
Return type:	A tuple consisting of (title, value, color, diameterTitle) title is a str. title for attribute value is a str. value of attribute color is a int. color of hole faces diameterTitle is a str. title for diameter attribute

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

GetSlugHoleAttributes¶

PierceHoleParentBuilder.GetSlugHoleAttributes¶

Gets the slug hole attributes, note existance of attributes depends on usage in main feature

Signature GetSlugHoleAttributes()

Returns:	a tuple
Return type:	A tuple consisting of (title, value, color, diameterTitle) title is a str. title for attribute value is a str. value of attribute color is a int. color of hole faces diameterTitle is a str. title for diameter attribute

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

SetBreakerHoleAttributes¶

PierceHoleParentBuilder.SetBreakerHoleAttributes¶

Sets the breaker hole attributes, note existance of attributes depends on usage in main feature

Signature SetBreakerHoleAttributes(title, value, color, diameterTitle)

Parameters:	title (str) – title for attribute value (str) – value of attribute color (int) – color of hole faces diameterTitle (str) – title for diameter attribute

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

SetBreakerHoleDepth¶

PierceHoleParentBuilder.SetBreakerHoleDepth¶

Signature SetBreakerHoleDepth(breakerHoleDepth)

Parameters:	breakerHoleDepth (str) –

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

SetBreakerHoleFactor¶

PierceHoleParentBuilder.SetBreakerHoleFactor¶

Signature SetBreakerHoleFactor(breakerHoleFactor)

Parameters:	breakerHoleFactor (str) –

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

SetBreakerHoleOffset¶

PierceHoleParentBuilder.SetBreakerHoleOffset¶

Signature SetBreakerHoleOffset(breakerHoleOffset)

Parameters:	breakerHoleOffset (str) –

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

SetDepth¶

PierceHoleParentBuilder.SetDepth¶

Signature SetDepth(depth)

Parameters:	depth (str) –

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

SetDiameter¶

PierceHoleParentBuilder.SetDiameter¶

Signature SetDiameter(diameter)

Parameters:	diameter (str) –

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

SetDieClearance¶

PierceHoleParentBuilder.SetDieClearance¶

Signature SetDieClearance(dieClearance)

Parameters:	dieClearance (str) –

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

SetHoleAttributes¶

PierceHoleParentBuilder.SetHoleAttributes¶

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

Signature SetHoleAttributes(title, value, color, diameterTitle)

Parameters:	title (str) – title for attribute value (str) – value of attribute color (int) – color of hole faces diameterTitle (str) – title for diameter attribute

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

SetLength¶

PierceHoleParentBuilder.SetLength¶

Signature SetLength(length)

Parameters:	length (str) –

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

SetProfileBlendRadius¶

PierceHoleParentBuilder.SetProfileBlendRadius¶

Signature SetProfileBlendRadius(profileBlendRadius)

Parameters:	profileBlendRadius (str) –

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

SetSlugHoleAttributes¶

PierceHoleParentBuilder.SetSlugHoleAttributes¶

Sets the slug hole attributes, note existance of attributes depends on usage in main feature

Signature SetSlugHoleAttributes(title, value, color, diameterTitle)

Parameters:	title (str) – title for attribute value (str) – value of attribute color (int) – color of hole faces diameterTitle (str) – title for diameter attribute

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

SetSlugHoleDiameterIncrement¶

PierceHoleParentBuilder.SetSlugHoleDiameterIncrement¶

Signature SetSlugHoleDiameterIncrement(slugHoleDiameterIncrement)

Parameters:	slugHoleDiameterIncrement (str) –

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

SetSlugHoleOffset¶

PierceHoleParentBuilder.SetSlugHoleOffset¶

Signature SetSlugHoleOffset(slugHoleOffset)

Parameters:	slugHoleOffset (str) –

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

SetWidth¶

PierceHoleParentBuilder.SetWidth¶

Signature SetWidth(pierceHoleWidth)

Parameters:	pierceHoleWidth (str) –

New in version NX4.0.0.

License requirements: ug_die_design (“Die Design”)

Validate¶

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