RoomBuilder Class¶
-
class
NXOpen.Features.ShipDesign.
RoomBuilder
¶ Bases:
NXOpen.Builder
Represents a room builder for general arrangement.
This builder is used to define a room.
To create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateRoomBuilder()
Default values.
Property Value WallThickness.Value 7 (millimeters part), 0.25 (inches part) New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
AdoptionBody | Returns the body to be adopted as a room. |
AttributeList | Returns the room attribute list. |
CreateRoomWithWall | Returns or sets the option to indicate whether to create wall for the room or not. |
Deck | Returns the deck body. |
DistanceTolerance | Returns or sets the distance tolerance which is used in room body creation. |
Section | Returns the section. |
ShipNames | Returns the ship name. |
Tag | Returns the Tag for this object. |
Type | Returns or sets the room generation type. |
WallThickness | Returns the wall thickness. |
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. |
Enumerations¶
RoomBuilderTypes Enumeration | The room types. |
Property Detail¶
AdoptionBody¶
-
RoomBuilder.
AdoptionBody
¶ Returns the body to be adopted as a room.
-------------------------------------
Getter Method
Signature
AdoptionBody
Returns: Return type: NXOpen.SelectBody
New in version NX12.0.0.
License requirements: None.
AttributeList¶
-
RoomBuilder.
AttributeList
¶ Returns the room attribute list.
The room attributes defines attributes those are applied to the room component and body.
-------------------------------------
Getter Method
Signature
AttributeList
Returns: room attribute list Return type: NXOpen.Features.ShipDesign.RoomAttributeListBuilder
New in version NX12.0.0.
License requirements: None.
CreateRoomWithWall¶
-
RoomBuilder.
CreateRoomWithWall
¶ Returns or sets the option to indicate whether to create wall for the room or not.
-------------------------------------
Getter Method
Signature
CreateRoomWithWall
Returns: Return type: bool New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CreateRoomWithWall
Parameters: createRoomWithWall (bool) – New in version NX12.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”)
Deck¶
-
RoomBuilder.
Deck
¶ Returns the deck body.
The deck body defines the owning deck of this room.
-------------------------------------
Getter Method
Signature
Deck
Returns: Return type: NXOpen.SelectBodyList
New in version NX12.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”)
DistanceTolerance¶
-
RoomBuilder.
DistanceTolerance
¶ Returns or sets the distance tolerance which is used in room body creation.
-------------------------------------
Getter Method
Signature
DistanceTolerance
Returns: Return type: float New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DistanceTolerance
Parameters: distanceTolerance (float) – New in version NX12.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”)
Section¶
-
RoomBuilder.
Section
¶ Returns the section.
The section defines the room boundary.
-------------------------------------
Getter Method
Signature
Section
Returns: Return type: NXOpen.Section
New in version NX12.0.0.
License requirements: None.
ShipNames¶
-
RoomBuilder.
ShipNames
¶ Returns the ship name.
The ship name is used to assign name to the room container.
It is only used when the work part is deck container, where a new room part will be created.
-------------------------------------
Getter Method
Signature
ShipNames
Returns: Ship names Return type: NXOpen.Features.ShipDesign.ShipNamesBuilder
New in version NX12.0.0.
License requirements: None.
Type¶
-
RoomBuilder.
Type
¶ Returns or sets the room generation type.
If you set the type to
Features.ShipDesign.RoomBuilderTypes.Create
, then please also set values for below properties:If you set the type to
Features.ShipDesign.RoomBuilderTypes.Adopt
, then please also set values for below properties:-------------------------------------
Getter Method
Signature
Type
Returns: Return type: NXOpen.Features.ShipDesign.RoomBuilderTypes
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type
Parameters: type ( NXOpen.Features.ShipDesign.RoomBuilderTypes
) –New in version NX12.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”)
WallThickness¶
-
RoomBuilder.
WallThickness
¶ Returns the wall thickness.
The thickness is used for creating wall. It is only used when
NXOpen.Features.ShipDesign.RoomBuilder.CreateRoomWithWall`()
is set to true.-------------------------------------
Getter Method
Signature
WallThickness
Returns: Return type: NXOpen.Expression
New in version NX12.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
RoomBuilder.
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.