HoleChildBuilder Class¶
-
class
NXOpen.Die.HoleChildBuilder¶ Bases:
NXOpen.Features.FeatureBuilderRepresents a Die Hole 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 die hole. |
| Center | Returns or sets the center of the die hole. |
| CounterBoreDiameter | Returns or sets the counter bore diameter of the die hole. |
| CreateWithPad | Returns or sets the create with pad switch of the die hole, if true a pad will be created around the hole, if false the pad will not be created. |
| Depth | Returns or sets the depth of the die hole. |
| DesignStatus | Returns or sets the design status of the die hole, if true the hole will be built into the model, if false it will not. |
| Diameter | Returns or sets the diameter of the die hole. |
| DisplayHoles | Returns or sets the display holes switch of the die hole, if true the hole will be built into the model, if false it will not. |
| DisplayStatus | Returns or sets the display status of the die hole, if true input data to the hole will be displayed, if false the input data will not be displayed. |
| DropThruDiameter | Returns or sets the drop thru diameter of the die hole. |
| PadDiameter | Returns or sets the pad diameter of the die hole. |
| PadHeight | Returns or sets the pad height of the die 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 |
| Plane | Returns or sets the plane of the die hole. |
| PlaneOffset | Returns or sets the plane offset of the die hole. |
| SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
| Tag | Returns the Tag for this object. |
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. |
| 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. |
| GetPadAttributes | Gets the pad 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. |
| SetHoleAttributes | Sets the hole attributes, note existance of attributes depends on usage in main feature. |
| 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 |
| 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. |
| TranslateCenter | Translates the center of the die 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. |
Property Detail¶
BuildStatus¶
-
HoleChildBuilder.BuildStatus¶ Returns the build status of the die hole.
-------------------------------------Getter Method
Signature
BuildStatusReturns: Return type: NXOpen.Die.DieBuildStatusOptionNew in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
Center¶
-
HoleChildBuilder.Center¶ Returns or sets the center of the die hole.
-------------------------------------Getter Method
Signature
CenterReturns: Return type: NXOpen.ILocationNew in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------Setter Method
Signature
CenterParameters: center ( NXOpen.ILocation) –New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
CounterBoreDiameter¶
-
HoleChildBuilder.CounterBoreDiameter¶ Returns or sets the counter bore diameter of the die hole.
-------------------------------------Getter Method
Signature
CounterBoreDiameterReturns: Return type: float New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------Setter Method
Signature
CounterBoreDiameterParameters: counterBoreDiameter (float) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
CreateWithPad¶
-
HoleChildBuilder.CreateWithPad¶ Returns or sets the create with pad switch of the die hole, if true a pad will be created around the hole, if false the pad will not be created.
-------------------------------------Getter Method
Signature
CreateWithPadReturns: Return type: bool New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------Setter Method
Signature
CreateWithPadParameters: createWithPad (bool) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
Depth¶
-
HoleChildBuilder.Depth¶ Returns or sets the depth of the die hole.
-------------------------------------Getter Method
Signature
DepthReturns: Return type: float New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------Setter Method
Signature
DepthParameters: depth (float) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
DesignStatus¶
-
HoleChildBuilder.DesignStatus¶ Returns or sets the design status of the die hole, if true the hole will be built into the model, if false it will not.
-------------------------------------Getter Method
Signature
DesignStatusReturns: Return type: bool New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------Setter Method
Signature
DesignStatusParameters: designStatus (bool) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
Diameter¶
-
HoleChildBuilder.Diameter¶ Returns or sets the diameter of the die hole.
-------------------------------------Getter Method
Signature
DiameterReturns: Return type: float New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------Setter Method
Signature
DiameterParameters: diameter (float) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
DisplayHoles¶
-
HoleChildBuilder.DisplayHoles¶ Returns or sets the display holes switch of the die hole, if true the hole will be built into the model, if false it will not.
Note that this setting has the same affect as design status, unless the create with pad switch is true.
-------------------------------------Getter Method
Signature
DisplayHolesReturns: Return type: bool New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------Setter Method
Signature
DisplayHolesParameters: displayHoles (bool) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
DisplayStatus¶
-
HoleChildBuilder.DisplayStatus¶ Returns or sets the display status of the die hole, if true input data to the hole will be displayed, if false the input data will not be displayed.
-------------------------------------Getter Method
Signature
DisplayStatusReturns: Return type: bool New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------Setter Method
Signature
DisplayStatusParameters: displayStatus (bool) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
DropThruDiameter¶
-
HoleChildBuilder.DropThruDiameter¶ Returns or sets the drop thru diameter of the die hole.
-------------------------------------Getter Method
Signature
DropThruDiameterReturns: Return type: float New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------Setter Method
Signature
DropThruDiameterParameters: dropThruDiameter (float) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
PadDiameter¶
-
HoleChildBuilder.PadDiameter¶ Returns or sets the pad diameter of the die hole.
-------------------------------------Getter Method
Signature
PadDiameterReturns: Return type: float New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------Setter Method
Signature
PadDiameterParameters: padDiameter (float) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
PadHeight¶
-
HoleChildBuilder.PadHeight¶ Returns or sets the pad height of the die hole.
-------------------------------------Getter Method
Signature
PadHeightReturns: Return type: float New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------Setter Method
Signature
PadHeightParameters: padHeight (float) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
Plane¶
-
HoleChildBuilder.Plane¶ Returns or sets the plane of the die hole.
-------------------------------------Getter Method
Signature
PlaneReturns: Return type: NXOpen.ISurfaceNew in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------Setter Method
Signature
PlaneParameters: plane ( NXOpen.ISurface) –New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
PlaneOffset¶
-
HoleChildBuilder.PlaneOffset¶ Returns or sets the plane offset of the die hole.
-------------------------------------Getter Method
Signature
PlaneOffsetReturns: Return type: float New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------Setter Method
Signature
PlaneOffsetParameters: planeOffset (float) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
Method Detail¶
GetHoleAttributes¶
-
HoleChildBuilder.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, depthTitle, counterBoreDiameterTitle) 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. depthTitle is a str. Title for depth attribute. counterBoreDiameterTitle is a str. Title for counter bore diameter attribute. New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
GetPadAttributes¶
-
HoleChildBuilder.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”)
SetHoleAttributes¶
-
HoleChildBuilder.SetHoleAttributes¶ Sets the hole attributes, note existance of attributes depends on usage in main feature.
Signature
SetHoleAttributes(title, value, color, diameterTitle, depthTitle, counterBoreDiameterTitle)Parameters: - title (str) – Title for attribute.
- value (str) – Value of attribute.
- color (int) – Color of hole faces.
- diameterTitle (str) – Title for diameter attribute.
- depthTitle (str) – Title for depth attribute.
- counterBoreDiameterTitle (str) – Title for counter bore diameter attribute.
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetPadAttributes¶
-
HoleChildBuilder.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”)
TranslateCenter¶
-
HoleChildBuilder.TranslateCenter¶ Translates the center of the die hole by the specified amount.
Signature
TranslateCenter(translateDist)Parameters: translateDist ( NXOpen.Vector3d) – A scaled vector indicating the distance to translateNew in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
Validate¶
-
HoleChildBuilder.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.