CoordinateSystem class is used to handle the coordinate system.
The class can be called from CoordinateSystemList class.
. More...

Public Member Functions
Point *	GetFirstAxis ()
	Returns the first axis of the coordinate system. More...

String	GetFirstAxisType ()
	Returns the type of the first axis of the coordinate system. More...

String	GetName ()
	Returns the name of the coordinate system as a string. More...

Point *	GetOrigin ()
	Returns the center point in the coordinate system. More...

Point *	GetOriginWithUnit (String &unitName)
	Returns the center point in the coordinate system by specifying the unit. More...

Point *	GetSecondAxis ()
	Returns the second axis of the coordinate system. More...

bool	IsValid ()
	Returns True if an object is valid. More...

void	SetFirstAxis (Point *axis)
	Specifies the first axis of the coordinate system (Point type). More...

void	SetFirstAxisType (String &typeName)
	Specifies the type of first axis of the coordinate system. More...

void	SetFirstAxisXYZ (double x, double y, double z)
	Specifies the first axis of the coordinate system (Real number type). More...

void	SetName (String &name)
	Specifies the name of the coordinate system. More...

void	SetOrigin (Point *origin)
	Specifies the center point of the coordinate system (Point type). More...

void	SetOriginWithUnit (Point *origin, String &unitName)
	Specifies the center point of the coordinate system by specifying the unit (Point type). More...

void	SetOriginXYZ (double x, double y, double z)
	Specifies the center coordinate of the coordinate system (Real number type). More...

void	SetOriginXYZWithUnit (double x, double y, double z, String &unitName)
	Specifies the center point of the coordinate system by specifying the unit (Real number type). More...

void	SetSecondAxis (Point *axis)
	Specifies the second axis of the coordinate system (Point type). More...

void	SetSecondAxisXYZ (double x, double y, double z)
	Specifies the second axis of the coordinate system (Real number type). More...

Detailed Description

CoordinateSystem class is used to handle the coordinate system.
The class can be called from CoordinateSystemList class.
.

Example of obtaining the class object:

app.GetModel(0).GetCoordinateSystemList().GetCoordinateSystem(0)

Member Function Documentation

Point * CoordinateSystem::GetFirstAxis ( )

Returns the first axis of the coordinate system.

Returns: First axis of the coordinate system

String CoordinateSystem::GetFirstAxisType ( )

Returns the type of the first axis of the coordinate system.

Returns: Type of the first axis of the coordinate system (X, R, Y, THETA, Z)

String CoordinateSystem::GetName ( )

Returns the name of the coordinate system as a string.

Returns: Name of the coordinate system

Point * CoordinateSystem::GetOrigin ( )

Returns the center point in the coordinate system.

Returns: Center point of the coordinate system

Point * CoordinateSystem::GetOriginWithUnit ( String & unitName )

Returns the center point in the coordinate system by specifying the unit.

Parameters

unitName Unit

Returns: Center point of the coordinate system

Point * CoordinateSystem::GetSecondAxis ( )

Returns the second axis of the coordinate system.

Returns: Second axis of the coordinate system

bool CoordinateSystem::IsValid ( )

Returns True if an object is valid.

Returns: Whether or not the CoordinateSystem objects in the list are valid

void CoordinateSystem::SetFirstAxis ( Point * axis )

Specifies the first axis of the coordinate system (Point type).

Parameters

axis	Each component of the first axis

void CoordinateSystem::SetFirstAxisType ( String & typeName )

Specifies the type of first axis of the coordinate system.

Parameters

typeName Type of first axis of the coordinate system (X, R, Y, THETA, Z)

void CoordinateSystem::SetFirstAxisXYZ	(	double	x,
		double	y,
		double	z
	)

Specifies the first axis of the coordinate system (Real number type).

Parameters

x	X-component of the first axis
y	Y-component of the first axis
z	Z-component of the first axis

void CoordinateSystem::SetName ( String & name )

Specifies the name of the coordinate system.

Parameters

name	Name of the coordinate system

void CoordinateSystem::SetOrigin ( Point * origin )

Specifies the center point of the coordinate system (Point type).

Parameters

origin Center point of the coordinate system

void CoordinateSystem::SetOriginWithUnit	(	Point *	origin,
		String &	unitName
	)

Specifies the center point of the coordinate system by specifying the unit (Point type).

Parameters

origin	Center point of the coordinate system
unitName	Unit

void CoordinateSystem::SetOriginXYZ	(	double	x,
		double	y,
		double	z
	)

Specifies the center coordinate of the coordinate system (Real number type).

Parameters

x	X-component of the center point
y	Y-component of the center point
z	Z-component of the center point

void CoordinateSystem::SetOriginXYZWithUnit	(	double	x,
		double	y,
		double	z,
		String &	unitName
	)

Specifies the center point of the coordinate system by specifying the unit (Real number type).

Parameters

x	X-value of the center point
y	Y-value of the center point
z	Z-value of the center point
unitName	Unit

void CoordinateSystem::SetSecondAxis ( Point * axis )

Specifies the second axis of the coordinate system (Point type).

Parameters

axis	Each component of the second axis

void CoordinateSystem::SetSecondAxisXYZ	(	double	x,
		double	y,
		double	z
	)

Specifies the second axis of the coordinate system (Real number type).

Parameters

x	X-component of the second axis
y	Y-component of the second axis
z	Z-component of the second axis

Public Member Functions

Detailed Description

Member Function Documentation