GroundStation.InShadow(Variable, Variable) Method

Top

Description

Returns true if the calling GroundStation is in shadow of any of the CelestialObjects specified by their BodyID at the specified 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.

Method Signature

GroundStation.InShadow(	Variable epoch,
	Variable occultingBodyID)

Arguments

epoch
Description:	The epoch at which the calling GroundStation's shadow state will be evaluated.

occultingBodyID
Description:	BodyID of a CelestialObject to use when determining the calling GroundStation's shadow state.
Repeatable:	1 to Unlimited times

Return Value

Type:

boolean

Returns a value of 1 when the GroundStation is in shadow and a 0 if it is not.

Syntax

myVariable1 = myGroundStation1.InShadow(myVariable2, myVariable3);