ShipCoordinatesBuilder Class

class NXOpen.Features.ShipDesign.ShipCoordinatesBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Features.ShipDesign.ShipCoordinates builder

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

Default values.

Property	Value
AbsXValue	0
AbsYValue	0
AbsZValue	0
DeltaX	0
DeltaY	0
DeltaZ	0
XDirection	Forward
XDistance	0
YDirection	Port
YDistance	0
ZDirection	Above
ZDistance	0

New in version NX8.0.0.

Properties

Property	Description
AbsXValue	Returns or sets the X value in absolute coordinate system.
AbsYValue	Returns or sets the Y value in absolute coordinate system.
AbsZValue	Returns or sets the Z value in absolute coordinate system.
DeltaX	Returns or sets the delta value whic is distance between current point and previous point along X-direction.
DeltaY	Returns or sets the delta value whic is distance between current point and previous point along Y-direction.
DeltaZ	Returns or sets the delta value which is distance between current point and previous point long Z-direction.
Point	Returns or sets the point to define ship coordinates.
RoutingComponent	Returns the routing component.
SelectionType	Returns or sets the selection type.
Tag	Returns the Tag for this object.
XDirection	Returns or sets the X-frame direction.
XDistance	Returns or sets the distance along X-direction.
XFrameOption	Returns or sets the X-frame option.
YDirection	Returns or sets the Y-frame direction.
YDistance	Returns or sets the distance along Y-direction.
YFrameOption	Returns or sets the Y-frame option.
ZDirection	Returns or sets the Z-frame direction.
ZDistance	Returns or sets the distance along Z-direction.
ZFrameOption	Returns or sets the Z-frame option.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
CreatePointByCoordinates	Creates a standard point.
CycleRoutingPorts	Cycles through the ports on the selected routing component.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
EvaluatePointInformation	Evaluates the point per position and and sets them into ShipCoordinatesBuilder builder.
EvaluateSinglePortInformation	Evaluates the Nth ports information and sets them into ShipCoordinatesBuilder builder, the index starts from 1 and should be equal or less than number of ports.
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.
GetPorts	Gets ports in component.
SetPosition	Sets the point information into the ShipCoordinate builder and a standard point will be created according to the position.
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.

Enumerations

ShipCoordinatesBuilderSelection Enumeration	Represents the options to select point or component.
ShipCoordinatesBuilderXDirectionType Enumeration	Represents X-frame direction.
ShipCoordinatesBuilderYDirectionType Enumeration	Represents Y-frame direction.
ShipCoordinatesBuilderZDirectionType Enumeration	Represents Z-frame direction.

Property Detail

AbsXValue

ShipCoordinatesBuilder.AbsXValue

Returns or sets the X value in absolute coordinate system.

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

Getter Method

Signature AbsXValue

Returns: Return type:float

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

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

Setter Method

Signature AbsXValue

Parameters:doubleABSX (float) –

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

AbsYValue

ShipCoordinatesBuilder.AbsYValue

Returns or sets the Y value in absolute coordinate system.

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

Getter Method

Signature AbsYValue

Returns: Return type:float

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

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

Setter Method

Signature AbsYValue

Parameters:doubleABSY (float) –

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

AbsZValue

ShipCoordinatesBuilder.AbsZValue

Returns or sets the Z value in absolute coordinate system.

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

Getter Method

Signature AbsZValue

Returns: Return type:float

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

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

Setter Method

Signature AbsZValue

Parameters:doubleABSZ (float) –

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

DeltaX

ShipCoordinatesBuilder.DeltaX

Returns or sets the delta value whic is distance between current point and previous point along X-direction.

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

Getter Method

Signature DeltaX

Returns: Return type:float

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

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

Setter Method

Signature DeltaX

Parameters:deltaX (float) –

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

DeltaY

ShipCoordinatesBuilder.DeltaY

Returns or sets the delta value whic is distance between current point and previous point along Y-direction.

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

Getter Method

Signature DeltaY

Returns: Return type:float

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

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

Setter Method

Signature DeltaY

Parameters:deltaY (float) –

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

DeltaZ

ShipCoordinatesBuilder.DeltaZ

Returns or sets the delta value which is distance between current point and previous point long Z-direction.

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

Getter Method

Signature DeltaZ

Returns: Return type:float

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

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

Setter Method

Signature DeltaZ

Parameters:deltaZ (float) –

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

Point

ShipCoordinatesBuilder.Point

Returns or sets the point to define ship coordinates.

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

Getter Method

Signature Point

Returns: Return type:NXOpen.Point

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

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

Setter Method

Signature Point

Parameters:selectPoint (NXOpen.Point) –

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

RoutingComponent

ShipCoordinatesBuilder.RoutingComponent

Returns the routing component.

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

Getter Method

Signature RoutingComponent

Returns: Return type:NXOpen.SelectDisplayableObject

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

SelectionType

ShipCoordinatesBuilder.SelectionType

Returns or sets the selection type.

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

Getter Method

Signature SelectionType

Returns: Return type:NXOpen.Features.ShipDesign.ShipCoordinatesBuilderSelection

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

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

Setter Method

Signature SelectionType

Parameters:type (NXOpen.Features.ShipDesign.ShipCoordinatesBuilderSelection) –

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

XDirection

ShipCoordinatesBuilder.XDirection

Returns or sets the X-frame direction.

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

Getter Method

Signature XDirection

Returns: Return type:NXOpen.Features.ShipDesign.ShipCoordinatesBuilderXDirectionType

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

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

Setter Method

Signature XDirection

Parameters:xDirection (NXOpen.Features.ShipDesign.ShipCoordinatesBuilderXDirectionType) –

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

XDistance

ShipCoordinatesBuilder.XDistance

Returns or sets the distance along X-direction.

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

Getter Method

Signature XDistance

Returns: Return type:float

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

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

Setter Method

Signature XDistance

Parameters:doubleXDistance (float) –

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

XFrameOption

ShipCoordinatesBuilder.XFrameOption

Returns or sets the X-frame option.

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

Getter Method

Signature XFrameOption

Returns: Return type:str

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

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

Setter Method

Signature XFrameOption

Parameters:xFrame (str) –

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

YDirection

ShipCoordinatesBuilder.YDirection

Returns or sets the Y-frame direction.

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

Getter Method

Signature YDirection

Returns: Return type:NXOpen.Features.ShipDesign.ShipCoordinatesBuilderYDirectionType

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

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

Setter Method

Signature YDirection

Parameters:yDirection (NXOpen.Features.ShipDesign.ShipCoordinatesBuilderYDirectionType) –

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

YDistance

ShipCoordinatesBuilder.YDistance

Returns or sets the distance along Y-direction.

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

Getter Method

Signature YDistance

Returns: Return type:float

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

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

Setter Method

Signature YDistance

Parameters:doubleYDistance (float) –

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

YFrameOption

ShipCoordinatesBuilder.YFrameOption

Returns or sets the Y-frame option.

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

Getter Method

Signature YFrameOption

Returns: Return type:str

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

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

Setter Method

Signature YFrameOption

Parameters:yFrame (str) –

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

ZDirection

ShipCoordinatesBuilder.ZDirection

Returns or sets the Z-frame direction.

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

Getter Method

Signature ZDirection

Returns: Return type:NXOpen.Features.ShipDesign.ShipCoordinatesBuilderZDirectionType

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

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

Setter Method

Signature ZDirection

Parameters:zDirection (NXOpen.Features.ShipDesign.ShipCoordinatesBuilderZDirectionType) –

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

ZDistance

ShipCoordinatesBuilder.ZDistance

Returns or sets the distance along Z-direction.

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

Getter Method

Signature ZDistance

Returns: Return type:float

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

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

Setter Method

Signature ZDistance

Parameters:doubleZDistance (float) –

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

ZFrameOption

ShipCoordinatesBuilder.ZFrameOption

Returns or sets the Z-frame option.

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

Getter Method

Signature ZFrameOption

Returns: Return type:str

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

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

Setter Method

Signature ZFrameOption

Parameters:zFrame (str) –

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

Method Detail

CreatePointByCoordinates

ShipCoordinatesBuilder.CreatePointByCoordinates

Creates a standard point.

Signature CreatePointByCoordinates()

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

CycleRoutingPorts

ShipCoordinatesBuilder.CycleRoutingPorts

Cycles through the ports on the selected routing component.

Signature CycleRoutingPorts()

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

EvaluatePointInformation

ShipCoordinatesBuilder.EvaluatePointInformation

Evaluates the point per position and and sets them into ShipCoordinatesBuilder builder.

Signature EvaluatePointInformation(position)

Parameters:position (NXOpen.Point3d) –

New in version NX8.5.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

EvaluateSinglePortInformation

ShipCoordinatesBuilder.EvaluateSinglePortInformation

Evaluates the Nth ports information and sets them into ShipCoordinatesBuilder builder, the index starts from 1 and should be equal or less than number of ports.

Signature EvaluateSinglePortInformation(portIndex)

Parameters:portIndex (int) –

New in version NX8.5.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

GetPorts

ShipCoordinatesBuilder.GetPorts

Gets ports in component.

Signature GetPorts()

Returns: Return type:list of NXOpen.TaggedObject

New in version NX8.5.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

SetPosition

ShipCoordinatesBuilder.SetPosition

Sets the point information into the ShipCoordinate builder and a standard point will be created according to the position.

Signature SetPosition(position)

Parameters:position (NXOpen.Point3d) –

New in version NX8.0.0.

License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”) OR routing_base (“Routing Basic”)

Validate

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