ShipPreparationBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ShipPreparationBuilder Class

class `NXOpen.Features.ShipDesign.``ShipPreparationBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Creates a builder used to prepare basic design data for meshing.

  Multiple features are created as a result of committing this builder. To create a new instance of this class, use `NXOpen.Features.ShipCollection.CreateShipPreparationBuilder()`

  Default values.

  Property | Value
  --- | ---
  BlendRadius | 100.0 (millimeters part), 4.0 (inches part)
  HoleDiameter | 300.0 (millimeters part), 12.0 (inches part)
  RemoveBlends | true
  RemoveOpenings | true

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
AngleTolerance | Returns or sets the angle tolerance.
BlendRadius | Returns or sets the blend radius.
DistanceTolerance | Returns or sets the distance tolerance.
HoleDiameter | Returns or sets the hole diameter.
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
RemoveBlends | Returns or sets the option to remove blends.
RemoveOpenings | Returns or sets the option to remove openings.
ShipComponents | Returns the components containing basic design data to prepare for meshing.
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
ConvertSeamCurves | Converts intersection seam curves to edges on the linked bodies if found.
CreateBasicDesignData | Creates a empty basic design data object.
CreateUpdateDivide | Creates or updates the divide feature.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
FinalizeProcessing | Cleans up all old ship preparation features, runs update and updates edge pairing.
FindBasicDesignData | Outputs the basic design data found in the given components.
FindShipComponents | Outputs the basic design components found in the loaded assembly.
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.
GetPairedEdge | Outputs the edge that is paired with the inEdge it it exists.
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetEdgePair | Sets the pairing data between the two edges input.
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
UpdateEdgePairing | Updates the edge pair information.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.
WaveLinkBasicDesignData | Wave links in the proper basic design data, if not already linked, into the work part.

# Property Detail

## AngleTolerance

`ShipPreparationBuilder.``AngleTolerance`

  Returns or sets the angle tolerance.

  Used in curve approximation.

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

  Getter Method

  Signature `AngleTolerance`

  Returns: |
  Return type: | float

  New in version NX10.0.0.

  Deprecated since version NX11.0.0: Removed with no replacement.

  License requirements: None.

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

  Setter Method

  Signature `AngleTolerance`

  Parameters: | angleTolerance (float) –

  New in version NX10.0.0.

  Deprecated since version NX11.0.0: Removed with no replacement.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## BlendRadius

`ShipPreparationBuilder.``BlendRadius`

  Returns or sets the blend radius.

  If `Features.ShipDesign.ShipPreparationBuilder.RemoveBlends`()` is true then blends that that are less than or equal to this radius will be removed from plate systems.

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

  Getter Method

  Signature `BlendRadius`

  Returns: |
  Return type: | float

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `BlendRadius`

  Parameters: | blendRadius (float) –

  New in version NX11.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## DistanceTolerance

`ShipPreparationBuilder.``DistanceTolerance`

  Returns or sets the distance tolerance.

  Used in edge pairing to determine if edges are close.

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

  Getter Method

  Signature `DistanceTolerance`

  Returns: |
  Return type: | float

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DistanceTolerance`

  Parameters: | distanceTolerance (float) –

  New in version NX10.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## HoleDiameter

`ShipPreparationBuilder.``HoleDiameter`

  Returns or sets the hole diameter.

  If `Features.ShipDesign.ShipPreparationBuilder.RemoveOpenings`()` is true then openings that fit inside a circle with this diameter will be removed from plate systems.

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

  Getter Method

  Signature `HoleDiameter`

  Returns: |
  Return type: | float

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `HoleDiameter`

  Parameters: | holeDiameter (float) –

  New in version NX11.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## RemoveBlends

`ShipPreparationBuilder.``RemoveBlends`

  Returns or sets the option to remove blends.

  If true, blends with a radius less than or equal to `Features.ShipDesign.ShipPreparationBuilder.BlendRadius`()` will be removed from plate systems.

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

  Getter Method

  Signature `RemoveBlends`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RemoveBlends`

  Parameters: | removeBlends (bool) –

  New in version NX11.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## RemoveOpenings

`ShipPreparationBuilder.``RemoveOpenings`

  Returns or sets the option to remove openings.

  If true, openings that fit inside a circle with diameter `Features.ShipDesign.ShipPreparationBuilder.HoleDiameter`()` will be removed from plate systems.

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

  Getter Method

  Signature `RemoveOpenings`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RemoveOpenings`

  Parameters: | removeOpenings (bool) –

  New in version NX11.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## ShipComponents

`ShipPreparationBuilder.``ShipComponents`

  Returns the components containing basic design data to prepare for meshing.

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

  Getter Method

  Signature `ShipComponents`

  Returns: |
  Return type: | `NXOpen.Assemblies.SelectComponentList`

  New in version NX10.0.0.

  License requirements: None.

# Method Detail

## ConvertSeamCurves

`ShipPreparationBuilder.``ConvertSeamCurves`

  Converts intersection seam curves to edges on the linked bodies if found.

  This method should be called after all linked plate system body features are created or updated. If any new `NXOpen.Features.ShipDesign.ShipPreparationInfoTypes.LinkedEdges` preparation data is created, it is output.

  Signature `ConvertSeamCurves()`

  Returns: | Additional basic design data to be processed.
  Return type: | list of `NXOpen.Features.ShipDesign.ShipPreparationInfo`

  New in version NX11.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## CreateBasicDesignData

`ShipPreparationBuilder.``CreateBasicDesignData`

  Creates a empty basic design data object.

  The caller should not delete this object.

  Signature `CreateBasicDesignData()`

  Returns: | The basic design data that was created.
  Return type: | `NXOpen.Features.ShipDesign.ShipPreparationInfo`

  New in version NX11.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## CreateUpdateDivide

`ShipPreparationBuilder.``CreateUpdateDivide`

  Creates or updates the divide feature.

  The basic design data is updated to contain the newly created feature if necessary.

  Signature `CreateUpdateDivide(data)`

  Parameters: | data (`NXOpen.Features.ShipDesign.ShipPreparationInfo`) – The basic design data to create or update the divide feature.

  New in version NX11.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## FinalizeProcessing

`ShipPreparationBuilder.``FinalizeProcessing`

  Cleans up all old ship preparation features, runs update and updates edge pairing.

  This method should be called after all other processing is completed.

  Signature `FinalizeProcessing()`

  New in version NX11.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## FindBasicDesignData

`ShipPreparationBuilder.``FindBasicDesignData`

  Outputs the basic design data found in the given components.

  First the work part is searched for any existing ship preparation data. The caller should not delete this data.

  Signature `FindBasicDesignData(components)`

  Parameters: | components (list of `NXOpen.Assemblies.Component`) – The basic design part occurrences to find data in.
  Returns: | The basic design data to be processed.
  Return type: | list of `NXOpen.Features.ShipDesign.ShipPreparationInfo`

  New in version NX11.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## FindShipComponents

`ShipPreparationBuilder.``FindShipComponents`

  Outputs the basic design components found in the loaded assembly.

  Signature `FindShipComponents()`

  Returns: | a tuple
  Return type: | A tuple consisting of (components, componentsProcessed). components is a list of `NXOpen.Assemblies.Component`. The basic design part occurrences. componentsProcessed is a list of bool. Indication if the part occurrence has already been processed.

  New in version NX11.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## GetPairedEdge

`ShipPreparationBuilder.``GetPairedEdge`

  Outputs the edge that is paired with the inEdge it it exists.

  This pairing information is used in the CAE application when stitching edges.

  Signature `GetPairedEdge(inEdge)`

  Parameters: | inEdge (`NXOpen.Edge`) – The edge to get it’s pair.
  Returns: | The paired edge if there is one None if not paired.
  Return type: | `NXOpen.Edge`

  New in version NX11.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## SetEdgePair

`ShipPreparationBuilder.``SetEdgePair`

  Sets the pairing data between the two edges input.

  This pairing information is used in the CAE application when stitching edges.

  Signature `SetEdgePair(edge1, edge2)`

  Parameters:

  - edge1 (`NXOpen.Edge`) – One of the edge pairs.
  - edge2 (`NXOpen.Edge`) – One of the edge pairs.

  New in version NX11.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## UpdateEdgePairing

`ShipPreparationBuilder.``UpdateEdgePairing`

  Updates the edge pair information.

  This method should be called after all plate divide features are created or updated.

  Signature `UpdateEdgePairing()`

  New in version NX11.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## Validate

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

## WaveLinkBasicDesignData

`ShipPreparationBuilder.``WaveLinkBasicDesignData`

  Wave links in the proper basic design data, if not already linked, into the work part.

  The data is updated to reflect the new linked data.

  Signature `WaveLinkBasicDesignData(data)`

  Parameters: | data (`NXOpen.Features.ShipDesign.ShipPreparationInfo`) – The basic design data to be wave linked.

  New in version NX11.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)