ShipPreparationBuilder Class¶
-
class
NXOpen.Features.ShipDesign.ShipPreparationBuilder¶ Bases:
NXOpen.Features.FeatureBuilderCreates 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.CreateShipPreparationBuilderDefault values.
Property Value AngleTolerance 0.5 DistanceTolerance 0.01 New in version NX10.0.0.
Properties¶
| Property | Description |
|---|---|
| AngleTolerance | Returns or sets the angle tolerance. |
| DistanceTolerance | Returns or sets the distance tolerance. |
| 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 |
| 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 @return |
| 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. |
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.
License requirements: None.
-------------------------------------Setter Method
Signature
AngleTolerance(angleTolerance)Parameters: angleTolerance (float) – New in version NX10.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(distanceTolerance)Parameters: distanceTolerance (float) – New in version NX10.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.SelectComponentListNew in version NX10.0.0.
License requirements: None.
Method Detail¶
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.