ExcessMaterialBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ExcessMaterialBuilder Class

class `NXOpen.Features.ShipDesign.``ExcessMaterialBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Features.ShipDesign.ExcessMaterial` builder.

  The Excess Material feature adds excess manufacturing material to the end of plate.

  To create a new instance of this class, use `NXOpen.Features.ShipCollection.CreateExcessMaterialBuilder()`

  Default values.

  Property | Value
  --- | ---
  EndOffset.Value | 10 (millimeters part), 10 (inches part)
  ExtendEndFace | 0
  ExtendStartFace | 0
  OffsetDistance.Value (deprecated) | 10 (millimeters part), 10 (inches part)
  OffsetType | Constant
  StartOffset.Value | 10 (millimeters part), 10 (inches part)

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
EndOffset | Returns the end offset (only applicable for excess material with variable offsets, fitup and constant offset excess material will ignore this value)
ExtendEndFace | Returns or sets the extend end side face option (not applicable for fitup)
ExtendStartFace | Returns or sets the extend start side face option (not applicable for fitup)
OffsetDistance | Returns the offset distance
OffsetType | Returns or sets the offset type (only applicable for excess material, fitup will ignore the offset 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
SelectFace | Returns the selection face.
SelectFaces | Returns the faces that need to have excess material.
StartOffset | Returns the start offset (replaces the legacy offset distance property, and is used for both excess material and fitup)
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Type | Returns or sets the feature type (ie excess material or fitup)
Version | Returns the version of the feature (used to determine which properties and methods are applicable) during edit.

# 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.
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.
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

ExcessMaterialBuilderOffset Enumeration | The offset type (only applicable for excess material, fitup will ignore the offset type)
ExcessMaterialBuilderTypes Enumeration | The feature type
ExcessMaterialBuilderVersionID Enumeration | version identifiers for the different revisions of the excess material feature.

# Property Detail

## EndOffset

`ExcessMaterialBuilder.``EndOffset`

  Returns the end offset (only applicable for excess material with variable offsets, fitup and constant offset excess material will ignore this value)

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

  Getter Method

  Signature `EndOffset`

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

  New in version NX9.0.2.

  License requirements: None.

## ExtendEndFace

`ExcessMaterialBuilder.``ExtendEndFace`

  Returns or sets the extend end side face option (not applicable for fitup)

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

  Getter Method

  Signature `ExtendEndFace`

  Returns: |
  Return type: | bool

  New in version NX9.0.2.

  License requirements: None.

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

  Setter Method

  Signature `ExtendEndFace`

  Parameters: | extendEndFace (bool) –

  New in version NX9.0.2.

  License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)

## ExtendStartFace

`ExcessMaterialBuilder.``ExtendStartFace`

  Returns or sets the extend start side face option (not applicable for fitup)

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

  Getter Method

  Signature `ExtendStartFace`

  Returns: |
  Return type: | bool

  New in version NX9.0.2.

  License requirements: None.

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

  Setter Method

  Signature `ExtendStartFace`

  Parameters: | extendStartFace (bool) –

  New in version NX9.0.2.

  License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)

## OffsetDistance

`ExcessMaterialBuilder.``OffsetDistance`

  Returns the offset distance

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

  Getter Method

  Signature `OffsetDistance`

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

  New in version NX7.5.0.

  Deprecated since version NX9.0.2: Use `NXOpen.Features.ShipDesign.ExcessMaterialBuilder.StartOffset()` instead.

  License requirements: None.

## OffsetType

`ExcessMaterialBuilder.``OffsetType`

  Returns or sets the offset type (only applicable for excess material, fitup will ignore the offset type)

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

  Getter Method

  Signature `OffsetType`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.ExcessMaterialBuilderOffset`

  New in version NX9.0.2.

  License requirements: None.

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

  Setter Method

  Signature `OffsetType`

  Parameters: | offsetType (`NXOpen.Features.ShipDesign.ExcessMaterialBuilderOffset`) –

  New in version NX9.0.2.

  License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)

## SelectFace

`ExcessMaterialBuilder.``SelectFace`

  Returns the selection face.

  The selected face will be offset by the specified distance.

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

  Getter Method

  Signature `SelectFace`

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

  New in version NX7.5.0.

  Deprecated since version NX8.0.0: Use `NXOpen.Features.ShipDesign.ExcessMaterialBuilder.SelectFaces()` instead.

  License requirements: None.

## SelectFaces

`ExcessMaterialBuilder.``SelectFaces`

  Returns the faces that need to have excess material.

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

  Getter Method

  Signature `SelectFaces`

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

  New in version NX8.0.0.

  License requirements: None.

## StartOffset

`ExcessMaterialBuilder.``StartOffset`

  Returns the start offset (replaces the legacy offset distance property, and is used for both excess material and fitup)

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

  Getter Method

  Signature `StartOffset`

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

  New in version NX9.0.2.

  License requirements: None.

## Type

`ExcessMaterialBuilder.``Type`

  Returns or sets the feature type (ie excess material or fitup)

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

  Getter Method

  Signature `Type`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.ExcessMaterialBuilderTypes`

  New in version NX9.0.2.

  License requirements: None.

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

  Setter Method

  Signature `Type`

  Parameters: | type (`NXOpen.Features.ShipDesign.ExcessMaterialBuilderTypes`) –

  New in version NX9.0.2.

  License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)

## Version

`ExcessMaterialBuilder.``Version`

  Returns the version of the feature (used to determine which properties and methods are applicable) during edit.

  The version of new features during create will be NX902

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

  Getter Method

  Signature `Version`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.ExcessMaterialBuilderVersionID`

  New in version NX9.0.2.

  License requirements: None.

# Method Detail

## Validate

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