SetModeBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SetModeBuilder Class

class `NXOpen.Features.ShipDesign.``SetModeBuilder`

  Bases: `NXOpen.Builder`

  This class is used to set the mode to design or manufacturing.

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

  Default values.

  Property | Value
  --- | ---
  ManufacturingDesignMode | DesignMode

  New in version NX8.0.0.

# Properties

Property | Description
--- | ---
DesignElementToSetMode | Returns the design element selection object to be processed in the change of mode processing.
ManufacturingDesignMode | Returns or sets the manufacturing and design mode.
Tag | Returns the Tag for this object.

# 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.
SetMode | Loops through all the parts and sets mode to design or manufacturing
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

SetModeBuilderDesMfgMode Enumeration | Manufacturing Mode type.

# Property Detail

## DesignElementToSetMode

`SetModeBuilder.``DesignElementToSetMode`

  Returns the design element selection object to be processed in the change of mode processing.

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

  Getter Method

  Signature `DesignElementToSetMode`

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

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_mfg_prep (“Ship Manufacturing”)

## ManufacturingDesignMode

`SetModeBuilder.``ManufacturingDesignMode`

  Returns or sets the manufacturing and design mode.

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

  Getter Method

  Signature `ManufacturingDesignMode`

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

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ManufacturingDesignMode`

  Parameters: | manufacturingDesignMode (`NXOpen.Features.ShipDesign.SetModeBuilderDesMfgMode`) –

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_mfg_prep (“Ship Manufacturing”)

# Method Detail

## SetMode

`SetModeBuilder.``SetMode`

  Loops through all the parts and sets mode to design or manufacturing

  Signature `SetMode()`

  Returns: |
  Return type: | int

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_mfg_prep (“Ship Manufacturing”)

## Validate

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