NXOpen::Features::ShipDesign::ShipCoordinatesBuilder Class Reference

Represents a @link Features::ShipDesign::ShipCoordinates Features::ShipDesign::ShipCoordinates@endlink  builder
 <br> To create a new instance of this class, use @link Features::ShipCollection::CreateShipCoordinatesBuilder  Features::ShipCollection::CreateShipCoordinatesBuilder @endlink  <br> 

Default values. More...

Inheritance diagram for NXOpen::Features::ShipDesign::ShipCoordinatesBuilder:

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.
void	EvaluatePointInformation (const NXOpen::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.
void	GetPorts (std::vector< NXOpen::TaggedObject * > &ports)
	Gets ports in component.
NXOpen::Point *	Point ()
	Returns the point to define ship coordinates.
NXOpen::SelectDisplayableObject *	RoutingComponent ()
	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	SetXFrameOption (const char *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	SetYFrameOption (const char *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.
void	SetZFrameOption (const char *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.
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a @link Features::ShipDesign::ShipCoordinates Features::ShipDesign::ShipCoordinates@endlink  builder
 <br> To create a new instance of this class, use @link Features::ShipCollection::CreateShipCoordinatesBuilder  Features::ShipCollection::CreateShipCoordinatesBuilder @endlink  <br> 

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

enum NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::Selection

Represents the options to select point or component.

Enumerator:

SelectionPoint	Allows point selection.
SelectionComponent	Allows routing component selection.

enum NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::XDirectionType

Represents X-frame direction.

Enumerator:

XDirectionTypeForward	forward
XDirectionTypeAft	aft

enum NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::YDirectionType

Represents Y-frame direction.

Enumerator:

YDirectionTypePort	port
YDirectionTypeStarboard	starboard

enum NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::ZDirectionType

Represents Z-frame direction.

Enumerator:

ZDirectionTypeAbove	above
ZDirectionTypeBelow	below

Member Function Documentation

double NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::AbsXValue

(

)

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_base ("Routing Basic")

double NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::AbsYValue

(

)

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_base ("Routing Basic")

double NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::AbsZValue

(

)

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_base ("Routing Basic")

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::CreatePointByCoordinates

(

)

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_base ("Routing Basic")

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::CycleRoutingPorts

(

)

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_base ("Routing Basic")

double NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::DeltaX

(

)

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_base ("Routing Basic")

double NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::DeltaY

(

)

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_base ("Routing Basic")

double NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::DeltaZ

(

)

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_base ("Routing Basic")

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::EvaluatePointInformation

(

const NXOpen::Point3d &

position

)

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

Created in NX8.5.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_base ("Routing Basic")

Parameters

position

position

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::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.

Created in NX8.5.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_base ("Routing Basic")

Parameters

portIndex

portindex

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::GetPorts

(

std::vector< NXOpen::TaggedObject * > &

ports

)

Gets ports in component.

Created in NX8.5.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") OR routing_base ("Routing Basic")

Parameters

ports

ports

NXOpen::Point* NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::Point

(

)

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_base ("Routing Basic")

NXOpen::SelectDisplayableObject* NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::RoutingComponent

(

)

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_base ("Routing Basic")

NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::Selection NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SelectionType

(

)

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_base ("Routing Basic")

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SetAbsXValue

(

double

doubleABSX

)

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_base ("Routing Basic")

Parameters

doubleABSX

doubleabsx

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SetAbsYValue

(

double

doubleABSY

)

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_base ("Routing Basic")

Parameters

doubleABSY

doubleabsy

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SetAbsZValue

(

double

doubleABSZ

)

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_base ("Routing Basic")

Parameters

doubleABSZ

doubleabsz

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SetDeltaX

(

double

deltaX

)

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_base ("Routing Basic")

Parameters

deltaX

deltax

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SetDeltaY

(

double

deltaY

)

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_base ("Routing Basic")

Parameters

deltaY

deltay

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SetDeltaZ

(

double

deltaZ

)

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_base ("Routing Basic")

Parameters

deltaZ

deltaz

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SetPoint

(

NXOpen::Point *

selectPoint

)

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_base ("Routing Basic")

Parameters

selectPoint

selectpoint

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SetPosition

(

const NXOpen::Point3d &

position

)

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_base ("Routing Basic")

Parameters

position

position

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SetSelectionType

(

NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::Selection

type

)

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_base ("Routing Basic")

Parameters

type

type

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SetXDirection

(

NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::XDirectionType

xDirection

)

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_base ("Routing Basic")

Parameters

xDirection

xdirection

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SetXDistance

(

double

doubleXDistance

)

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_base ("Routing Basic")

Parameters

doubleXDistance

doublexdistance

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SetXFrameOption

(

const NXString &

xFrame

)

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_base ("Routing Basic")

Parameters

xFrame

xframe

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SetXFrameOption

(

const char *

xFrame

)

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_base ("Routing Basic")

Parameters

xFrame

xframe

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SetYDirection

(

NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::YDirectionType

yDirection

)

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_base ("Routing Basic")

Parameters

yDirection

ydirection

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SetYDistance

(

double

doubleYDistance

)

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_base ("Routing Basic")

Parameters

doubleYDistance

doubleydistance

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SetYFrameOption

(

const NXString &

yFrame

)

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_base ("Routing Basic")

Parameters

yFrame

yframe

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SetYFrameOption

(

const char *

yFrame

)

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_base ("Routing Basic")

Parameters

yFrame

yframe

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SetZDirection

(

NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::ZDirectionType

zDirection

)

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_base ("Routing Basic")

Parameters

zDirection

zdirection

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SetZDistance

(

double

doubleZDistance

)

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_base ("Routing Basic")

Parameters

doubleZDistance

doublezdistance

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SetZFrameOption

(

const NXString &

zFrame

)

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_base ("Routing Basic")

Parameters

zFrame

zframe

void NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::SetZFrameOption

(

const char *

zFrame

)

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_base ("Routing Basic")

Parameters

zFrame

zframe

NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::XDirectionType NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::XDirection

(

)

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_base ("Routing Basic")

double NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::XDistance

(

)

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_base ("Routing Basic")

NXString NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::XFrameOption

(

)

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_base ("Routing Basic")

NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::YDirectionType NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::YDirection

(

)

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_base ("Routing Basic")

double NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::YDistance

(

)

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_base ("Routing Basic")

NXString NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::YFrameOption

(

)

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_base ("Routing Basic")

NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::ZDirectionType NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::ZDirection

(

)

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_base ("Routing Basic")

double NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::ZDistance

(

)

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_base ("Routing Basic")

NXString NXOpen::Features::ShipDesign::ShipCoordinatesBuilder::ZFrameOption

(

)

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_base ("Routing Basic")

---

The documentation for this class was generated from the following file:

• Features_ShipDesign_ShipCoordinatesBuilder.hxx