Vector.BuildVector(Variable, CelestialObject, Variable) Method

Top

Description

When vectorType is "Body Axis", the calling Vector will be initialized as the CelestialObject body axis specified by referenceAxis in ICRF.

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

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

Method Signature

Vector.BuildVector(	Variable vectorType,
	CelestialObject celestialObject1,
	Variable referenceAxis)

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

celestialObject1
Description:	A CelestialObject Object. Can be user-defined or one of the predefined CelestialObjects in FreeFlyer.

referenceAxis

Description:

Used to indicate whether the Vector is the x, y, or z axis.

Valid Values:

Value	Label
1	x
2	y
3	z

Return Value

Type:

number

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

Syntax

myVariable1 = myVector1.BuildVector(myVariable2, myCelestialObject1, myVariable3);