Vector Object

Name

Description

Attributes

Active

Specifies whether or not to evaluate methods of the vector and draw it in the MissionView.

Type:   Variable

Access: Read/Write

Alpha

Right ascension of the Vector in spherical coordinates. Used with Vector.Delta and Vector.Magnitude.

Type:   Variable

Access: Read/Write

Units:   deg

Color

The color to draw the vector. The color can be overridden for an individual view using the ViewWindow.SetObjectColor() method.

Type:   Variable

Access: Read/Write

DeclaredName

The name of the object as declared.

Type:   String

Access: Read-Only

Delta

Declination of the Vector in spherical coordinates measured in the x-y plane. Used with Vector.Alpha and Vector.Magnitude.

Type:   Variable

Access: Read/Write

Units:   deg

DisplayName

The name displayed for this object in output windows such as views, plots, and reports.

Type:   String

Access: Read/Write

DrawMethod

Method in which to draw the vector

Type:   Variable

Access: Read/Write

Element

The x, y, z components of the vector.

Type:   Array

Access: Read/Write

Epoch

For Vector objects built on vectors which are relative to the position of bodies that move in space over time, the Epoch property indicates the time at which the Vector is defined or re-evaluated.

To model a Vector that rotates in time, the Vector object should be updated any time the spacecraft state is updated. Therefore, the user should add a line Inside the control loop of the script to synchronize the coordinate system (in time) with the spacecraft, such asVector1.Epoch = Spacecraft1.Epoch;

The Epoch property can also be set to a time in GSFC MJD Format

Type:   TimeSpan

Access: Read/Write

Units:   day

ExistingXAxisCoordinateSystem

Specifies the coordinate system to use when the VectorType is 'Existing X-Axis'.

Type:   Variable

Access: Read/Write

LabelLocation

Determines where the vector label is drawn when the DrawMethod is arrow and the vector is visualized in a Mission View.

Type:   Variable

Access: Read/Write

Magnitude

Vector magnitude used with spherical coordinates. Used with Vector.Alpha and Vector.Delta.

Type:   Variable

Access: Read/Write

MagnitudeScaleFactor

Scale factor applied to the magnitude of the vector for visualization.

Type:   Variable

Access: Read/Write

ObjectId

The unique identifier for the object.

Type:   Variable

Access: Read-Only

ObjectType

The type of the object.

Type:   String

Access: Read-Only

ReferenceAxis

Specifies the body axis to use for VectorType = 4(Body Axis).

Type:   Variable

Access: Read/Write

VectorType

The type of vector.

Type:   Variable

Access: Read/Write

VisualOffset

Positional offset of the origin of the vector for Visualization. The offset origin is measured from the ICRF.

Type:   Array

Access: Read/Write

Units:   km

Name

Description

BuildVector

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.

ClearSavedStates

Clears previous saved states for this object.

ConvertFromCoordinateSystem

Converts the Vector object from the custom CoordinateSystem by applying the direction cosine matrix of the CoordinateSystem object as a rotation to the calling Vector object.

ConvertToCoordinateSystem

Converts the Vector object into the custom CoordinateSystem by applying the direction cosine matrix of the CoordinateSystem object as a rotation to the calling Vector object.

GetFromFile

Load the object state from the specified FreeFlyer object file.

GetFromString

Load the object state from the specified string.

IntersectionTimes

This method provides a sequential listing of events related to the intersection of two objects, where one object moves to at least partially intersect another object. The objects can be a ThreeDModel and a Vector or a ProximityZone and a Vector. The start times, end times, and duration of the intersection are returned. FreeFlyer uses a definitive analytical solution to evaluate this method.

Intersects

Determines if the Vector object intersects any of the objects supplied as arguments.

PutToFile

Convert the object state to FreeFlyer object xml and write to a file.

PutToString

Convert the object state to FreeFlyer object xml and return as a string.

ReferenceEquals

Returns 1 if the argument refers to the calling object and 0 otherwise.

ResetMethodStates

Resets any method states associated with the calling object.

Restore

Restore an object's state from a previously saved state.

Save

Save the object's state so that it can be restored later.

ToColumnMatrix

Returns a column matrix representation of the value.

ToRowMatrix

Returns a row matrix representation of the value.

VertexAngle

Returns the angle in degrees between two 3-element vectors.