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

Inheritance diagram for NXOpen::Features::ShipDesign::RoomBuilder:

Public Types
enum	Types { TypesCreate, TypesAdopt }
	The room types. More...

Public Member Functions
NXOpen::SelectBody *	AdoptionBody ()
	Returns the body to be adopted as a room. More...

NXOpen::Features::ShipDesign::RoomAttributeListBuilder *	AttributeList ()
	Returns. More...

bool	CreateRoomWithWall ()
	Returns the option to indicate whether to create wall for the room or not. More...

NXOpen::SelectBodyList *	Deck ()
	Returns. More...

double	DistanceTolerance ()
	Returns the distance tolerance which is used in room body creation. More...

NXOpen::Section *	Section ()
	Returns. More...

void	SetCreateRoomWithWall (bool createRoomWithWall)
	Sets the option to indicate whether to create wall for the room or not. More...

void	SetDistanceTolerance (double distanceTolerance)
	Sets the distance tolerance which is used in room body creation. More...

void	SetType (NXOpen::Features::ShipDesign::RoomBuilder::Types type)
	Sets. More...

NXOpen::Features::ShipDesign::ShipNamesBuilder *	ShipNames ()
	Returns. More...

NXOpen::Features::ShipDesign::RoomBuilder::Types	Type ()
	Returns. More...

NXOpen::Expression *	WallThickness ()
	Returns. More...

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

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

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

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

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

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. 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
TypesCreate	Creates a room from boundary object and deck.
TypesAdopt	Adopt a room from existing body.

Member Function Documentation

NXOpen::SelectBody* NXOpen::Features::ShipDesign::RoomBuilder::AdoptionBody ( )

Returns the body to be adopted as a room.

Created in NX12.0.0.

License requirements : None

NXOpen::Features::ShipDesign::RoomAttributeListBuilder* NXOpen::Features::ShipDesign::RoomBuilder::AttributeList ( )

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

bool NXOpen::Features::ShipDesign::RoomBuilder::CreateRoomWithWall ( )

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

Created in NX12.0.0.

License requirements : None

NXOpen::SelectBodyList* NXOpen::Features::ShipDesign::RoomBuilder::Deck ( )

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")

double NXOpen::Features::ShipDesign::RoomBuilder::DistanceTolerance ( )

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

Created in NX12.0.0.

License requirements : None

NXOpen::Section* NXOpen::Features::ShipDesign::RoomBuilder::Section ( )

Returns.

the section.

The section defines the room boundary.

Created in NX12.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::RoomBuilder::SetCreateRoomWithWall ( bool createRoomWithWall )

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

Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

createRoomWithWall createroomwithwall

void NXOpen::Features::ShipDesign::RoomBuilder::SetDistanceTolerance ( double distanceTolerance )

Sets the distance tolerance which is used in room body creation.

Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

distanceTolerance distancetolerance

void NXOpen::Features::ShipDesign::RoomBuilder::SetType ( NXOpen::Features::ShipDesign::RoomBuilder::Types type )

Sets.

the room generation type.

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

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

NXOpen::Features::ShipDesign::RoomBuilder::AdoptionBody

Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

type type

NXOpen::Features::ShipDesign::ShipNamesBuilder* NXOpen::Features::ShipDesign::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.

Created in NX12.0.0.

License requirements : None

NXOpen::Features::ShipDesign::RoomBuilder::Types NXOpen::Features::ShipDesign::RoomBuilder::Type ( )

Returns.

the room generation type.

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

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

NXOpen::Features::ShipDesign::RoomBuilder::AdoptionBody

Created in NX12.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::RoomBuilder::WallThickness ( )

Returns.

the wall thickness.

The thickness is used for creating wall. It is only used when NXOpen::Features::ShipDesign::RoomBuilder::CreateRoomWithWall and NXOpen::Features::ShipDesign::RoomBuilder::SetCreateRoomWithWall is set to true.

Created in NX12.0.0.

License requirements : None

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

Features_ShipDesign_RoomBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation