Vector.BuildVector(Variable, CelestialObject, Vehicle) Method

Top 

Description

When vectorType is "Object to Object", the calling Vector will be initialized as the position of vehicle1 with respect to celestialObject1 in the 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,


Vehicle vehicle1)

 

 

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.

 

 

vehicle1


Description:

A Vehicle Object.

Allowed Types:

Vehicle, GroundVehicle, Spacecraft

 

 

 

Return Value

Type:

number

 

 

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

 

Syntax

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

 

 

See also

Vector Object

Vector.BuildVector

Coverage and Contact Analysis Guide

Vectors and Coordinate Systems Guide

Matrix, Array, and Variable Math Guide