ThroatParentBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ThroatParentBuilder Class

class `NXOpen.Die.``ThroatParentBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a Die Throat Parent 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 sections.
DesignStatus | Returns or sets the design status of the throat sections, if true the throat sections will be built into the model, if false they will not.
DisplayStatus | Returns or sets the display status of the throat sections, if true input data to the throat sections 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
Radius | Returns or sets the radius to be applied at the back of the throat, top and bottom
Step | Returns or sets the step to be applied at the end of the tangential extension of the flange
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Type | Returns or sets the type of throat sections.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
CreateChild | Creates a child throat section.
DeleteChild | Deletes a child throat section.
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.
GetChildren | Outputs the child throat sections.
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.
SetExtensionAttributes | Sets the extension 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.
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

ThroatParentBuilderTypeOption Enumeration | Settings for the type of the throat section.

# Property Detail

## BuildStatus

`ThroatParentBuilder.``BuildStatus`

  Returns the build status of the throat sections.

  `-------------------------------------`

  Getter Method

  Signature `BuildStatus`

  Returns: |
  Return type: | `NXOpen.Die.DieBuildStatusOption`

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## DesignStatus

`ThroatParentBuilder.``DesignStatus`

  Returns or sets the design status of the throat sections, if true the throat sections will be built into the model, if false they 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”)

## DisplayStatus

`ThroatParentBuilder.``DisplayStatus`

  Returns or sets the display status of the throat sections, if true input data to the throat sections 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”)

## Radius

`ThroatParentBuilder.``Radius`

  Returns or sets the radius to be applied at the back of the throat, top and bottom

  `-------------------------------------`

  Getter Method

  Signature `Radius`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

  `-------------------------------------`

  Setter Method

  Signature `Radius`

  Parameters: | radius (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## Step

`ThroatParentBuilder.``Step`

  Returns or sets the step to be applied at the end of the tangential extension of the flange

  `-------------------------------------`

  Getter Method

  Signature `Step`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

  `-------------------------------------`

  Setter Method

  Signature `Step`

  Parameters: | step (float) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## Type

`ThroatParentBuilder.``Type`

  Returns or sets the type of throat sections.

  `-------------------------------------`

  Getter Method

  Signature `Type`

  Returns: |
  Return type: | `NXOpen.Die.ThroatParentBuilderTypeOption`

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

  `-------------------------------------`

  Setter Method

  Signature `Type`

  Parameters: | type (`NXOpen.Die.ThroatParentBuilderTypeOption`) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

# Method Detail

## CreateChild

`ThroatParentBuilder.``CreateChild`

  Creates a child throat section.

  Signature `CreateChild()`

  Returns: |
  Return type: | `NXOpen.Die.ThroatChildBuilder`

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## DeleteChild

`ThroatParentBuilder.``DeleteChild`

  Deletes a child throat section.

  Signature `DeleteChild(diethroatchild)`

  Parameters: | diethroatchild (`NXOpen.Die.ThroatChildBuilder`) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## GetCavityAttributes

`ThroatParentBuilder.``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”)

## GetChildren

`ThroatParentBuilder.``GetChildren`

  Outputs the child throat sections.

  Signature `GetChildren()`

  Returns: | The child throat sections.
  Return type: | list of `NXOpen.Die.ThroatChildBuilder`

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## GetExtensionAttributes

`ThroatParentBuilder.``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

`ThroatParentBuilder.``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”)

## SetExtensionAttributes

`ThroatParentBuilder.``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”)

## Validate

`ThroatParentBuilder.``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.