Spacecraft.Access(Region, Array, Array) Method

Top

Description

Returns the start time, end time, and duration of a Spacecraft's Sensor's view of region. The Access time is based on any active Sensors on the calling Spacecraft.

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.Access(	Region region,
	Array EventTime,
	Array EventType)

Arguments

region
Description:	The Region that the calling Spacecraft is attempting to access.

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

Type:

number

Returns the number of elements filled into EventType and EventTime arrays

Syntax

myVariable1 = mySpacecraft1.Access(myRegion1, myArray1, myArray2);