Spacecraft.PlanetVelocity(Variable) Method

Top 

Description

Returns the velocity vector of planetaryBody taken with respect to the CentralBody of the Spacecraft 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

Spacecraft.PlanetVelocity(

Variable planetaryBody)

 

 

Arguments

planetaryBody


Description:

The numerical identifier for the celestial body whose velocity will be reported. Body ID's 1-11 are assigned to the default Solar System objects, as shown below. Custom CelestialObjects will have body ID's starting at 12 and assigned in the order they are created.

Valid Range:

planetaryBody ≥ 1

Valid Values:

Celestial Object

Value

Mercury

Mercury.BodyID or 1

Venus

Venus.BodyID or 2

Earth

Earth.BodyID or 3

Mars

Mars.BodyID or 4

Jupiter

Jupiter.BodyID or 5

Saturn

Saturn.BodyID or 6

Uranus

Uranus.BodyID or 7

Neptune

Neptune.BodyID or 8

Pluto

Pluto.BodyID or 9

Moon

Moon.BodyID or 10

Sun

Sun.BodyID or 11

<Custom CelestialBody>

<Custom CelestialBody>.BodyID, starting at 12 and assigned in the order the custom CelestialObjects are created.

 

 

 

 

Return Value

Type:

Array of number (size = 3)

Units:

km/s

 

 

Returns the velocity vector of the specified planetary body with respect to the CentralBody of the Spacecraft in the ICRF.

 

Syntax

myArray1 = mySpacecraft1.PlanetVelocity(myVariable1);

 

 

See also

Spacecraft Object

Spacecraft Propagation Guide

Coverage and Contact Analysis Guide