RoomContainerBuilder Class¶
-
class
NXOpen.Features.ShipDesign.
RoomContainerBuilder
¶ Bases:
NXOpen.Builder
Represents a
Features.ShipDesign.RoomContainerBuilder
builderTo create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateRoomContainerBuilder()
New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
DeckBody | Returns the deck body |
DeckPlanSketch | Returns the deck plane sketch |
RoomNamePrefix | Returns or sets the room name prefix |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
AddRoomAndPurpose | The room and purpose |
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¶
DeckBody¶
-
RoomContainerBuilder.
DeckBody
¶ Returns the deck body
-------------------------------------
Getter Method
Signature
DeckBody
Returns: Return type: NXOpen.ScCollector
New in version NX12.0.0.
License requirements: None.
DeckPlanSketch¶
-
RoomContainerBuilder.
DeckPlanSketch
¶ Returns the deck plane sketch
-------------------------------------
Getter Method
Signature
DeckPlanSketch
Returns: Return type: NXOpen.Section
New in version NX12.0.0.
License requirements: None.
RoomNamePrefix¶
-
RoomContainerBuilder.
RoomNamePrefix
¶ Returns or sets the room name prefix
-------------------------------------
Getter Method
Signature
RoomNamePrefix
Returns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RoomNamePrefix
Parameters: roomNamePrefix (str) – New in version NX12.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
Method Detail¶
AddRoomAndPurpose¶
-
RoomContainerBuilder.
AddRoomAndPurpose
¶ The room and purpose
Signature
AddRoomAndPurpose(room, purpose)
Parameters: - room (str) –
- purpose (str) –
New in version NX12.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
Validate¶
-
RoomContainerBuilder.
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.