PadChildBuilder Class¶
-
class
NXOpen.Die.
PadChildBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a Die Pad 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 pad. |
CenterHole | Returns or sets the center hole switch of the die pad, if true the center hole will be created in the pad, if false it will not. |
DesignStatus | Returns or sets the design status of the die pad, if true the pad will be built into the model, if false it will not. |
Diameter | Returns or sets the diameter of the die pad. |
DisplayStatus | Returns or sets the display status of the die pad, if true input data to the pad will be displayed, if false the input data will not be displayed. |
Height | Returns or sets the height of the die pad. |
HoleDiameter | Returns or sets the hole diameter of the die pad. |
Length | Returns or sets the length of the die pad. |
LimitingSurface | Returns or sets the limiting surface of the die pad. |
Location | Returns or sets the location of the die pad. |
LocationOffset | Returns or sets the location offset of the die pad. |
LocationOffsetDirection | Returns or sets the location offset direction of the die pad. |
OrientationPlane | Returns or sets the orientation plane of the die pad. |
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 |
Relief | Returns or sets the relief switch of the die pad, if true the relief will be built around the pad, if false it will not. |
ReliefDepth | Returns or sets the relief depth of the die pad. |
ReliefWidth | Returns or sets the relief width of the die pad. |
ReverseOrientation | Returns or sets the value to reverse the orientation of the orientation plane, if true the pad orientation normal will be reversed, if false it will not. |
ShapeType | Returns or sets the shape type of the die pad. |
SurfaceOffset | Returns or sets the surface offset of the die pad. |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
Width | Returns or sets the width of the die pad. |
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. |
GetHoleCenters | Gets the hole centers of the die pad. |
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. |
GetReliefAttributes | Gets the relief attributes, note existance of attributes depends on usage in main feature. |
GetShape | Gets the shape profile of the die pads. |
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. |
SetHoleCenters | Sets the hole centers of the die pad. |
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 |
SetReliefAttributes | Sets the relief attributes, note existance of attributes depends on usage in main feature. |
SetShape | Sets the shape profile of the die pad. |
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. |
TranslateLocation | Translates the location of the die pad 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¶
PadChildBuilderShapeTypeOption Enumeration | Settings for the shape type of the die pad. |
Property Detail¶
BuildStatus¶
-
PadChildBuilder.
BuildStatus
¶ Returns the build status of the die pad.
-------------------------------------
Getter Method
Signature
BuildStatus
Returns: Return type: NXOpen.Die.DieBuildStatusOption
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
CenterHole¶
-
PadChildBuilder.
CenterHole
¶ Returns or sets the center hole switch of the die pad, if true the center hole will be created in the pad, if false it will not.
-------------------------------------
Getter Method
Signature
CenterHole
Returns: Return type: bool New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------
Setter Method
Signature
CenterHole
Parameters: centerHole (bool) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
DesignStatus¶
-
PadChildBuilder.
DesignStatus
¶ Returns or sets the design status of the die pad, if true the pad 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”)
Diameter¶
-
PadChildBuilder.
Diameter
¶ Returns or sets the diameter of the die pad.
-------------------------------------
Getter Method
Signature
Diameter
Returns: Return type: float New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------
Setter Method
Signature
Diameter
Parameters: diameter (float) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
DisplayStatus¶
-
PadChildBuilder.
DisplayStatus
¶ Returns or sets the display status of the die pad, if true input data to the pad 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”)
Height¶
-
PadChildBuilder.
Height
¶ Returns or sets the height of the die pad.
-------------------------------------
Getter Method
Signature
Height
Returns: Return type: float New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------
Setter Method
Signature
Height
Parameters: height (float) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
HoleDiameter¶
-
PadChildBuilder.
HoleDiameter
¶ Returns or sets the hole diameter of the die pad.
-------------------------------------
Getter Method
Signature
HoleDiameter
Returns: Return type: float New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------
Setter Method
Signature
HoleDiameter
Parameters: holeDiameter (float) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
Length¶
-
PadChildBuilder.
Length
¶ Returns or sets the length of the die pad.
-------------------------------------
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”)
LimitingSurface¶
-
PadChildBuilder.
LimitingSurface
¶ Returns or sets the limiting surface of the die pad.
-------------------------------------
Getter Method
Signature
LimitingSurface
Returns: Return type: NXOpen.IOrientation
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------
Setter Method
Signature
LimitingSurface
Parameters: limitingSurface ( NXOpen.IOrientation
) –New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
Location¶
-
PadChildBuilder.
Location
¶ Returns or sets the location of the die pad.
-------------------------------------
Getter Method
Signature
Location
Returns: Return type: NXOpen.ILocation
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------
Setter Method
Signature
Location
Parameters: location ( NXOpen.ILocation
) –New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
LocationOffset¶
-
PadChildBuilder.
LocationOffset
¶ Returns or sets the location offset of the die pad.
-------------------------------------
Getter Method
Signature
LocationOffset
Returns: Return type: float New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------
Setter Method
Signature
LocationOffset
Parameters: locationOffset (float) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
LocationOffsetDirection¶
-
PadChildBuilder.
LocationOffsetDirection
¶ Returns or sets the location offset direction of the die pad.
-------------------------------------
Getter Method
Signature
LocationOffsetDirection
Returns: Return type: NXOpen.IReferenceAxis
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------
Setter Method
Signature
LocationOffsetDirection
Parameters: locationOffsetDirection ( NXOpen.IReferenceAxis
) –New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
OrientationPlane¶
-
PadChildBuilder.
OrientationPlane
¶ Returns or sets the orientation plane of the die pad.
-------------------------------------
Getter Method
Signature
OrientationPlane
Returns: Return type: NXOpen.IOrientation
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------
Setter Method
Signature
OrientationPlane
Parameters: orientationPlane ( NXOpen.IOrientation
) –New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
Relief¶
-
PadChildBuilder.
Relief
¶ Returns or sets the relief switch of the die pad, if true the relief will be built around the pad, if false it will not.
-------------------------------------
Getter Method
Signature
Relief
Returns: Return type: bool New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------
Setter Method
Signature
Relief
Parameters: relief (bool) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
ReliefDepth¶
-
PadChildBuilder.
ReliefDepth
¶ Returns or sets the relief depth of the die pad.
-------------------------------------
Getter Method
Signature
ReliefDepth
Returns: Return type: float New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------
Setter Method
Signature
ReliefDepth
Parameters: reliefDepth (float) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
ReliefWidth¶
-
PadChildBuilder.
ReliefWidth
¶ Returns or sets the relief width of the die pad.
-------------------------------------
Getter Method
Signature
ReliefWidth
Returns: Return type: float New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------
Setter Method
Signature
ReliefWidth
Parameters: reliefWidth (float) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
ReverseOrientation¶
-
PadChildBuilder.
ReverseOrientation
¶ Returns or sets the value to reverse the orientation of the orientation plane, if true the pad 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”)
ShapeType¶
-
PadChildBuilder.
ShapeType
¶ Returns or sets the shape type of the die pad.
-------------------------------------
Getter Method
Signature
ShapeType
Returns: Return type: NXOpen.Die.PadChildBuilderShapeTypeOption
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------
Setter Method
Signature
ShapeType
Parameters: shapeType ( NXOpen.Die.PadChildBuilderShapeTypeOption
) –New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SurfaceOffset¶
-
PadChildBuilder.
SurfaceOffset
¶ Returns or sets the surface offset of the die pad.
-------------------------------------
Getter Method
Signature
SurfaceOffset
Returns: Return type: float New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------
Setter Method
Signature
SurfaceOffset
Parameters: surfaceOffset (float) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
Width¶
-
PadChildBuilder.
Width
¶ Returns or sets the width of the die pad.
-------------------------------------
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¶
GetHoleAttributes¶
-
PadChildBuilder.
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”)
GetHoleCenters¶
-
PadChildBuilder.
GetHoleCenters
¶ Gets the hole centers of the die pad.
Signature
GetHoleCenters()
Returns: The hole centers. Return type: list of NXOpen.Point
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
GetPadAttributes¶
-
PadChildBuilder.
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”)
GetReliefAttributes¶
-
PadChildBuilder.
GetReliefAttributes
¶ Gets the relief attributes, note existance of attributes depends on usage in main feature.
Signature
GetReliefAttributes()
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 relief faces. New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
GetShape¶
-
PadChildBuilder.
GetShape
¶ Gets the shape profile of the die pads.
Signature
GetShape()
Returns: a tuple Return type: A tuple consisting of (profileEntries, direction). profileEntries is a list of NXOpen.IProfile
. The profile entries, will be curves, edges, faces, sketches or curve features. direction is aNXOpen.Die.DirectionOption
. Profile direction.New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetHoleAttributes¶
-
PadChildBuilder.
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”)
SetHoleCenters¶
-
PadChildBuilder.
SetHoleCenters
¶ Sets the hole centers of the die pad.
Signature
SetHoleCenters(holes)
Parameters: holes (list of NXOpen.Point
) – The hole centers.New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetPadAttributes¶
-
PadChildBuilder.
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”)
SetReliefAttributes¶
-
PadChildBuilder.
SetReliefAttributes
¶ Sets the relief attributes, note existance of attributes depends on usage in main feature.
Signature
SetReliefAttributes(title, value, color)
Parameters: - title (str) – Title for attribute.
- value (str) – Value of attribute.
- color (int) – Color of relief faces.
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetShape¶
-
PadChildBuilder.
SetShape
¶ Sets the shape profile of the die pad.
Signature
SetShape(direction, profileEntries)
Parameters: - direction (
NXOpen.Die.DirectionOption
) – Profile direction. - profileEntries (list of
NXOpen.IProfile
) – The profile entries, can be curves, edges, faces, sketches or curve features.
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
- direction (
TranslateLocation¶
-
PadChildBuilder.
TranslateLocation
¶ Translates the location of the die pad by the specified amount.
Signature
TranslateLocation(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¶
-
PadChildBuilder.
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.