ShipContainerBuilder Class¶
-
class
NXOpen.Features.ShipDesign.ShipContainerBuilder¶ Bases:
NXOpen.BuilderThis class is used to specify the “container” part for the Ship Structures application, i.
e., that part that should have newly created Ship Stiffeners, Plates, Standard Parts added to it as assembly components. It also holds the “container” name which is used in the generation of Teamcenter Item IDs for newly created components.
To create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateShipContainerBuilder()New in version NX8.0.0.
Properties¶
| Property | Description |
|---|---|
| ContainerName | Returns or sets the name used in generating Item IDs for newly created Ship objects |
| ContainerPart | Returns or sets the part to which are added newly created Ship objects |
| 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. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
ContainerName¶
-
ShipContainerBuilder.ContainerName¶ Returns or sets the name used in generating Item IDs for newly created Ship objects
-------------------------------------Getter Method
Signature
ContainerNameReturns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ContainerNameParameters: containerName (str) – New in version NX8.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
ContainerPart¶
-
ShipContainerBuilder.ContainerPart¶ Returns or sets the part to which are added newly created Ship objects
-------------------------------------Getter Method
Signature
ContainerPartReturns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ContainerPartParameters: containerPart (str) – New in version NX8.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
Method Detail¶
Validate¶
-
ShipContainerBuilder.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.