Description
The Occult method determines if an object is hidden from the view of the calling Spacecraft by the Earth. It returns a '1' when the object is occulted or '0' when it is not. When multiple objects are specified, the method returns a '1' if any of the objects are occulted and '0' if none are occulted.
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.Occult(Array referencePositionArray)
|
Variable
|
Returns a 1 when the referencePositionArray is occulted or 0 when it is not. The Array must be specified in Earth Fixed coordinates. When multiple objects are specified, the method returns a '1' if any of the objects are occulted and '0' if none are occulted.
|
Spacecraft.Occult(PointGroup referencePositionPointGroup)
|
Variable
|
Returns a 1 when the referencePositionPointGroup is occulted or 0 when it is not. Only the first point in the PointGroup is used for this analysis. When multiple objects are specified, the method returns a '1' if any of the objects are occulted and '0' if none are occulted.
|
Spacecraft.Occult(Spacecraft referencePositionSpacecraft)
|
Variable
|
Returns a 1 when the referencePositionSpacecraft is occulted or 0 when it is not. When multiple objects are specified, the method returns a '1' if any of the objects are occulted and '0' if none are occulted.
|
See also
Spacecraft Object
Spacecraft Propagation Guide
Coverage and Contact Analysis Guide
|