UpdateShipLibraryBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# UpdateShipLibraryBuilder Class

class `NXOpen.Features.ShipDesign.``UpdateShipLibraryBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

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

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

  Default values.

  Property | Value
  --- | ---
  AssemblyOptions | WorkPart
  ShipLibType | Profile

  New in version NX5.3.0.

# Properties

Property | Description
--- | ---
AssemblyOptions | Returns or sets the assembly scope options.
FileBrowser | Returns or sets the file browser
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
ShipLibType | Returns or sets the ship lib type
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.

# 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

UpdateShipLibraryBuilderShipLibAssemblyOption Enumeration | Assembly update library options
UpdateShipLibraryBuilderShipLibOptionType Enumeration | Ship Library Types Note the weld along edge option is no longer used in NX7.

# Property Detail

## AssemblyOptions

`UpdateShipLibraryBuilder.``AssemblyOptions`

  Returns or sets the assembly scope options.

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

  Getter Method

  Signature `AssemblyOptions`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `AssemblyOptions`

  Parameters: | assemblyOptions (`NXOpen.Features.ShipDesign.UpdateShipLibraryBuilderShipLibAssemblyOption`) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## FileBrowser

`UpdateShipLibraryBuilder.``FileBrowser`

  Returns or sets the file browser

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

  Getter Method

  Signature `FileBrowser`

  Returns: |
  Return type: | str

  New in version NX5.3.0.

  License requirements: None.

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

  Setter Method

  Signature `FileBrowser`

  Parameters: | filename (str) –

  New in version NX5.3.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## ShipLibType

`UpdateShipLibraryBuilder.``ShipLibType`

  Returns or sets the ship lib type

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

  Getter Method

  Signature `ShipLibType`

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

  New in version NX5.3.0.

  License requirements: None.

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

  Setter Method

  Signature `ShipLibType`

  Parameters: | shipLibType (`NXOpen.Features.ShipDesign.UpdateShipLibraryBuilderShipLibOptionType`) –

  New in version NX5.3.0.

  License requirements: nx_ship_concept (“Ship Concept”)

# Method Detail

## Validate

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