NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
NXOpen::Features::ShipDesign::ProjectSetupBuilder Class Reference

Represents a project setup builder for ship. More...

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

Public Member Functions

void AddSharedParts (const std::vector< NXOpen::Part * > &parts)
 Add shared parts
Created in NX12.0.0. More...
 
NXOpen::Features::ShipDesign::ProjectStructureNodeGetRootNode ()
 Gets the structure root node. More...
 
bool IsNewStructure ()
 Returns the flag to indicate whether it is new structure or not. More...
 
bool IsSaveAsSharePart ()
 Returns the flag to indicate whether it is to save as the shared part. More...
 
NXString ProjectName ()
 Returns the project name
Created in NX12.0.0. More...
 
void SetHullTemplateIdentifier (const NXString &hullTemplateID)
 Sets the hull template name to load it during the project setup. More...
 
void SetHullTemplateIdentifier (const char *hullTemplateID)
 Sets the hull template name to load it during the project setup. More...
 
void SetNewStructure (bool isNewStructure)
 Sets the flag to indicate whether it is new structure or not. More...
 
void SetProjectName (const NXString &projectName)
 Sets the project name
Created in NX12.0.0. More...
 
void SetProjectName (const char *projectName)
 Sets the project name
Created in NX12.0.0. More...
 
void SetSaveAsSharePart (bool isSaveAsSharePart)
 Sets the flag to indicate whether it is to save as the shared part. 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 project setup builder for ship.

This builder is used to setup project in ship.


To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateProjectSetupBuilder

Created in NX12.0.0.

Member Function Documentation

void NXOpen::Features::ShipDesign::ProjectSetupBuilder::AddSharedParts ( const std::vector< NXOpen::Part * > &  parts)

Add shared parts
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
partsthe parts used to add to shared node.
NXOpen::Features::ShipDesign::ProjectStructureNode* NXOpen::Features::ShipDesign::ProjectSetupBuilder::GetRootNode ( )

Gets the structure root node.

Returns
the root structure node.
Created in NX12.0.1.

License requirements : None
bool NXOpen::Features::ShipDesign::ProjectSetupBuilder::IsNewStructure ( )

Returns the flag to indicate whether it is new structure or not.


Created in NX12.0.1.

License requirements : None

bool NXOpen::Features::ShipDesign::ProjectSetupBuilder::IsSaveAsSharePart ( )

Returns the flag to indicate whether it is to save as the shared part.


Created in NX12.0.1.

License requirements : None

NXString NXOpen::Features::ShipDesign::ProjectSetupBuilder::ProjectName ( )

Returns the project name
Created in NX12.0.0.



License requirements : None

void NXOpen::Features::ShipDesign::ProjectSetupBuilder::SetHullTemplateIdentifier ( const NXString hullTemplateID)

Sets the hull template name to load it during the project setup.


Created in NX12.0.1.

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
hullTemplateIDhulltemplateid
void NXOpen::Features::ShipDesign::ProjectSetupBuilder::SetHullTemplateIdentifier ( const char *  hullTemplateID)

Sets the hull template name to load it during the project setup.


Created in NX12.0.1.

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
hullTemplateIDhulltemplateid
void NXOpen::Features::ShipDesign::ProjectSetupBuilder::SetNewStructure ( bool  isNewStructure)

Sets the flag to indicate whether it is new structure or not.


Created in NX12.0.1.

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
isNewStructureisnewstructure
void NXOpen::Features::ShipDesign::ProjectSetupBuilder::SetProjectName ( const NXString projectName)

Sets the project name
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
projectNameprojectname
void NXOpen::Features::ShipDesign::ProjectSetupBuilder::SetProjectName ( const char *  projectName)

Sets the project name
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
projectNameprojectname
void NXOpen::Features::ShipDesign::ProjectSetupBuilder::SetSaveAsSharePart ( bool  isSaveAsSharePart)

Sets the flag to indicate whether it is to save as the shared part.


Created in NX12.0.1.

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
isSaveAsSharePartissaveassharepart

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