CastReliefParentBuilder Class¶
-
class
NXOpen.Die.
CastReliefParentBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a Die Cast Relief 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 cast relief. |
DesignStatus | Returns or sets the design status of cast relief, if true the cast relief will be built into the model, if false it will not. |
DisplayStatus | Returns or sets the display status of cast relief, if true input data to the cast relief will be displayed, if false the input data will not be displayed. |
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 |
ReliefDepth | Returns or sets the relief depth of cast relief. |
ReliefSheet | Returns or sets the relief sheet of cast relief. |
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 @return |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCastRelief | Gets the profile of the cast relief. |
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. |
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. |
SetCastRelief | Sets the profile of the cast relief. |
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. |
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¶
-
CastReliefParentBuilder.
BuildStatus
¶ Returns the build status of cast relief.
-------------------------------------
Getter Method
Signature
BuildStatus()
Returns: Return type: NXOpen.Die.DieBuildStatusOption
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
DesignStatus¶
-
CastReliefParentBuilder.
DesignStatus
¶ Returns or sets the design status of cast relief, if true the cast relief 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(designStatus)
Parameters: designStatus (bool) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
DisplayStatus¶
-
CastReliefParentBuilder.
DisplayStatus
¶ Returns or sets the display status of cast relief, if true input data to the cast relief 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(displayStatus)
Parameters: displayStatus (bool) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
ReliefDepth¶
-
CastReliefParentBuilder.
ReliefDepth
¶ Returns or sets the relief depth of cast relief.
-------------------------------------
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(reliefDepth)
Parameters: reliefDepth (float) – New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
ReliefSheet¶
-
CastReliefParentBuilder.
ReliefSheet
¶ Returns or sets the relief sheet of cast relief.
-------------------------------------
Getter Method
Signature
ReliefSheet()
Returns: Return type: NXOpen.Body
New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
-------------------------------------
Setter Method
Signature
ReliefSheet(reliefSheet)
Parameters: reliefSheet ( NXOpen.Body
) –New in version NX4.0.0.
License requirements: ug_die_design (“Die Design”)
Method Detail¶
GetCastRelief¶
-
CastReliefParentBuilder.
GetCastRelief
¶ Gets the profile of the cast relief.
Signature
GetCastRelief()
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”)
SetCastRelief¶
-
CastReliefParentBuilder.
SetCastRelief
¶ Sets the profile of the cast relief.
Signature
SetCastRelief(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 (
Validate¶
-
CastReliefParentBuilder.
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.