Description
Returns the start time, end time, and duration of a Spacecraft's Sensor's view of celestialBody. The Access time is based on any active Sensors on the calling Spacecraft.
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
celestialBody
|
|
Description:
|
The numerical identifier for the celestial body that the calling Spacecraft is attempting to access. Body ID's 1-11 are assigned to the default Solar System objects, as shown below. Custom CelestialObjects will have body ID's starting at 12 and assigned in the order they are created.
|
Valid Values:
|
Celestial Object
|
Value
|
Mercury
|
Mercury.BodyID or 1
|
Venus
|
Venus.BodyID or 2
|
Earth
|
Earth.BodyID or 3
|
Mars
|
Mars.BodyID or 4
|
Jupiter
|
Jupiter.BodyID or 5
|
Saturn
|
Saturn.BodyID or 6
|
Uranus
|
Uranus.BodyID or 7
|
Neptune
|
Neptune.BodyID or 8
|
Pluto
|
Pluto.BodyID or 9
|
Moon
|
Moon.BodyID or 10
|
Sun
|
Sun.BodyID or 11
|
<Custom CelestialBody>
|
<Custom CelestialBody>.BodyID, starting at 12 and assigned in the order the custom CelestialObjects are created.
|
|
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 Sensor's view starts before the beginning of the propagation span, FreeFlyer will label the start of the propagation as the start of the Sensor's view.
|
EventType
|
|
Description:
|
The type of the event that occurred. Event Type == 1 is entry into Contact. Event Type == 2 is exit from Contact.
|
Return Value
Returns the number of elements filled into EventType and EventTime arrays
Syntax
myVariable1 = mySpacecraft1.Access(myVariable2, myTimeSpanArray1, myArray1);
|
See also
Spacecraft Object
Spacecraft.Access
Spacecraft Propagation Guide
Coverage and Contact Analysis Guide
|