DecksBuilder Class¶
-
class
NXOpen.Features.ShipDesign.DecksBuilder¶ Bases:
NXOpen.Features.FeatureBuilderRepresents a
NXOpen.Features.ShipDesign.Decksbuilder.To create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateDecksBuilder()New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| AutoDeckName | Returns or sets the deck name. |
| AutoNameToggle | Returns or sets the auto name toggle |
| DeckList | Returns the list of NXOpen.Features.ShipDesign.DeckListItemBuilder defining the decks parameters. |
| 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 |
| 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 |
| CreateDeckListItemBuilder | Creates a NXOpen.Features.ShipDesign.DeckListItemBuilder. |
| 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¶
AutoDeckName¶
-
DecksBuilder.AutoDeckName¶ Returns or sets the deck name.
-------------------------------------Getter Method
Signature
AutoDeckNameReturns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AutoDeckNameParameters: deckName (str) – New in version NX5.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
AutoNameToggle¶
-
DecksBuilder.AutoNameToggle¶ Returns or sets the auto name toggle
-------------------------------------Getter Method
Signature
AutoNameToggleReturns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AutoNameToggleParameters: autoNameToggle (bool) – New in version NX5.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
DeckList¶
-
DecksBuilder.DeckList¶ Returns the list of
NXOpen.Features.ShipDesign.DeckListItemBuilderdefining the decks parameters.-------------------------------------Getter Method
Signature
DeckListReturns: Return type: NXOpen.Features.ShipDesign.DeckListItemBuilderListNew in version NX5.0.0.
License requirements: None.
Method Detail¶
CreateDeckListItemBuilder¶
-
DecksBuilder.CreateDeckListItemBuilder¶ Creates a
NXOpen.Features.ShipDesign.DeckListItemBuilder.Signature
CreateDeckListItemBuilder()Returns: Return type: NXOpen.Features.ShipDesign.DeckListItemBuilderNew in version NX8.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
Validate¶
-
DecksBuilder.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.