Vector.BuildVector(Variable, Sensor, Variable) Method

 Top 

Description

When vectorType is "Body Axis", the calling Vector will be initialized as the Sensor body axis specified by referenceAxis in 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,

Sensor sensor,

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

 

 

 

sensor

Description:

A Sensor object.

 

 

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, mySensor1, myVariable3);

 

 

See also

Vector Object

Vector.BuildVector

Coverage and Contact Analysis Guide

Vectors and Coordinate Systems Guide

Matrix, Array, and Variable Math Guide