NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Features::ShipDesign::ShipCoordinatesBuilder Class Reference

Represents a Features::ShipDesign::ShipCoordinates builder
To create a new instance of this class, use Features::ShipCollection::CreateShipCoordinatesBuilder
Default values. More...

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

List of all members.

Public Types

enum  Selection { SelectionPoint, SelectionComponent }
 Represents the options to select point or component. More...
enum  XDirectionType { XDirectionTypeForward, XDirectionTypeAft }
 Represents X-frame direction. More...
enum  YDirectionType { YDirectionTypePort, YDirectionTypeStarboard }
 Represents Y-frame direction. More...
enum  ZDirectionType { ZDirectionTypeAbove, ZDirectionTypeBelow }
 Represents Z-frame direction. More...

Public Member Functions

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.
NXOpen::PointPoint ()
 Returns the point to define ship coordinates.
NXOpen::SelectDisplayableObjectRoutingComponent ()
 Returns the routing component.
NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::Selection SelectionType ()
 Returns the selection type.
void SetAbsXValue (double doubleABSX)
 Sets the X value in absolute coordinate system.
void SetAbsYValue (double doubleABSY)
 Sets the Y value in absolute coordinate system.
void SetAbsZValue (double doubleABSZ)
 Sets the Z value in absolute coordinate system.
void SetDeltaX (double deltaX)
 Sets the delta value whic is distance between current point and previous point along X-direction.
void SetDeltaY (double deltaY)
 Sets the delta value whic is distance between current point and previous point along Y-direction.
void SetDeltaZ (double deltaZ)
 Sets the delta value which is distance between current point and previous point long Z-direction.
void SetPoint (NXOpen::Point *selectPoint)
 Sets the point to define ship coordinates.
void SetPosition (const NXOpen::Point3d &position)
 Sets the point information into the ShipCoordinate builder and a standard point will be created according to the position.
void SetSelectionType (NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::Selection type)
 Sets the selection type.
void SetXDirection (NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::XDirectionType xDirection)
 Sets the X-frame direction.
void SetXDistance (double doubleXDistance)
 Sets the distance along X-direction.
void SetXFrameOption (const NXString &xFrame)
 Sets the X-frame option.
void SetYDirection (NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::YDirectionType yDirection)
 Sets the Y-frame direction.
void SetYDistance (double doubleYDistance)
 Sets the distance along Y-direction.
void SetYFrameOption (const NXString &yFrame)
 Sets the Y-frame option.
void SetZDirection (NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::ZDirectionType zDirection)
 Sets the Z-frame direction.
void SetZDistance (double doubleZDistance)
 Sets the distance along Z-direction.
void SetZFrameOption (const NXString &zFrame)
 Sets the Z-frame option.
NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::XDirectionType XDirection ()
 Returns the X-frame direction.
double XDistance ()
 Returns the distance along X-direction.
NXString XFrameOption ()
 Returns the X-frame option.
NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::YDirectionType YDirection ()
 Returns the Y-frame direction.
double YDistance ()
 Returns the distance along Y-direction.
NXString YFrameOption ()
 Returns the Y-frame option.
NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::ZDirectionType ZDirection ()
 Returns the Z-frame direction.
double ZDistance ()
 Returns the distance along Z-direction.
NXString ZFrameOption ()
 Returns the Z-frame option.

Detailed Description

Represents a Features::ShipDesign::ShipCoordinates builder
To create a new instance of this class, use 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


Created in NX8.0.0.


Member Enumeration Documentation

Represents the options to select point or component.

Enumerator:
SelectionPoint 

Allows point selection.

SelectionComponent 

Allows routing component selection.

Represents X-frame direction.

Enumerator:
XDirectionTypeForward 

forward

XDirectionTypeAft 

aft

Represents Y-frame direction.

Enumerator:
YDirectionTypePort 

port

YDirectionTypeStarboard 

starboard

Represents Z-frame direction.

Enumerator:
ZDirectionTypeAbove 

above

ZDirectionTypeBelow 

below


Member Function Documentation

Returns the X value in absolute coordinate system.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the Y value in absolute coordinate system.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the Z value in absolute coordinate system.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Creates a standard point.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Cycles through the ports on the selected routing component.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the point to define ship coordinates.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the routing component.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the selection type.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Sets the X value in absolute coordinate system.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
doubleABSXdoubleabsx

Sets the Y value in absolute coordinate system.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
doubleABSYdoubleabsy

Sets the Z value in absolute coordinate system.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
doubleABSZdoubleabsz

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


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
deltaXdeltax

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


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
deltaYdeltay

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


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
deltaZdeltaz

Sets the point to define ship coordinates.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
selectPointselectpoint

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


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
positionposition

Sets the selection type.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
typetype

Sets the X-frame direction.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
xDirectionxdirection

Sets the distance along X-direction.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
doubleXDistancedoublexdistance

Sets the X-frame option.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
xFramexframe

Sets the Y-frame direction.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
yDirectionydirection

Sets the distance along Y-direction.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
doubleYDistancedoubleydistance

Sets the Y-frame option.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
yFrameyframe

Sets the Z-frame direction.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
zDirectionzdirection

Sets the distance along Z-direction.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
doubleZDistancedoublezdistance

Sets the Z-frame option.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
zFramezframe

Returns the X-frame direction.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the distance along X-direction.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the X-frame option.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the Y-frame direction.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the distance along Y-direction.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the Y-frame option.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the Z-frame direction.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the distance along Z-direction.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the Z-frame option.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")


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