Vector.BuildVector Method

Top 

Description

Uses the specified input arguments to set the origin and pointing information for the Vector object. Returns a Variable that informs the user whether the Vector was built successfully.

 

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.

 

Overload List

Signatures

Return Value

Description

Vector.BuildVector(Variable vectorType)

Variable

When vectorType is "Cartesian", the calling Vector will be initialized as the vector form of the Cartesian inputs defined by the Vector.Element array property in the ICRF. When vectorType is "Spherical", the calling Vector will be initialized as the vector form of the right ascension, declination, and magnitude defined by the properties Vector.Alpha, Vector.Delta, and Vector.Magnitude in the ICRF.

Vector.BuildVector(Variable vectorType, CelestialObject celestialObject1)

Variable

When vectorType is "Body Angular Momentum, Body Position, or Body Velocity", the calling Vector will be initialized as the vector associated with the CelestialObject passed as the second argument.

Vector.BuildVector(Variable vectorType, RFLink link)

Variable

When vectorType is "RFLink", the calling Vector will be initialized as the vector between the RFLink's Source and Target reference objects.

Vector.BuildVector(Variable vectorType, Sensor sensor)

Variable

When vectorType is "Body Angular Momentum, Body Position, or Body Velocity", the calling Vector will be initialized as the vector associated with the Sensor passed as the second argument.

Vector.BuildVector(Variable vectorType, Star star)

Variable

When vectorType is "Star", the calling Vector will be initialized as a unit vector pointing in the direction of the Star provided as the star argument in the ICRF.

Vector.BuildVector(Variable vectorType, String objectName)

Variable

When vectorType is "Body Angular Momentum, Body Position, or Body Velocity", the calling Vector will be initialized as the vector associated with the CelestialObject whose name is passed as the second argument.

Vector.BuildVector(Variable vectorType, Variable coordinateFrame)

Variable

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.

Vector.BuildVector(Variable vectorType, Vector vector1)

Variable

When vectorType is "Normalized Vector", the calling Vector will be initialized as the normalized version of vector1. When vectorType is "Anti-Vector", components of vector1 are negated to initialize the calling Vector in the ICRF.

Vector.BuildVector(Variable vectorType, Vehicle vehicle1)

Variable

When vectorType is "Body Angular Momentum, Body Position, or Body Velocity", the calling Vector will be initialized as the vector associated with the Vehicle passed as the second argument.

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

Variable

When vectorType is "Object to Object", the calling Vector will be initialized as the position of celestialObject2 with respect to celestialObject1 in the ICRF.

Vector.BuildVector(Variable vectorType, CelestialObject celestialObject1, GroundStation groundStation1)

Variable

When vectorType is "Object to Object", the calling Vector will be initialized as the position of groundStation1 with respect to celestialObject1 in the ICRF.

Vector.BuildVector(Variable vectorType, CelestialObject celestialObject1, Star star)

Variable

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.

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

Variable

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

Vector.BuildVector(Variable vectorType, CelestialObject celestialObject1, Vehicle vehicle1)

Variable

When vectorType is "Object to Object", the calling Vector will be initialized as the position of vehicle1 with respect to celestialObject1 in the ICRF.

Vector.BuildVector(Variable vectorType, GroundStation groundStation1, GroundStation groundStation2)

Variable

When vectorType is "Object to Object", the calling Vector will be initialized as the position of groundStation2 with respect to groundStation1 in the ICRF. When two GroundStations are used, the epoch of the Vector is determined from the epoch of the Central Body of groundStation1.

Vector.BuildVector(Variable vectorType, GroundStation groundStation1, Vehicle vehicle1)

Variable

When vectorType is "Object to Object", the calling Vector will be initialized as the position of vehicle1 with respect to groundStation1 in the ICRF.

Vector.BuildVector(Variable vectorType, RFLink link, Variable direction)

Variable

When vectorType is "RFLink", the calling Vector will be initialized as the vector between the RFLink's Source and Target reference objects.

Vector.BuildVector(Variable vectorType, Sensor sensor, CelestialObject celestialObject1)

Variable

When vectorType is "Object to Object", the Vector will be initialized as the position of celestialObject1 with respect to sensor in the ICRF.

Vector.BuildVector(Variable vectorType, Sensor sensor, GroundStation groundStation1)

Variable

When vectorType is "Object to Object", the Vector will be initialized as the position of groundStation1 with respect to sensor in the ICRF.

Vector.BuildVector(Variable vectorType, Sensor sensor, Star star)

Variable

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 sensor in the ICRF.

Vector.BuildVector(Variable vectorType, Sensor sensor, Variable referenceAxis)

Variable

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

Vector.BuildVector(Variable vectorType, Sensor sensor, Vehicle vehicle1)

Variable

When vectorType is "Object to Object", the Vector will be initialized as the position of vehicle1 with respect to sensor in the ICRF.

Vector.BuildVector(Variable vectorType, String objectName, Star star)

Variable

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 the CelestialObject whose name is passed as objectName in the ICRF.

Vector.BuildVector(Variable vectorType, String objectName, String objectName)

Variable

When vectorType is "Object to Object", the calling Vector will be initialized as the position of the CelestialObject whose name is passed as the second argument with respect to the CelestialObject whose name is passed as the first argument in the ICRF.

Vector.BuildVector(Variable vectorType, Vector vector1, Vector vector2)

Variable

When vectorType is "Cross Product", vector1 & vector2 will be crossed to initialize the calling Vector in the ICRF.

Vector.BuildVector(Variable vectorType, Vehicle vehicle1, CelestialObject celestialObject1)

Variable

When vectorType is "Object to Object", the calling Vector will be initialized as the position of celestialObject1 with respect to vehicle1 in the ICRF.

Vector.BuildVector(Variable vectorType, Vehicle vehicle1, GroundStation groundStation1)

Variable

When vectorType is "Object to Object", the calling Vector will be initialized as the position of groundStation1 with respect to vehicle1 in the ICRF.

Vector.BuildVector(Variable vectorType, Vehicle vehicle1, Star star)

Variable

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 vehicle1 in the ICRF.

Vector.BuildVector(Variable vectorType, Vehicle vehicle1, String objectName)

Variable

When vectorType is "Object to Object", the calling Vector will be initialized as the position of the CelestialObject whose name is passed as the second argument with respect to vehicle1 in the ICRF.

Vector.BuildVector(Variable vectorType, Vehicle vehicle1, Variable referenceAxis)

Variable

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

Vector.BuildVector(Variable vectorType, Vehicle vehicle1, Vehicle vehicle2)

Variable

When vectorType is "Object to Object", the calling Vector will be initialized as the position of vehicle2 with respect to vehicle1 in the ICRF.

 

 

See also

Vector Object

Coverage and Contact Analysis Guide

Vectors and Coordinate Systems Guide

Matrix, Array, and Variable Math Guide