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 nanosecond timing precision mode.
Click here to see the documentation for this object in millisecond 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: |
|
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)); |
The OrbitApoapsis method can be used to notify the user when the Spacecraft has reached the apoapsis of its orbit. The following example shows how you can determine if a Spacecraft is at the apoapsis of its orbit around Mars. Spacecraft1 is assumed to be in an orbit around Mars.
The first Report command will report a 0, provided the Spacecraft is not initialized at the apoapsis of its orbit. The second Report command will report a 1, signifying the spacecraft has reached apoapsis.
Note: This example only works with orbits that have an eccentricity larger than 0.0001. |
See also
Coverage and Contact Analysis Guide