Spacecraft.OrbitApoapsis(Variable) Method

 Top 

Description

Returns the point in the orbit where the Spacecraft is at its furthest distance from the celestial body represented by referenceBodyIDVariable.

 

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.

 

Note: This is a Stop-Propagation method. See the Stop-Propagation Properties and Methods page for more information.

Note: This method has a state. See the Methods and Properties with State page for more information.

 

Method Signature

Spacecraft.OrbitApoapsis(

Variable referenceBodyIDVariable)

 

 

Arguments

referenceBodyIDVariable

Description:

A Variable containing the numerical identifier for the celestial object to use when looking for apoapsis. 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:

referenceBodyIDVariable ≥ 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 point in the orbit where the Spacecraft is at its furthest distance from a Planet, Moon, or CelestialObject.

 

Syntax

Step mySpacecraft1 to ( mySpacecraft1.OrbitApoapsis(myVariable1));

 

 

See also

Spacecraft Object

Spacecraft.OrbitApoapsis

Spacecraft Propagation Guide

Coverage and Contact Analysis Guide