Description
Computes the observed noon as seen by the Spacecraft. Noon is defined as the midpoint between the two times when the Spacecraft exits and enters the Earth's umbral cone. This method returns the shadow entry and exits times, as well as the time of Spacecraft Noon.
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.SpacecraftNoon(
|
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 exit from shadow is before the beginning of the propagation span, FreeFlyer will label the start of the propagation as the exit from shadow.
|
EventType
|
|
Description:
|
The type of the event that occurred. Event type == 1 is exit from shadow. Event type == 2 is entry into shadow. Event type == 3 is spacecraft noon.
|
Return Value
Returns the number of elements filled into EventType and EventTime arrays
Syntax
myVariable1 = mySpacecraft1.SpacecraftNoon(myArray1, myArray2);
|
This example demonstrates how to generate a report of a Spacecraft's noon, defined to be the midpoint between the two times when the Spacecraft exits and enters the Earth's umbral cone. This method reports three different event types: Event type == 1 is exit from shadow, Event type == 2 is entry into shadow, Event type == 3 is the Spacecraft's noon, along with the event time.
Spacecraft Spacecraft1;
Variable i;
Variable noonTimes;
Array EventTime;
Array EventType;
String scEventType;
String scEventTime;
DataTableWindow scReport({scEventType, scEventTime}, 0);
While (Spacecraft1.ElapsedDays < 1);
noonTimes = Spacecraft1.SpacecraftNoon(EventTime, EventType);
If(noonTimes > 0) then;
For i = 0 to noonTimes - 1 step 1;
Switch (EventType[i]);
Case 1:
scEventType = "Exit From Shadow: ";
scEventTime = EventTime[i].EpochFormat();
Update scReport;
Break;
Case 2:
scEventType = "Entry Into Shadow: ";
scEventTime = EventTime[i].EpochFormat();
Update scReport;
Break;
Case 3:
scEventType = "Spacecraft Noon: ";
scEventTime = EventTime[i].EpochFormat();
Update scReport;
End;
End;
End;
Step Spacecraft1;
End;
|
Output:
|
See also
Spacecraft Object
Spacecraft.SpacecraftNoon
Spacecraft.CardinalPoints
Spacecraft Propagation Guide
Coverage and Contact Analysis Guide
|