NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Features::ShipDesign::RoomContainerBuilder Class Reference

Represents a Features::ShipDesign::RoomContainerBuilder builder
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateRoomContainerBuilder

Created in NX12.0.0. More...

Inheritance diagram for NXOpen::Features::ShipDesign::RoomContainerBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

void AddRoomAndPurpose (const NXString &room, const NXString &purpose)
 The room and purpose
Created in NX12.0.0. More...
 
void AddRoomAndPurpose (const char *room, const char *purpose)
 The room and purpose
Created in NX12.0.0. More...
 
NXOpen::ScCollectorDeckBody ()
 Returns the deck body
Created in NX12.0.0. More...
 
NXOpen::SectionDeckPlanSketch ()
 Returns the deck plane sketch
Created in NX12.0.0. More...
 
NXString RoomNamePrefix ()
 Returns the room name prefix
Created in NX12.0.0. More...
 
void SetRoomNamePrefix (const NXString &roomNamePrefix)
 Sets the room name prefix
Created in NX12.0.0. More...
 
void SetRoomNamePrefix (const char *roomNamePrefix)
 Sets the room name prefix
Created in NX12.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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 Features::ShipDesign::RoomContainerBuilder builder
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateRoomContainerBuilder

Created in NX12.0.0.


Member Function Documentation

void NXOpen::Features::ShipDesign::RoomContainerBuilder::AddRoomAndPurpose ( const NXString room,
const NXString purpose 
)

The room and purpose
Created in 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")

Parameters
roomroom
purposepurpose
void NXOpen::Features::ShipDesign::RoomContainerBuilder::AddRoomAndPurpose ( const char *  room,
const char *  purpose 
)

The room and purpose
Created in 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")

Parameters
roomroom
purposepurpose
NXOpen::ScCollector* NXOpen::Features::ShipDesign::RoomContainerBuilder::DeckBody ( )

Returns the deck body
Created in NX12.0.0.



License requirements : None

NXOpen::Section* NXOpen::Features::ShipDesign::RoomContainerBuilder::DeckPlanSketch ( )

Returns the deck plane sketch
Created in NX12.0.0.



License requirements : None

NXString NXOpen::Features::ShipDesign::RoomContainerBuilder::RoomNamePrefix ( )

Returns the room name prefix
Created in NX12.0.0.



License requirements : None

void NXOpen::Features::ShipDesign::RoomContainerBuilder::SetRoomNamePrefix ( const NXString roomNamePrefix)

Sets the room name prefix
Created in 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")

Parameters
roomNamePrefixroomnameprefix
void NXOpen::Features::ShipDesign::RoomContainerBuilder::SetRoomNamePrefix ( const char *  roomNamePrefix)

Sets the room name prefix
Created in 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")

Parameters
roomNamePrefixroomnameprefix

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.