MaterialEstimationBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# MaterialEstimationBuilder Class

class `NXOpen.Features.ShipDesign.``MaterialEstimationBuilder`

  Bases: `NXOpen.Builder`

  Represents the class Features.

  ShipDesign.MaterialEstimationBuilder which is used to calculate the material estimation information.

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

  Default values.

  Property | Value
  --- | ---
  SelectionMethod | Volume

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
SelectionMethod | Returns or sets the selection method.
ShipStructures | Returns the selected ship structures.
Tag | Returns the Tag for this object.
VolumeBody | Returns the selected volume body.

# 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.
SetFrameParts | Sets the selected frame parts.
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.

# Enumerations

MaterialEstimationBuilderSelectionMethods Enumeration | Settings to indicate how the objects are selected.

# Property Detail

## SelectionMethod

`MaterialEstimationBuilder.``SelectionMethod`

  Returns or sets the selection method.

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

  Getter Method

  Signature `SelectionMethod`

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

  New in version NX10.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

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

  Setter Method

  Signature `SelectionMethod`

  Parameters: | enumSelectionType (`NXOpen.Features.ShipDesign.MaterialEstimationBuilderSelectionMethods`) –

  New in version NX10.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## ShipStructures

`MaterialEstimationBuilder.``ShipStructures`

  Returns the selected ship structures.

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

  Getter Method

  Signature `ShipStructures`

  Returns: | ship basic design plate faces, standard part curves and profile curves.
  Return type: | `NXOpen.SelectDisplayableObjectList`

  New in version NX10.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## VolumeBody

`MaterialEstimationBuilder.``VolumeBody`

  Returns the selected volume body.

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

  Getter Method

  Signature `VolumeBody`

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

  New in version NX10.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

# Method Detail

## SetFrameParts

`MaterialEstimationBuilder.``SetFrameParts`

  Sets the selected frame parts.

  Signature `SetFrameParts(nPartCount)`

  Parameters: | nPartCount (int) –
  Returns: | ship basic design structure component.
  Return type: | `NXOpen.Part`

  New in version NX10.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## Validate

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