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 nanosecond timing precision mode.
Click here to see the documentation for this object in millisecond 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
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
Returns the number of elements filled into EventType and EventTime arrays
Syntax
myVariable1 = mySpacecraft1.SunTerminatorCrossingTimes(myTimeSpanArray1, myArray1);
|
This example demonstrates how to generate a report of when a Spacecraft's sub-satellite point is within the Earth-Umbra cone. An output of 0 indicates that no passes were recorded, if more than one pass is recorded during one step of the Spacecraft, all events during the step are included in the EventTime TimeSpanArray and EventType Array. An Event Type == 1 is an entry into the umbral cone and Event Type == 2 is an exit from the umbral cone.
Spacecraft Spacecraft1;
Variable i;
Variable numEvents;
Array EventTypes[0];
TimeSpanArray EventTimes[0];
StringArray EventTypeLabels = {"", "Entry into Umbra cone", "Exit from Umbra cone "};
// Propagate and Report Sun Terminator Crossing Times
While (Spacecraft1.ElapsedTime < TIMESPAN(1 days));
numEvents = Spacecraft1.SunTerminatorCrossingTimes(EventTimes, EventTypes);
For i = 0 to numEvents-1 step 1;
Report EventTypeLabels[EventTypes[i]], EventTimes[i].ConvertToCalendarDate() to "SunTerminatorCrossingTimesArrayNew.txt";
End;
Step Spacecraft1;
End;
|
Output:
|
See also
Spacecraft Object
Spacecraft.SunTerminatorCrossingTimes
Spacecraft Propagation Guide
Coverage and Contact Analysis Guide
|