Spacecraft.Occult(Array) Method

Top

Description

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.

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.

Method Signature

Spacecraft.Occult(

Array referencePositionArray)

Arguments

referencePositionArray
Description:	Array used to specify the position of an object to check for occultation with the calling Spacecraft. The Array must be specified in the Earth-Centered, Earth-Fixed Coordinate System.
Repeatable:	1 to 30 times

Return Value

Type:

boolean

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.

Syntax

myVariable1 = mySpacecraft1.Occult(myArray1);