public interface ShipCoordinatesBuilder extends Builder
ShipCoordinates
builder
ShipCollection.createShipCoordinatesBuilder()
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 |
Modifier and Type | Interface and Description |
---|---|
static class |
ShipCoordinatesBuilder.Selection
Represents the options to select point or component.
|
static class |
ShipCoordinatesBuilder.XDirectionType
Represents X-frame direction.
|
static class |
ShipCoordinatesBuilder.YDirectionType
Represents Y-frame direction.
|
static class |
ShipCoordinatesBuilder.ZDirectionType
Represents Z-frame direction.
|
Modifier and Type | Method and Description |
---|---|
double |
absXValue()
Returns the X value in absolute coordinate system.
|
double |
absYValue()
Returns the Y value in absolute coordinate system.
|
double |
absZValue()
Returns the Z value in absolute coordinate system.
|
void |
createPointByCoordinates()
Creates a standard point.
|
void |
cycleRoutingPorts()
Cycles through the ports on the selected routing component.
|
double |
deltaX()
Returns the delta value whic is distance between current point and previous point along X-direction.
|
double |
deltaY()
Returns the delta value whic is distance between current point and previous point along Y-direction.
|
double |
deltaZ()
Returns the delta value which is distance between current point and previous point long Z-direction.
|
void |
evaluatePointInformation(Point3d position)
Evaluates the point per position and and sets them into ShipCoordinatesBuilder builder.
|
void |
evaluateSinglePortInformation(int portIndex)
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.
|
TaggedObject[] |
getPorts()
Gets ports in component.
|
Point |
point()
Returns the point to define ship coordinates.
|
SelectDisplayableObject |
routingComponent()
Returns the routing component.
|
ShipCoordinatesBuilder.Selection |
selectionType()
Returns the selection type.
|
void |
setAbsXValue(double doubleABSX)
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") . |
void |
setAbsYValue(double doubleABSY)
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") . |
void |
setAbsZValue(double doubleABSZ)
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") . |
void |
setDeltaX(double deltaX)
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") . |
void |
setDeltaY(double deltaY)
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") . |
void |
setDeltaZ(double deltaZ)
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") . |
void |
setPoint(Point selectPoint)
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") . |
void |
setPosition(Point3d position)
Sets the point information into the ShipCoordinate builder and a standard point will be created according to the position.
|
void |
setSelectionType(ShipCoordinatesBuilder.Selection type)
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") . |
void |
setXDirection(ShipCoordinatesBuilder.XDirectionType xDirection)
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") . |
void |
setXDistance(double doubleXDistance)
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") . |
void |
setXFrameOption(String xFrame)
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") . |
void |
setYDirection(ShipCoordinatesBuilder.YDirectionType yDirection)
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") . |
void |
setYDistance(double doubleYDistance)
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") . |
void |
setYFrameOption(String yFrame)
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") . |
void |
setZDirection(ShipCoordinatesBuilder.ZDirectionType zDirection)
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") . |
void |
setZDistance(double doubleZDistance)
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") . |
void |
setZFrameOption(String zFrame)
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") . |
ShipCoordinatesBuilder.XDirectionType |
xdirection()
Returns the X-frame direction.
|
double |
xdistance()
Returns the distance along X-direction.
|
String |
xframeOption()
Returns the X-frame option.
|
ShipCoordinatesBuilder.YDirectionType |
ydirection()
Returns the Y-frame direction.
|
double |
ydistance()
Returns the distance along Y-direction.
|
String |
yframeOption()
Returns the Y-frame option.
|
ShipCoordinatesBuilder.ZDirectionType |
zdirection()
Returns the Z-frame direction.
|
double |
zdistance()
Returns the distance along Z-direction.
|
String |
zframeOption()
Returns the Z-frame option.
|
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
Point point() throws NXException, RemoteException
NXException
RemoteException
void setPoint(Point selectPoint) throws NXException, RemoteException
selectPoint
- NXException
RemoteException
SelectDisplayableObject routingComponent() throws NXException, RemoteException
NXException
RemoteException
void cycleRoutingPorts() throws NXException, RemoteException
NXException
RemoteException
double absXValue() throws NXException, RemoteException
NXException
RemoteException
void setAbsXValue(double doubleABSX) throws NXException, RemoteException
doubleABSX
- NXException
RemoteException
double deltaX() throws NXException, RemoteException
NXException
RemoteException
void setDeltaX(double deltaX) throws NXException, RemoteException
deltaX
- NXException
RemoteException
double absYValue() throws NXException, RemoteException
NXException
RemoteException
void setAbsYValue(double doubleABSY) throws NXException, RemoteException
doubleABSY
- NXException
RemoteException
double deltaY() throws NXException, RemoteException
NXException
RemoteException
void setDeltaY(double deltaY) throws NXException, RemoteException
deltaY
- NXException
RemoteException
double absZValue() throws NXException, RemoteException
NXException
RemoteException
void setAbsZValue(double doubleABSZ) throws NXException, RemoteException
doubleABSZ
- NXException
RemoteException
double deltaZ() throws NXException, RemoteException
NXException
RemoteException
void setDeltaZ(double deltaZ) throws NXException, RemoteException
deltaZ
- NXException
RemoteException
String xframeOption() throws NXException, RemoteException
NXException
RemoteException
void setXFrameOption(String xFrame) throws NXException, RemoteException
xFrame
- NXException
RemoteException
ShipCoordinatesBuilder.XDirectionType xdirection() throws NXException, RemoteException
NXException
RemoteException
void setXDirection(ShipCoordinatesBuilder.XDirectionType xDirection) throws NXException, RemoteException
xDirection
- NXException
RemoteException
double xdistance() throws NXException, RemoteException
NXException
RemoteException
void setXDistance(double doubleXDistance) throws NXException, RemoteException
doubleXDistance
- NXException
RemoteException
String yframeOption() throws NXException, RemoteException
NXException
RemoteException
void setYFrameOption(String yFrame) throws NXException, RemoteException
yFrame
- NXException
RemoteException
ShipCoordinatesBuilder.YDirectionType ydirection() throws NXException, RemoteException
NXException
RemoteException
void setYDirection(ShipCoordinatesBuilder.YDirectionType yDirection) throws NXException, RemoteException
yDirection
- NXException
RemoteException
double ydistance() throws NXException, RemoteException
NXException
RemoteException
void setYDistance(double doubleYDistance) throws NXException, RemoteException
doubleYDistance
- NXException
RemoteException
String zframeOption() throws NXException, RemoteException
NXException
RemoteException
void setZFrameOption(String zFrame) throws NXException, RemoteException
zFrame
- NXException
RemoteException
ShipCoordinatesBuilder.ZDirectionType zdirection() throws NXException, RemoteException
NXException
RemoteException
void setZDirection(ShipCoordinatesBuilder.ZDirectionType zDirection) throws NXException, RemoteException
zDirection
- NXException
RemoteException
double zdistance() throws NXException, RemoteException
NXException
RemoteException
void setZDistance(double doubleZDistance) throws NXException, RemoteException
doubleZDistance
- NXException
RemoteException
void createPointByCoordinates() throws NXException, RemoteException
NXException
RemoteException
ShipCoordinatesBuilder.Selection selectionType() throws NXException, RemoteException
NXException
RemoteException
void setSelectionType(ShipCoordinatesBuilder.Selection type) throws NXException, RemoteException
type
- NXException
RemoteException
void setPosition(Point3d position) throws NXException, RemoteException
position
- NXException
RemoteException
TaggedObject[] getPorts() throws NXException, RemoteException
NXException
RemoteException
void evaluateSinglePortInformation(int portIndex) throws NXException, RemoteException
portIndex
- NXException
RemoteException
void evaluatePointInformation(Point3d position) throws NXException, RemoteException
position
- NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.