Vector.BuildVector(Variable, Variable) Method

Top

Description

When vectorType is "Existing X-axis", the calling Vector will be initialized as the X-axis of a predefined coordinate frame specified by the coordinateFrame argument in terms of the ICRF.

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

Click here to see the documentation for this object in millisecond timing precision mode.

Method Signature

Vector.BuildVector(	Variable vectorType,
	Variable coordinateFrame)

Arguments

vectorType

Description:

Type of vector to create.

Valid Values:

Value	Label
0	Cartesian
1	Spherical
2	Cross Product
3	Normalized Vector
4	Body Axis
5	Body Angular Momentum
6	Body Position
7	Body Velocity Vector
8	Existing X-axis
9	Object-to-Object
10	Anti-Vector
11	Star
12	Object-to-Star
13	RFLink

coordinateFrame

Description:

Pre-defined Coordinate Frame.

Valid Values:

Value	Label
1	ICRF
2	Mean of J2000 Earth Ecliptic
3	True of Date Earth Equator
4	Earth Fixed
6	True Equator Mean Equinox
8	Mean of Date Earth Equator
18	CIRF

Return Value

Type:

number

Informs the user whether the Vector was built successfully. (0 = Unsuccessful, 1 = Successful)

Syntax

myVariable1 = myVector1.BuildVector(myVariable2, myVariable3);