MaterialAllowanceBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# MaterialAllowanceBuilder Class

class `NXOpen.Features.ShipDesign.``MaterialAllowanceBuilder`

  Bases: `NXOpen.Builder`

  Represents the material allowance feature builder to examine steel feature.

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

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
AllowanceValue | Returns or sets the allowance value to set the material.
Tag | Returns the Tag for this object.
ValidFace | Returns the faces to set the material.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
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.
GetObject | Returns the object currently being edited by this builder.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## AllowanceValue

`MaterialAllowanceBuilder.``AllowanceValue`

  Returns or sets the allowance value to set the material.

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

  Getter Method

  Signature `AllowanceValue`

  Returns: |
  Return type: | float

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AllowanceValue`

  Parameters: | allowanceValue (float) –

  New in version NX10.0.0.

  License requirements: nx_ship_mfg_prep (“Ship Manufacturing”)

## ValidFace

`MaterialAllowanceBuilder.``ValidFace`

  Returns the faces to set the material.

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

  Getter Method

  Signature `ValidFace`

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

  New in version NX10.0.0.

  License requirements: None.

# Method Detail

## Validate

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