ThroatChildBuilder Class¶
-
class
NXOpen.Die.ThroatChildBuilder¶ Bases:
NXOpen.Features.FeatureBuilderRepresents a Die Throat 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 throat section. |
| CavityDepth | Returns the distance measured from the bend profile of the flange to the base of the throat. |
| CavityOffset | Returns the offset distance measured from the Throat CSYS to the back cavity area of the throat. |
| DesignStatus | Returns or sets the design status of the throat section, if true the throat section will be built into the model, if false it will not. |
| DisplayStatus | Returns or sets the display status of the throat section, if true input data to the throat section will be displayed, if false the input data will not be displayed. |
| ExtensionLength | Returns the tangent distance to add to the end of the flange. |
| LowerRadius | Returns the radius to apply to the lower corner of the throat cavity. |
| 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 |
| Radius | Returns or sets the radius to be applied at the back of the throat, top and bottom |
| SectionPlacement | Returns the throat section placement along the center line, an expression containg the length along the centerline for placement |
| Step | Returns or sets the step to be applied at the end of the tangent extension of the flange |
| StepDistance | Returns the step distance to add at the end of the tangent extension. |
| SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
| Tag | Returns the Tag for this object. |
| UpperRadius | Returns the radius to apply to the upper corner of the throat cavity. |
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. |
| GetCavityAttributes | Gets the cavity attributes, note existance of attributes depends on usage in main feature. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetExtensionAttributes | Gets the extension attributes, note existance of attributes depends on usage in main feature. |
| 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. |
| SetCavityAttributes | Sets the cavity attributes, note existance of attributes depends on usage in main feature. |
| SetCavityDepth | |
| SetCavityOffset | |
| SetExtensionAttributes | Sets the extension attributes, note existance of attributes depends on usage in main feature. |
| SetExtensionLength | |
| SetLowerRadius | |
| SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
| SetSectionPlacement | |
| SetStepDistance | |
| SetUpperRadius | |
| 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¶
| ThroatChildBuilderTypeOption Enumeration | Settings for the type of the throat section. |
Property Detail¶
BuildStatus¶
-
ThroatChildBuilder.BuildStatus¶ Returns the build status of the throat section.
-------------------------------------Getter Method
Signature
BuildStatusReturns: Return type: NXOpen.Die.DieBuildStatusOptionNew in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
CavityDepth¶
-
ThroatChildBuilder.CavityDepth¶ Returns the distance measured from the bend profile of the flange to the base of the throat.
The base of the throat is considered to be the surface the wear plates are mounted on for guiding and aliging the flange steels. The value given must be larger than the minimum cavity depth. An expression containg the value. Value is used in both the Wipe and Restrike Flange.
-------------------------------------Getter Method
Signature
CavityDepthReturns: Return type: NXOpen.ExpressionNew in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
CavityOffset¶
-
ThroatChildBuilder.CavityOffset¶ Returns the offset distance measured from the Throat CSYS to the back cavity area of the throat.
Both positive and negative values may given to adjust the cavity to the proper location. An expression containg the value. Value is used in both the Wipe and Restrike Flange.
-------------------------------------Getter Method
Signature
CavityOffsetReturns: Return type: NXOpen.ExpressionNew in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
DesignStatus¶
-
ThroatChildBuilder.DesignStatus¶ Returns or sets the design status of the throat section, if true the throat section 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”)
DisplayStatus¶
-
ThroatChildBuilder.DisplayStatus¶ Returns or sets the display status of the throat section, if true input data to the throat section 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”)
ExtensionLength¶
-
ThroatChildBuilder.ExtensionLength¶ Returns the tangent distance to add to the end of the flange.
An expression containg the length along the tangent. Value is used in both the Wipe and Restrike Flange.
-------------------------------------Getter Method
Signature
ExtensionLengthReturns: Return type: NXOpen.ExpressionNew in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
LowerRadius¶
-
ThroatChildBuilder.LowerRadius¶ Returns the radius to apply to the lower corner of the throat cavity.
Typically, both the lower and the upper radius will be the same. An expression containg the value. Value is used in both the Wipe and Restrike Flange.
-------------------------------------Getter Method
Signature
LowerRadiusReturns: Return type: NXOpen.ExpressionNew in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
Radius¶
-
ThroatChildBuilder.Radius¶ Returns or sets the radius to be applied at the back of the throat, top and bottom
-------------------------------------Getter Method
Signature
RadiusReturns: Return type: float New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------Setter Method
Signature
RadiusParameters: radius (float) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SectionPlacement¶
-
ThroatChildBuilder.SectionPlacement¶ Returns the throat section placement along the center line, an expression containg the length along the centerline for placement
-------------------------------------Getter Method
Signature
SectionPlacementReturns: Return type: NXOpen.ExpressionNew in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
Step¶
-
ThroatChildBuilder.Step¶ Returns or sets the step to be applied at the end of the tangent extension of the flange
-------------------------------------Getter Method
Signature
StepReturns: Return type: float New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------Setter Method
Signature
StepParameters: step (float) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
StepDistance¶
-
ThroatChildBuilder.StepDistance¶ Returns the step distance to add at the end of the tangent extension.
The step is at a right angle and only applies to the Wipe Flange. An expression containg the step distance.
-------------------------------------Getter Method
Signature
StepDistanceReturns: Return type: NXOpen.ExpressionNew in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
UpperRadius¶
-
ThroatChildBuilder.UpperRadius¶ Returns the radius to apply to the upper corner of the throat cavity.
An expression containg the value. Value is used in both the Wipe and Restrike Flange.
-------------------------------------Getter Method
Signature
UpperRadiusReturns: Return type: NXOpen.ExpressionNew in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
Method Detail¶
GetCavityAttributes¶
-
ThroatChildBuilder.GetCavityAttributes¶ Gets the cavity attributes, note existance of attributes depends on usage in main feature.
Signature
GetCavityAttributes()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 cavity faces. New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
GetExtensionAttributes¶
-
ThroatChildBuilder.GetExtensionAttributes¶ Gets the extension attributes, note existance of attributes depends on usage in main feature.
Signature
GetExtensionAttributes()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 extension faces. New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetCavityAttributes¶
-
ThroatChildBuilder.SetCavityAttributes¶ Sets the cavity attributes, note existance of attributes depends on usage in main feature.
Signature
SetCavityAttributes(title, value, color)Parameters: - title (str) – Title for attribute.
- value (str) – Value of attribute.
- color (int) – Color of cavity faces.
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetCavityDepth¶
-
ThroatChildBuilder.SetCavityDepth¶ Signature
SetCavityDepth(cavityDepth)Parameters: cavityDepth (str) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetCavityOffset¶
-
ThroatChildBuilder.SetCavityOffset¶ Signature
SetCavityOffset(cavityOffset)Parameters: cavityOffset (str) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetExtensionAttributes¶
-
ThroatChildBuilder.SetExtensionAttributes¶ Sets the extension attributes, note existance of attributes depends on usage in main feature.
Signature
SetExtensionAttributes(title, value, color)Parameters: - title (str) – Title for attribute.
- value (str) – Value of attribute.
- color (int) – Color of extension faces.
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetExtensionLength¶
-
ThroatChildBuilder.SetExtensionLength¶ Signature
SetExtensionLength(extensionLength)Parameters: extensionLength (str) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetLowerRadius¶
-
ThroatChildBuilder.SetLowerRadius¶ Signature
SetLowerRadius(lowerRadius)Parameters: lowerRadius (str) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetSectionPlacement¶
-
ThroatChildBuilder.SetSectionPlacement¶ Signature
SetSectionPlacement(sectionPlacement)Parameters: sectionPlacement (str) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetStepDistance¶
-
ThroatChildBuilder.SetStepDistance¶ Signature
SetStepDistance(stepDistance)Parameters: stepDistance (str) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
SetUpperRadius¶
-
ThroatChildBuilder.SetUpperRadius¶ Signature
SetUpperRadius(upperRadius)Parameters: upperRadius (str) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
Validate¶
-
ThroatChildBuilder.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.