Spacecraft.OrbitApogee(String) Method

Top 

Description

Returns the point in the orbit where the Spacecraft is at its furthest distance from the celestial body represented by referenceBodyName. FreeFlyer determines this condition by monitoring the dot product between the position and velocity vectors and identifying when this value passes from positive to negative.

 

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.OrbitApogee(

String referenceBodyName)

 

 

Arguments

referenceBodyName


Description:

A String containing the name of the celestial object to use when looking for apoapsis.

 

 

 

Return Value

Type:

number

Units:

km

 

 

Returns the point in the orbit where the Spacecraft is at its furthest distance from its central body. FreeFlyer determines this condition by monitoring the dot product between the position and velocity vectors and identifying when this value passes from positive to negative.

 

Syntax

Step mySpacecraft1 to ( mySpacecraft1.OrbitApogee(myString1));

 

 

Example 1

 

 

See also

Spacecraft Object

Spacecraft.OrbitApogee

Spacecraft Propagation Guide

Coverage and Contact Analysis Guide