Spacecraft.UmbralShadowTimes(TimeSpanArray, Array) Method

 Top 

Description

Determines the entry time, exit time, and duration of a Spacecraft's pass through the shadow of a central body. Events are reported for umbral shadow conditions only.

 

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

Spacecraft.UmbralShadowTimes(

TimeSpanArray 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 time in shadow starts before the beginning of the propagation span, FreeFlyer will label the start of the propagation as the start of the time in shadow.

 

 

EventType

Description:

The type of the event that occurred. Event type == 101 is entry into umbral shadow. Event type == 102 is exit from umbral shadow.

 

 

 

Return Value

Type:

number

 

 

Returns the number of elements filled into EventType and EventTime arrays.

 

Syntax

myVariable1 = mySpacecraft1.UmbralShadowTimes(myTimeSpanArray1, myArray1);

 

 

Example 1

This example demonstrates how to generate a report of a Spacecraft's passes through its central body's umbral shadow.

 

Spacecraft Spacecraft1;

Variable i;

Variable shadowTimes;

TimeSpanArray EventTime;

Array EventType;

String scEventType;

String scEventTime;

DataTableWindow scReport({scEventType, scEventTime});

 

While (Spacecraft1.ElapsedTime < TIMESPAN(1 days));

 

          shadowTimes = Spacecraft1.UmbralShadowTimes(EventTime, EventType);

 

          If(shadowTimes > 0) then;

                      For i = 0 to shadowTimes - 1 step 1;

                                  Switch (EventType[i]);

                                              Case 101:

                                                          scEventType = "Entry into Umbral Shadow: ";

                                                          scEventTime = EventTime[i].ConvertToCalendarDate();

                                                          Update scReport;

                                                          Break;

                                              Case 102:

                                                          scEventType = "Exit from Umbral Shadow: ";

                                                          scEventTime = EventTime[i].ConvertToCalendarDate();

                                                          Update scReport;

                                  End;

                      End;

          End;

 

          Step Spacecraft1;

 

End;

 

 

Output:

 

scEventType

scEventTime

Entry into Umbral Shadow:

Exit from Umbral Shadow:

Entry into Umbral Shadow:

Exit from Umbral Shadow:

Entry into Umbral Shadow:

Exit from Umbral Shadow:

Entry into Umbral Shadow:

Exit from Umbral Shadow:

Entry into Umbral Shadow:

Exit from Umbral Shadow:

Entry into Umbral Shadow:

Exit from Umbral Shadow:

Entry into Umbral Shadow:

Exit from Umbral Shadow:

Entry into Umbral Shadow:

Exit from Umbral Shadow:

Entry into Umbral Shadow:

Exit from Umbral Shadow:

Entry into Umbral Shadow:

Exit from Umbral Shadow:

Entry into Umbral Shadow:

Exit from Umbral Shadow:

Entry into Umbral Shadow:

Exit from Umbral Shadow:

Entry into Umbral Shadow:

Exit from Umbral Shadow:

Entry into Umbral Shadow:

Exit from Umbral Shadow:

Entry into Umbral Shadow:

Exit from Umbral Shadow:

Jan 01 2020 00:00:00.000000000

Jan 01 2020 00:06:53.232421875

Jan 01 2020 01:12:00.703125000

Jan 01 2020 01:45:49.877929687

Jan 01 2020 02:50:57.275390625

Jan 01 2020 03:24:46.450195312

Jan 01 2020 04:29:53.774414062

Jan 01 2020 05:03:42.949218750

Jan 01 2020 06:08:50.346679687

Jan 01 2020 06:42:39.594726562

Jan 01 2020 07:47:46.992187500

Jan 01 2020 08:21:36.313476562

Jan 01 2020 09:26:43.710937500

Jan 01 2020 10:00:33.105468750

Jan 01 2020 11:05:40.283203125

Jan 01 2020 11:39:29.677734375

Jan 01 2020 12:44:36.782226562

Jan 01 2020 13:18:26.176757812

Jan 01 2020 14:23:33.281250000

Jan 01 2020 14:57:22.749023437

Jan 01 2020 16:02:29.780273437

Jan 01 2020 16:36:19.321289062

Jan 01 2020 17:41:26.352539062

Jan 01 2020 18:15:15.966796875

Jan 01 2020 19:20:22.924804687

Jan 01 2020 19:54:12.612304687

Jan 01 2020 20:59:19.570312500

Jan 01 2020 21:33:09.257812500

Jan 01 2020 22:38:16.142578125

Jan 01 2020 23:12:05.903320312

 

 

 

See also

Spacecraft Object

Spacecraft.UmbralShadowTimes

Spacecraft Propagation Guide

Coverage and Contact Analysis Guide