CompareModeBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# CompareModeBuilder Class

class `NXOpen.Features.ShipDesign.``CompareModeBuilder`

  Bases: `NXOpen.Builder`

  This class is used to compare between the two Shipbuilding modes of Design and Manufacturing.

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

  Default values.

  Property | Value
  --- | ---
  CompareEmphasizeMode | DesignMode

  New in version NX8.0.0.

# Properties

Property | Description
--- | ---
CompareEmphasizeMode | Returns or sets the compare emphasize mode.
DesignElementToCompare | Returns the design element selection object to be processed in the change of mode comparing.
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.
RestoreDisplay | Restores the display and removes the compare between the Design vs Manufacturing data
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateDisplay | Loops through all the parts and updates the display to show the compare between the Design vs Manufacturing data
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

CompareModeBuilderCompareMode Enumeration | Compare Mode type

# Property Detail

## CompareEmphasizeMode

`CompareModeBuilder.``CompareEmphasizeMode`

  Returns or sets the compare emphasize mode.

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

  Getter Method

  Signature `CompareEmphasizeMode`

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

  New in version NX8.0.0.

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

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

  Setter Method

  Signature `CompareEmphasizeMode`

  Parameters: | compareEmphasizeMode (`NXOpen.Features.ShipDesign.CompareModeBuilderCompareMode`) –

  New in version NX8.0.0.

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

## DesignElementToCompare

`CompareModeBuilder.``DesignElementToCompare`

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

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

  Getter Method

  Signature `DesignElementToCompare`

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

# Method Detail

## RestoreDisplay

`CompareModeBuilder.``RestoreDisplay`

  Restores the display and removes the compare between the Design vs Manufacturing data

  Signature `RestoreDisplay(singleparttorestore)`

  Parameters: | singleparttorestore (`NXOpen.Assemblies.Component`) –

  New in version NX8.0.0.

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

## UpdateDisplay

`CompareModeBuilder.``UpdateDisplay`

  Loops through all the parts and updates the display to show the compare between the Design vs Manufacturing data

  Signature `UpdateDisplay()`

  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

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