Vector.BuildVector(Variable, CelestialObject, Star) Method

Top

Description

When vectorType is "Object to Star", the calling Vector will be initialized as a unit vector pointing in the direction of the Star provided as the star argument with origin at celestialObject1 in 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,
	CelestialObject celestialObject1,
	Star star)

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.

star
Description:	A Star object to use as a direction when constructing the calling Vector.

Return Value

Type:

number

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

Syntax

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