Spacecraft.Range(Variable) Method

Top 

Description

Returns the distance between the calling Spacecraft and the CelestialObject whose BodyId matches coID.

 

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

 

Method Signature

Spacecraft.Range(

Variable coID)

 

Arguments

coID


Description:

The numerical identifier of the celestial body to use in the calculation of range from the calling Vehicle. 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:

coID ≥ 0

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:

number

Units:

km

 

Returns the distance between two Vehicles, a Vehicle and a GroundStation, or a Vehicle and a CelestialObject.

 

Syntax

myVariable1 = mySpacecraft1.Range(myVariable2);

 

See also

Spacecraft Object

Spacecraft.Range

Spacecraft Propagation Guide

Coverage and Contact Analysis Guide