ShipNamesListBuilder Class¶
-
class
NXOpen.Features.ShipDesign.ShipNamesListBuilder¶ Bases:
NXOpen.TaggedObject,NXOpen.GeometricUtilities.IComponentBuilderThis class provides a list of :py:class:`NXOpen.Features.ShipDesign.ShipNamesBuilder`objects.
A ShipNamesBuilder provides the data necessary to generate names for new Ship objects, such as Decks, Bulkheads, etc. So the ShipNamesListBuilder is a means for defining and modifying ShipNamesBuilders for multiple types of Ship objects. For example, in copying or mirroring Ship content, it is necessary to have a ShipNamesBuilder for each type of Ship object being copied / mirrored.
This is an abtract class. It cannot be instantiated.
New in version NX9.0.2.
Properties¶
| Property | Description |
|---|---|
| ShipNamesList | Returns the list of ShipNamesBuilder objects |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| ResetNameList | Sets the current list of NXOpen.Features.ShipDesign.ShipNamesBuilder objects to be empty. |
| SetObjectTypes | Sets the current list of NXOpen.Features.ShipDesign.ShipNamesBuilder objects to the types determined by the types of the supplied objects. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
ShipNamesList¶
-
ShipNamesListBuilder.ShipNamesList¶ Returns the list of ShipNamesBuilder objects
-------------------------------------Getter Method
Signature
ShipNamesListReturns: Return type: NXOpen.Features.ShipDesign.ShipNamesBuilderListNew in version NX9.0.2.
License requirements: None.
Method Detail¶
ResetNameList¶
-
ShipNamesListBuilder.ResetNameList¶ Sets the current list of
NXOpen.Features.ShipDesign.ShipNamesBuilderobjects to be empty.Returned will be error code.
Signature
ResetNameList()New in version NX10.0.0.
License requirements: None.
SetObjectTypes¶
-
ShipNamesListBuilder.SetObjectTypes¶ Sets the current list of
NXOpen.Features.ShipDesign.ShipNamesBuilderobjects to the types determined by the types of the supplied objects.For example, if within objects, there is a Deck and 2 Tranverse Bulkheads, then the list of
NXOpen.Features.ShipDesign.ShipNamesBuilderbuilders will have Deck and Tranverse Bulkhead builders added (if they are not there already).Returned will be the number and pointers to any new builders added.
Signature
SetObjectTypes(objects)Parameters: objects (list of NXOpen.NXObject) –Returns: Return type: list of NXOpen.Features.ShipDesign.ShipNamesBuilderNew in version NX10.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
Validate¶
-
ShipNamesListBuilder.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.