Description
The OrbitApogee method is a conditional property that can be used with the Step command to advance the Spacecraft to apogee, the point in the orbit where the Spacecraft is at its furthest distance from a celestial 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. The celestial body to be used in the apoapsis calculation can be specified using a Variable, String, or CelestialObject. If a celestial body is not specified, the current Spacecraft Central Body will be used.
Note that as a general rule this method should only be used as a propagation stopping condition and should not be used as a means monitor whether or not a Spacecraft is at apogee at a particular epoch.
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.
Overload List
Signatures
|
Return Value
|
Description
|
Spacecraft.OrbitApogee()
|
Variable
|
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.
|
Spacecraft.OrbitApogee(CelestialObject celestialObject)
|
Variable
|
Returns the point in the orbit where the Spacecraft is at its furthest distance from the specified celestialObject. 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.
|
Spacecraft.OrbitApogee(String referenceBodyName)
|
Variable
|
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.
|
Spacecraft.OrbitApogee(Variable referenceBodyIDVariable)
|
Variable
|
Returns the point in the orbit where the Spacecraft is at its furthest distance from the celestial body represented by referenceBodyIDVariable. 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.
|
See also
Spacecraft Object
Stop-Propagation Properties and Methods
Spacecraft Propagation Guide
Coverage and Contact Analysis Guide
|