SteelInsertSegmentParentBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SteelInsertSegmentParentBuilder Class

class `NXOpen.Die.``SteelInsertSegmentParentBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a Steel Insert Segment Parent sub feature.

  This sub feature is created via the main feature builder.

  New in version NX4.0.0.

# Properties

Property | Description
--- | ---
AddEndPointsSwitch | Returns or sets the add end points switch
BeltThickness | Returns the belt thickness
BuildStatus | Returns the build status of die sisegs
DesignStatus | Returns or sets the design status of die sisegs
DisplayStatus | Returns or sets the display status of die sisegs
ExtensionDistance | Returns the extension distance
ExtensionType | Returns or sets the extension type
InsertType | Returns or sets the insert type
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
ProfileRelief | Returns the profile relief
ProfileReliefToggle | Returns or sets the profile relief
ReliefAngle | Returns the relief angle
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
CreateChild | Creates a child siseg
DeleteChild | Deletes a child siseg
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetChildren | Outputs the children
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.
SetBeltThickness |
SetExtensionDistance |
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
SetProfileRelief |
SetReliefAngle |
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

SteelInsertSegmentParentBuilderExtensionTypeOption Enumeration | Settings for the extension type.
SteelInsertSegmentParentBuilderInsertTypeOption Enumeration | Settings for the insert type.

# Property Detail

## AddEndPointsSwitch

`SteelInsertSegmentParentBuilder.``AddEndPointsSwitch`

  Returns or sets the add end points switch

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

  Getter Method

  Signature `AddEndPointsSwitch`

  Returns: |
  Return type: | int

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `AddEndPointsSwitch`

  Parameters: | addEndPointsSwitch (int) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## BeltThickness

`SteelInsertSegmentParentBuilder.``BeltThickness`

  Returns the belt thickness

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

  Getter Method

  Signature `BeltThickness`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## BuildStatus

`SteelInsertSegmentParentBuilder.``BuildStatus`

  Returns the build status of die sisegs

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

  Getter Method

  Signature `BuildStatus`

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

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## DesignStatus

`SteelInsertSegmentParentBuilder.``DesignStatus`

  Returns or sets the design status of die sisegs

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

  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

`SteelInsertSegmentParentBuilder.``DisplayStatus`

  Returns or sets the display status of die sisegs

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

  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”)

## ExtensionDistance

`SteelInsertSegmentParentBuilder.``ExtensionDistance`

  Returns the extension distance

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

  Getter Method

  Signature `ExtensionDistance`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## ExtensionType

`SteelInsertSegmentParentBuilder.``ExtensionType`

  Returns or sets the extension type

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

  Getter Method

  Signature `ExtensionType`

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

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `ExtensionType`

  Parameters: | extensionType (`NXOpen.Die.SteelInsertSegmentParentBuilderExtensionTypeOption`) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## InsertType

`SteelInsertSegmentParentBuilder.``InsertType`

  Returns or sets the insert type

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

  Getter Method

  Signature `InsertType`

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

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `InsertType`

  Parameters: | insertType (`NXOpen.Die.SteelInsertSegmentParentBuilderInsertTypeOption`) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## ProfileRelief

`SteelInsertSegmentParentBuilder.``ProfileRelief`

  Returns the profile relief

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

  Getter Method

  Signature `ProfileRelief`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## ProfileReliefToggle

`SteelInsertSegmentParentBuilder.``ProfileReliefToggle`

  Returns or sets the profile relief

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

  Getter Method

  Signature `ProfileReliefToggle`

  Returns: |
  Return type: | bool

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

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

  Setter Method

  Signature `ProfileReliefToggle`

  Parameters: | profileReliefToggle (bool) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## ReliefAngle

`SteelInsertSegmentParentBuilder.``ReliefAngle`

  Returns the relief angle

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

  Getter Method

  Signature `ReliefAngle`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

# Method Detail

## CreateChild

`SteelInsertSegmentParentBuilder.``CreateChild`

  Creates a child siseg

  Signature `CreateChild()`

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

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## DeleteChild

`SteelInsertSegmentParentBuilder.``DeleteChild`

  Deletes a child siseg

  Signature `DeleteChild(diesisegchild)`

  Parameters: | diesisegchild (`NXOpen.Die.SteelInsertSegmentChildBuilder`) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## GetChildren

`SteelInsertSegmentParentBuilder.``GetChildren`

  Outputs the children

  Signature `GetChildren()`

  Returns: | children
  Return type: | list of `NXOpen.Die.SteelInsertSegmentChildBuilder`

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## SetBeltThickness

`SteelInsertSegmentParentBuilder.``SetBeltThickness`

  Signature `SetBeltThickness(beltThickness)`

  Parameters: | beltThickness (str) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## SetExtensionDistance

`SteelInsertSegmentParentBuilder.``SetExtensionDistance`

  Signature `SetExtensionDistance(extensionDistance)`

  Parameters: | extensionDistance (str) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## SetProfileRelief

`SteelInsertSegmentParentBuilder.``SetProfileRelief`

  Signature `SetProfileRelief(profileRelief)`

  Parameters: | profileRelief (str) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## SetReliefAngle

`SteelInsertSegmentParentBuilder.``SetReliefAngle`

  Signature `SetReliefAngle(reliefAngle)`

  Parameters: | reliefAngle (str) –

  New in version NX4.0.0.

  License requirements: ug_die_design (“Die Design”)

## Validate

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