PierceHoleChildBuilder Class¶
-
class
NXOpen.Die.
PierceHoleChildBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a Pierce Hole Child 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 the pierce hole |
BreakerHoleDirection | Returns or sets the breaker hole direction of the pierce hole |
BreakerHoleFactor | Returns the breaker hole factor of the pierce hole |
BreakerHoleLocation | Returns or sets the location of breaker holes for the pierce hole |
BreakerHoleOffset | Returns the breaker hole offset of the pierce hole |
BuildStatus | Returns the build status of the pierce hole |
CircularSlugHole | Returns or sets the circular slug hole switch of the pierce hole |
Depth | Returns the depth of the pierce hole |
DesignStatus | Returns or sets the design status of the pierce hole |
Diameter | Returns the diameter of the pierce hole |
DieClearance | Returns the die clearance of the pierce hole |
DisplayHoles | Returns or sets the display holes option of the pierce hole |
DisplayStatus | Returns or sets the display status of the pierce hole |
Length | Returns the length of the pierce hole |
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 |
PierceHoleDirection | Returns or sets the pierce hole direction |
ProfileBlendRadius | Returns the profile blend radius of the pierce hole |
ShapeType | Returns or sets the pierce hole shape type |
SlugHoleDiameterIncrement | Returns the slug hole diameter increment of the pierce hole |
SlugHoleOffset | Returns the slug hole offset of the pierce hole |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
Width | Returns the width of the pierce hole |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature @return |
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 |
GetBreakerHoleShape | Gets the breaker hole shape of the pierce hole @return profile entries |
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. |
GetPierceHoleLocation | Gets the locations of the pierce hole @return pierce hole location |
GetPierceHoleShape | Gets the shape of the pierce hole @return profile entries |
GetSlugHoleAttributes | Gets the slug hole attributes, note existance of attributes depends on usage in main feature |
GetSlugHoleShape | Gets the slug hole shape of the pierce hole @return profile entries |
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 | |
SetBreakerHoleShape | Sets the breaker hole shape of the pierce hole |
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 |
SetPierceHoleLocation | Sets the locations of the pierce hole |
SetPierceHoleShape | Sets the shape of the pierce hole |
SetProfileBlendRadius | |
SetSlugHoleAttributes | Sets the slug hole attributes, note existance of attributes depends on usage in main feature |
SetSlugHoleDiameterIncrement | |
SetSlugHoleOffset | |
SetSlugHoleShape | Sets the slug hole shape of the pierce hole |
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. |
TranslatePierceHoleLocation | Translates the center of the die pierce hole by the specified amount. |
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¶
PierceHoleChildBuilderShapeTypeOption Enumeration | Settings for the shape type of the pierce hole. |
Property Detail¶
BreakerHoleDepth¶
-
PierceHoleChildBuilder.
BreakerHoleDepth
¶ Returns the breaker hole depth of the pierce hole
-------------------------------------
Getter Method
Signature
BreakerHoleDepth()
Returns: Return type: NXOpen.Expression
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
BreakerHoleDirection¶
-
PierceHoleChildBuilder.
BreakerHoleDirection
¶ Returns or sets the breaker hole direction of the pierce hole
-------------------------------------
Getter Method
Signature
BreakerHoleDirection()
Returns: breaker hole direction Return type: NXOpen.ILocation
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------
Setter Method
Signature
BreakerHoleDirection(breakerHoleDirection)
Parameters: breakerHoleDirection ( NXOpen.ILocation
) – breaker hole directionNew in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
BreakerHoleFactor¶
-
PierceHoleChildBuilder.
BreakerHoleFactor
¶ Returns the breaker hole factor of the pierce hole
-------------------------------------
Getter Method
Signature
BreakerHoleFactor()
Returns: Return type: NXOpen.Expression
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
BreakerHoleLocation¶
-
PierceHoleChildBuilder.
BreakerHoleLocation
¶ Returns or sets the location of breaker holes for the pierce hole
-------------------------------------
Getter Method
Signature
BreakerHoleLocation()
Returns: breaker hole location Return type: NXOpen.ILocation
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------
Setter Method
Signature
BreakerHoleLocation(breakerHoleLocation)
Parameters: breakerHoleLocation ( NXOpen.ILocation
) – breaker hole locationNew in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
BreakerHoleOffset¶
-
PierceHoleChildBuilder.
BreakerHoleOffset
¶ Returns the breaker hole offset of the pierce hole
-------------------------------------
Getter Method
Signature
BreakerHoleOffset()
Returns: Return type: NXOpen.Expression
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
BuildStatus¶
-
PierceHoleChildBuilder.
BuildStatus
¶ Returns the build status of the pierce hole
-------------------------------------
Getter Method
Signature
BuildStatus()
Returns: Return type: NXOpen.Die.DieBuildStatusOption
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
CircularSlugHole¶
-
PierceHoleChildBuilder.
CircularSlugHole
¶ Returns or sets the circular slug hole switch of the pierce hole
-------------------------------------
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(circularSlugHole)
Parameters: circularSlugHole (bool) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
Depth¶
-
PierceHoleChildBuilder.
Depth
¶ Returns the depth of the pierce hole
-------------------------------------
Getter Method
Signature
Depth()
Returns: Return type: NXOpen.Expression
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
DesignStatus¶
-
PierceHoleChildBuilder.
DesignStatus
¶ Returns or sets the design status of the pierce hole
-------------------------------------
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(designStatus)
Parameters: designStatus (bool) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
Diameter¶
-
PierceHoleChildBuilder.
Diameter
¶ Returns the diameter of the pierce hole
-------------------------------------
Getter Method
Signature
Diameter()
Returns: Return type: NXOpen.Expression
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
DieClearance¶
-
PierceHoleChildBuilder.
DieClearance
¶ Returns the die clearance of the pierce hole
-------------------------------------
Getter Method
Signature
DieClearance()
Returns: Return type: NXOpen.Expression
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
DisplayHoles¶
-
PierceHoleChildBuilder.
DisplayHoles
¶ Returns or sets the display holes option of the pierce hole
-------------------------------------
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(displayPierceHoles)
Parameters: displayPierceHoles (bool) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
DisplayStatus¶
-
PierceHoleChildBuilder.
DisplayStatus
¶ Returns or sets the display status of the pierce hole
-------------------------------------
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(displayStatus)
Parameters: displayStatus (bool) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
Length¶
-
PierceHoleChildBuilder.
Length
¶ Returns the length of the pierce hole
-------------------------------------
Getter Method
Signature
Length()
Returns: Return type: NXOpen.Expression
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
PierceHoleDirection¶
-
PierceHoleChildBuilder.
PierceHoleDirection
¶ Returns or sets the pierce hole direction
-------------------------------------
Getter Method
Signature
PierceHoleDirection()
Returns: pierce hole direction Return type: NXOpen.ILocation
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------
Setter Method
Signature
PierceHoleDirection(pierceHoleDirection)
Parameters: pierceHoleDirection ( NXOpen.ILocation
) – pierce hole directionNew in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
ProfileBlendRadius¶
-
PierceHoleChildBuilder.
ProfileBlendRadius
¶ Returns the profile blend radius of the pierce hole
-------------------------------------
Getter Method
Signature
ProfileBlendRadius()
Returns: Return type: NXOpen.Expression
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
ShapeType¶
-
PierceHoleChildBuilder.
ShapeType
¶ Returns or sets the pierce hole shape type
-------------------------------------
Getter Method
Signature
ShapeType()
Returns: hole type Return type: NXOpen.Die.PierceHoleChildBuilderShapeTypeOption
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------
Setter Method
Signature
ShapeType(shapeType)
Parameters: shapeType ( NXOpen.Die.PierceHoleChildBuilderShapeTypeOption
) – hole typeNew in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SlugHoleDiameterIncrement¶
-
PierceHoleChildBuilder.
SlugHoleDiameterIncrement
¶ Returns the slug hole diameter increment of the pierce hole
-------------------------------------
Getter Method
Signature
SlugHoleDiameterIncrement()
Returns: Return type: NXOpen.Expression
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SlugHoleOffset¶
-
PierceHoleChildBuilder.
SlugHoleOffset
¶ Returns the slug hole offset of the pierce hole
-------------------------------------
Getter Method
Signature
SlugHoleOffset()
Returns: Return type: NXOpen.Expression
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
Width¶
-
PierceHoleChildBuilder.
Width
¶ Returns the width of the pierce hole
-------------------------------------
Getter Method
Signature
Width()
Returns: Return type: NXOpen.Expression
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
Method Detail¶
GetBreakerHoleAttributes¶
-
PierceHoleChildBuilder.
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”)
GetBreakerHoleShape¶
-
PierceHoleChildBuilder.
GetBreakerHoleShape
¶ Gets the breaker hole shape of the pierce hole
Signature
GetBreakerHoleShape()
Returns: a tuple Return type: A tuple consisting of (profileEntries, direction). profileEntries is a list of NXOpen.IProfile
. profile entries direction is aNXOpen.Die.DirectionOption
. profile directionNew in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
GetHoleAttributes¶
-
PierceHoleChildBuilder.
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”)
GetPierceHoleLocation¶
-
PierceHoleChildBuilder.
GetPierceHoleLocation
¶ Gets the locations of the pierce hole
Signature
GetPierceHoleLocation()
Returns: pierce hole location Return type: list of NXOpen.ILocation
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
GetPierceHoleShape¶
-
PierceHoleChildBuilder.
GetPierceHoleShape
¶ Gets the shape of the pierce hole
Signature
GetPierceHoleShape()
Returns: a tuple Return type: A tuple consisting of (profileEntries, direction). profileEntries is a list of NXOpen.IProfile
. profile entries direction is aNXOpen.Die.DirectionOption
. profile directionNew in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
GetSlugHoleAttributes¶
-
PierceHoleChildBuilder.
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”)
GetSlugHoleShape¶
-
PierceHoleChildBuilder.
GetSlugHoleShape
¶ Gets the slug hole shape of the pierce hole
Signature
GetSlugHoleShape()
Returns: a tuple Return type: A tuple consisting of (profileEntries, direction). profileEntries is a list of NXOpen.IProfile
. profile entries direction is aNXOpen.Die.DirectionOption
. profile directionNew in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetBreakerHoleAttributes¶
-
PierceHoleChildBuilder.
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 NOTE: The full Unicode character set is not supported for this parameter.
- value (str) – value of attribute NOTE: The full Unicode character set is not supported for this parameter.
- color (int) – color of hole faces
- diameterTitle (str) – title for diameter attribute NOTE: The full Unicode character set is not supported for this parameter.
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetBreakerHoleDepth¶
-
PierceHoleChildBuilder.
SetBreakerHoleDepth
¶ Signature
SetBreakerHoleDepth(breakerHoleDepth)
Parameters: breakerHoleDepth (str) – NOTE: The full Unicode character set is not supported for this parameter. New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetBreakerHoleFactor¶
-
PierceHoleChildBuilder.
SetBreakerHoleFactor
¶ Signature
SetBreakerHoleFactor(breakerHoleFactor)
Parameters: breakerHoleFactor (str) – NOTE: The full Unicode character set is not supported for this parameter. New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetBreakerHoleOffset¶
-
PierceHoleChildBuilder.
SetBreakerHoleOffset
¶ Signature
SetBreakerHoleOffset(breakerHoleOffset)
Parameters: breakerHoleOffset (str) – NOTE: The full Unicode character set is not supported for this parameter. New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetBreakerHoleShape¶
-
PierceHoleChildBuilder.
SetBreakerHoleShape
¶ Sets the breaker hole shape of the pierce hole
Signature
SetBreakerHoleShape(direction, profileEntries)
Parameters: - direction (
NXOpen.Die.DirectionOption
) – profile direction - profileEntries (list of
NXOpen.IProfile
) – profile entries
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
- direction (
SetDepth¶
-
PierceHoleChildBuilder.
SetDepth
¶ Signature
SetDepth(depth)
Parameters: depth (str) – NOTE: The full Unicode character set is not supported for this parameter. New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetDiameter¶
-
PierceHoleChildBuilder.
SetDiameter
¶ Signature
SetDiameter(diameter)
Parameters: diameter (str) – NOTE: The full Unicode character set is not supported for this parameter. New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetDieClearance¶
-
PierceHoleChildBuilder.
SetDieClearance
¶ Signature
SetDieClearance(dieClearance)
Parameters: dieClearance (str) – NOTE: The full Unicode character set is not supported for this parameter. New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetHoleAttributes¶
-
PierceHoleChildBuilder.
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 NOTE: The full Unicode character set is not supported for this parameter.
- value (str) – value of attribute NOTE: The full Unicode character set is not supported for this parameter.
- color (int) – color of hole faces
- diameterTitle (str) – title for diameter attribute NOTE: The full Unicode character set is not supported for this parameter.
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetLength¶
-
PierceHoleChildBuilder.
SetLength
¶ Signature
SetLength(length)
Parameters: length (str) – NOTE: The full Unicode character set is not supported for this parameter. New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetPierceHoleLocation¶
-
PierceHoleChildBuilder.
SetPierceHoleLocation
¶ Sets the locations of the pierce hole
Signature
SetPierceHoleLocation(pierceHoleLocations)
Parameters: pierceHoleLocations (list of NXOpen.ILocation
) – pierce hole locationNew in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetPierceHoleShape¶
-
PierceHoleChildBuilder.
SetPierceHoleShape
¶ Sets the shape of the pierce hole
Signature
SetPierceHoleShape(direction, profileEntries)
Parameters: - direction (
NXOpen.Die.DirectionOption
) – profile direction - profileEntries (list of
NXOpen.IProfile
) – profile entries
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
- direction (
SetProfileBlendRadius¶
-
PierceHoleChildBuilder.
SetProfileBlendRadius
¶ Signature
SetProfileBlendRadius(profileBlendRadius)
Parameters: profileBlendRadius (str) – profile blend radius NOTE: The full Unicode character set is not supported for this parameter. New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetSlugHoleAttributes¶
-
PierceHoleChildBuilder.
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 NOTE: The full Unicode character set is not supported for this parameter.
- value (str) – value of attribute NOTE: The full Unicode character set is not supported for this parameter.
- color (int) – color of hole faces
- diameterTitle (str) – title for diameter attribute NOTE: The full Unicode character set is not supported for this parameter.
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetSlugHoleDiameterIncrement¶
-
PierceHoleChildBuilder.
SetSlugHoleDiameterIncrement
¶ Signature
SetSlugHoleDiameterIncrement(slugHoleDiameterIncrement)
Parameters: slugHoleDiameterIncrement (str) – NOTE: The full Unicode character set is not supported for this parameter. New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetSlugHoleOffset¶
-
PierceHoleChildBuilder.
SetSlugHoleOffset
¶ Signature
SetSlugHoleOffset(slugHoleOffset)
Parameters: slugHoleOffset (str) – NOTE: The full Unicode character set is not supported for this parameter. New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetSlugHoleShape¶
-
PierceHoleChildBuilder.
SetSlugHoleShape
¶ Sets the slug hole shape of the pierce hole
Signature
SetSlugHoleShape(direction, profileEntries)
Parameters: - direction (
NXOpen.Die.DirectionOption
) – profile direction - profileEntries (list of
NXOpen.IProfile
) – profile entries
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
- direction (
SetWidth¶
-
PierceHoleChildBuilder.
SetWidth
¶ Signature
SetWidth(width)
Parameters: width (str) – NOTE: The full Unicode character set is not supported for this parameter. New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
TranslatePierceHoleLocation¶
-
PierceHoleChildBuilder.
TranslatePierceHoleLocation
¶ Translates the center of the die pierce hole by the specified amount.
Signature
TranslatePierceHoleLocation(translateDist)
Parameters: translateDist ( NXOpen.Vector3d
) – A scaled vector indicating the distance to translateNew in version NX5.0.0.
License requirements: ug_die_design (“Die Design”)
Validate¶
-
PierceHoleChildBuilder.
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.