Represents a room builder for general arrangement. More...

Inheritance diagram for NXOpen.Features.ShipDesign.RoomBuilder:

Public Types
enum	Types { Create, Adopt }
	The room types. More...

Public Member Functions
unsafe void	AdoptChanged ()
	Notifies system that the room creation type is changed to Adopt mode to reset room attributes. More...

unsafe void	EvaluateAttributes (bool bUpdateRoomAreaAndVolume)
	Evaluates room attributes. More...

unsafe void	GetCreatedRoomBodies (out NXOpen.TaggedObject[] createdRoomBodies)
	Gets the created room bodies. More...

unsafe void	UpdateTypeForAttributeListBuilder ()
	Updates room type which is either creation or adopt to the attribute list builder. More...

Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject	Commit ()
	Commits any edits that have been applied to the builder. More...

unsafe void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

unsafe NXOpen.NXObject[]	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

unsafe NXOpen.NXObject	GetObject ()
	Returns the object currently being edited by this builder. More...

unsafe void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

unsafe bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe NXOpen.SelectBody	AdoptionBody `[get]`
	Returns the body to be adopted as a room. More...

unsafe NXOpen.Features.ShipDesign.RoomAttributeListBuilder	AttributeList `[get]`
	Returns the room attribute list. More...

unsafe bool	CreateCogPoints `[get, set]`
	Returns or sets the option to indicate whether to COG gross and net points for the room or not. More...

unsafe bool	CreateRoomWithReferenceComponent `[get, set]`
	Returns or sets the option to indicate whether to create reference component for the room or not. More...

unsafe bool	CreateRoomWithWall `[get, set]`
	Returns or sets the option to indicate whether to create wall for the room or not. More...

unsafe NXOpen.SelectBodyList	Deck `[get]`
	Returns the deck body. More...

unsafe double	DistanceTolerance `[get, set]`
	Returns or sets the distance tolerance which is used in room body creation. More...

unsafe NXOpen.NXColor	RoomColor `[get, set]`
	Returns or sets the color to be assigned to the created room body. More...

unsafe NXOpen.Section	Section `[get]`
	Returns the section. More...

unsafe NXOpen.Features.ShipDesign.ShipNamesBuilder	ShipNames `[get]`
	Returns the ship name. More...

unsafe NXOpen.Features.ShipDesign.RoomThicknessItemBuilderList	ThicknessList `[get]`
	Returns the room thicknesses list. More...

unsafe NXOpen.Features.ShipDesign.RoomBuilder.Types	Type `[get, set]`
	Returns or sets the room generation type. More...

unsafe NXOpen.Expression	WallThickness `[get]`
	Returns the wall thickness. More...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

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)

Created in NX12.0.0

Member Enumeration Documentation

enum NXOpen.Features.ShipDesign.RoomBuilder.Types

The room types.

This option specifies how the room is generated.

Enumerator
Create	Creates a room from boundary object and deck
Adopt	Adopt a room from existing body

Member Function Documentation

unsafe void NXOpen.Features.ShipDesign.RoomBuilder.AdoptChanged ( )

inline

Notifies system that the room creation type is changed to Adopt mode to reset room attributes.

Created in NX12.0.2

License requirements: nx_ship_gen_arrange ("Ship General Arrangement")

unsafe void NXOpen.Features.ShipDesign.RoomBuilder.EvaluateAttributes ( bool bUpdateRoomAreaAndVolume )

inline

Evaluates room attributes.

Created in NX12.0.2

License requirements: nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

bUpdateRoomAreaAndVolume

unsafe void NXOpen.Features.ShipDesign.RoomBuilder.GetCreatedRoomBodies ( out NXOpen.TaggedObject[] createdRoomBodies )

inline

Gets the created room bodies.

Created in NX1899.0.0

License requirements: nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

createdRoomBodies

unsafe void NXOpen.Features.ShipDesign.RoomBuilder.UpdateTypeForAttributeListBuilder ( )

inline

Updates room type which is either creation or adopt to the attribute list builder.

Created in NX12.0.2

License requirements: nx_ship_gen_arrange ("Ship General Arrangement")

Property Documentation

unsafe NXOpen.SelectBody NXOpen.Features.ShipDesign.RoomBuilder.AdoptionBody

get

Returns the body to be adopted as a room.

Created in NX12.0.0

License requirements: None.

unsafe NXOpen.Features.ShipDesign.RoomAttributeListBuilder NXOpen.Features.ShipDesign.RoomBuilder.AttributeList

get

Returns the room attribute list.

The room attributes defines attributes those are applied to the room component and body.

Created in NX12.0.0

License requirements: None.

unsafe bool NXOpen.Features.ShipDesign.RoomBuilder.CreateCogPoints

getset

Returns or sets the option to indicate whether to COG gross and net points for the room or not.

Created in NX1899.0.0

License requirements to get this property: None.

License requirements to set this property: nx_ship_gen_arrange ("Ship General Arrangement")

unsafe bool NXOpen.Features.ShipDesign.RoomBuilder.CreateRoomWithReferenceComponent

getset

Returns or sets the option to indicate whether to create reference component for the room or not.

Created in NX12.0.2

License requirements to get this property: None.

License requirements to set this property: nx_ship_gen_arrange ("Ship General Arrangement")

unsafe bool NXOpen.Features.ShipDesign.RoomBuilder.CreateRoomWithWall

getset

Returns or sets the option to indicate whether to create wall for the room or not.

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: nx_ship_gen_arrange ("Ship General Arrangement")

unsafe NXOpen.SelectBodyList NXOpen.Features.ShipDesign.RoomBuilder.Deck

get

Returns the deck body.

The deck body defines the owning deck of this room.

Created in NX12.0.0

License requirements: nx_ship_gen_arrange ("Ship General Arrangement")

unsafe double NXOpen.Features.ShipDesign.RoomBuilder.DistanceTolerance

getset

Returns or sets the distance tolerance which is used in room body creation.

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: nx_ship_gen_arrange ("Ship General Arrangement")

unsafe NXOpen.NXColor NXOpen.Features.ShipDesign.RoomBuilder.RoomColor

getset

Returns or sets the color to be assigned to the created room body.

Created in NX12.0.2

License requirements to get this property: None.

License requirements to set this property: nx_ship_gen_arrange ("Ship General Arrangement")

unsafe NXOpen.Section NXOpen.Features.ShipDesign.RoomBuilder.Section

get

Returns the section.

The section defines the room boundary.

Created in NX12.0.0

License requirements: None.

unsafe NXOpen.Features.ShipDesign.ShipNamesBuilder NXOpen.Features.ShipDesign.RoomBuilder.ShipNames

get

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.

Created in NX12.0.0

License requirements: None.

unsafe NXOpen.Features.ShipDesign.RoomThicknessItemBuilderList NXOpen.Features.ShipDesign.RoomBuilder.ThicknessList

get

Returns the room thicknesses list.

The thickness list is used for creating wall. It is only used when NXOpen.Features.ShipDesign.RoomBuilder.CreateRoomWithWall is set to true. There should be one floor thickness, one ceiling thickness and multiple wall thicknesses.

Created in NX12.0.1

License requirements: None.

unsafe NXOpen.Features.ShipDesign.RoomBuilder.Types NXOpen.Features.ShipDesign.RoomBuilder.Type

getset

Returns or sets the room generation type.

If you set the type to Features.ShipDesign.RoomBuilder.Types.Create , then please also set values for below properties:

If you set the type to Features.ShipDesign.RoomBuilder.Types.Adopt , then please also set values for below properties:

NXOpen.Features.ShipDesign.RoomBuilder.AdoptionBody

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: nx_ship_gen_arrange ("Ship General Arrangement")

unsafe NXOpen.Expression NXOpen.Features.ShipDesign.RoomBuilder.WallThickness

get

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. Use this method when the floor and all walls have the same thickness. Otherwise use NXOpen.Features.ShipDesign.RoomBuilder.ThicknessList to set different thicknesses for floor, ceiling and walls.

Created in NX12.0.0

License requirements: None.

The documentation for this class was generated from the following file:

Features_ShipDesign_RoomBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation