MainDimensionsBuilder Class

class NXOpen.Features.ShipDesign.MainDimensionsBuilder

Bases: NXOpen.Features.FeatureBuilder

Represents a NXOpen.Features.ShipDesign.MainDimensions builder.

To create a new instance of this class, use NXOpen.Features.ShipCollection.CreateMainDimensionsBuilder()

Default values.

Property	Value
AftPerpendicular.Value	0 (millimeters part), 0 (inches part)
Baseline.Value	0 (millimeters part), 0 (inches part)
ForwardPerpendicular.Value	0 (millimeters part), 0 (inches part)
Midship.Value	0 (millimeters part), 0 (inches part)
Waterline.Value	0 (millimeters part), 0 (inches part)
XMax.Value	25000 (millimeters part), 1000 (inches part)
XMin.Value	0 (millimeters part), 0 (inches part)
YMax.Value	2500 (millimeters part), 100 (inches part)
ZMax.Value	2500 (millimeters part), 100 (inches part)
ZMin.Value	0 (millimeters part), 0 (inches part)

New in version NX5.0.0.

Properties

Property	Description
AftPerpendicular	Returns the expression containing the position value of Aft Perpendicular along the X axis.
Baseline	Returns the expression containing the position value of baseline along the Z axis.
ForwardPerpendicular	Returns the expression containing the position value of forward Perpendicular along the X axis.
GridID	Returns or sets the unique Grid ID for each ship.
Midship	Returns the expression containing the position value of midship along the X axis.
ParentFeatureInternal	Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag	Returns or sets the patch solution flag
PatchSurfaceFilename	Returns or sets the patch surface filename
ShipBody	Returns the ship body.
SurroundingPatchSurfaceFilename	Returns or sets the surrounding patch surface filename
Tag	Returns the Tag for this object.
Waterline	Returns the expression containing the position value of waterline along the Z axis.
XMax	Returns the expression containing the x max value.
XMin	Returns the expression containing the x min value.
YMax	Returns the expression containing the y max value.
ZMax	Returns the expression containing the z max value.
ZMin	Returns the expression containing the z min value.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
CommitFeature	Commits the feature parameters and creates the feature
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.
GetFeature	Returns the feature currently being edited by this builder.
GetObject	Returns the object currently being edited by this builder.
HideInternalParentFeatureAfterEdit	Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetParentFeatureInternal	Set the parent features which would be internal or slaves to the feature being created or commited
ShowInternalParentFeatureForEdit	Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal	Set the internal parent feature of the feature being edited to external
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

AftPerpendicular

MainDimensionsBuilder.AftPerpendicular

Returns the expression containing the position value of Aft Perpendicular along the X axis.

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

Getter Method

Signature AftPerpendicular

Returns: Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

Baseline

MainDimensionsBuilder.Baseline

Returns the expression containing the position value of baseline along the Z axis.

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

Getter Method

Signature Baseline

Returns: Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

ForwardPerpendicular

MainDimensionsBuilder.ForwardPerpendicular

Returns the expression containing the position value of forward Perpendicular along the X axis.

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

Getter Method

Signature ForwardPerpendicular

Returns: Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

GridID

MainDimensionsBuilder.GridID

Returns or sets the unique “Grid ID” for each ship.

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

Getter Method

Signature GridID

Returns: Return type:str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature GridID

Parameters:gridID (str) –

New in version NX8.0.0.

License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)

Midship

MainDimensionsBuilder.Midship

Returns the expression containing the position value of midship along the X axis.

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

Getter Method

Signature Midship

Returns: Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

ShipBody

MainDimensionsBuilder.ShipBody

Returns the ship body.

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

Getter Method

Signature ShipBody

Returns: Return type:NXOpen.SelectBody

New in version NX5.0.0.

License requirements: None.

Waterline

MainDimensionsBuilder.Waterline

Returns the expression containing the position value of waterline along the Z axis.

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

Getter Method

Signature Waterline

Returns: Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

XMax

MainDimensionsBuilder.XMax

Returns the expression containing the x max value.

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

Getter Method

Signature XMax

Returns: Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

XMin

MainDimensionsBuilder.XMin

Returns the expression containing the x min value.

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

Getter Method

Signature XMin

Returns: Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

YMax

MainDimensionsBuilder.YMax

Returns the expression containing the y max value.

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

Getter Method

Signature YMax

Returns: Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

ZMax

MainDimensionsBuilder.ZMax

Returns the expression containing the z max value.

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

Getter Method

Signature ZMax

Returns: Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

ZMin

MainDimensionsBuilder.ZMin

Returns the expression containing the z min value.

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

Getter Method

Signature ZMin

Returns: Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

Method Detail

Validate

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