Spacecraft.PlanetPosition(Variable) Method

Top 

Description

Returns the position vector of planetaryBody as the location of the planet's system barycenter 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.PlanetPosition(

Variable planetaryBody)

 

 

Arguments

planetaryBody


Description:

The numerical identifier for the celestial body whose position 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

 

 

Returns the position vector of the specified planetary body in the ICRF. The planetary body location is defined as the location of the planet's system barycenter and not the actual position of the planetary body.

 

Syntax

myArray1 = mySpacecraft1.PlanetPosition(myVariable1);

 

 

See also

Spacecraft Object

Spacecraft Propagation Guide

Coverage and Contact Analysis Guide