ProjectSetupBuilder Class

class NXOpen.Features.ShipDesign.ProjectSetupBuilder

Bases: NXOpen.Builder

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

New in version NX12.0.0.

Properties

Property	Description
ProjectName	Returns or sets the project name
Tag	Returns the Tag for this object.

Methods

Method	Description
AddSharedParts	Add shared parts
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.

Property Detail

ProjectName

ProjectSetupBuilder.ProjectName

Returns or sets the project name

-------------------------------------

Getter Method

Signature ProjectName

Returns: Return type:str

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ProjectName

Parameters:projectName (str) –

New in version 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”)

Method Detail

AddSharedParts

ProjectSetupBuilder.AddSharedParts

Add shared parts

Signature AddSharedParts(parts)

Parameters:parts (list of NXOpen.Part) – the parts used to add to shared node.

New in version 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”)

Validate

ProjectSetupBuilder.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.