Spacecraft.SunTerminatorCrossingTimes(Array, Array) Method

Top

Description

Returns time of entry into darkness, entry into light, and duration in darkness of the spacecraft sub-satellite point. Darkness is defined to be the period when the spacecraft sub-satellite point is within the Earth-Umbra cone.

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.

Note: This is an interval method. See the Interval 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.SunTerminatorCrossingTimes(	Array EventTime,
	Array EventType)

Arguments

EventTime

Description:

The time that the event occurred.

The FF_Preferences.IntervalEventReportingBehavior property controls whether the start of propagation is reported as an event. By default, if the sub-satellite point entry into shadow is before the beginning of the propagation span, FreeFlyer will label the start of the propagation as the start of shadow.

EventType
Description:	The type of the event that occurred. Event Type == 1 is sub-satellite point entry into umbral shadow. Event Type == 2 is sub-satellite point exit from umbral shadow.

Return Value

Type:

number

Returns the number of elements filled into EventType and EventTime arrays

Syntax

myVariable1 = mySpacecraft1.SunTerminatorCrossingTimes(myArray1, myArray2);