Spacecraft.PassData(GroundStation, TimeSpanArray, Array, Array) Method

Top 

Description

Returns the number of elements that have been populated into the EventTime, EventType, and EventElevation arrays. The arrays are populated with the time, type, and elevation of pass events, where an event can be: Acquisition of Signal (AOS), Loss of Signal (LOS), and the maximum elevation of the contact.

 

The PassData method will account for refraction if refraction modeling is turned on using the GroundStation.RefractionModelType property.

 

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.PassData(

GroundStation groundStation,


TimeSpanArray EventTime,


Array EventType,


Array EventElevation)

 

 

Arguments

groundStation


Description:

The GroundStation to be used in the calculation.

 

 

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

 

 

EventType


Description:

The type of the event that occurred. Event Type == 1 is beginning of pass. Event Type == 2 is end of pass. Event Type == 3 is maximum elevation of pass.

 

 

EventElevation


Description:

The elevation when the event occurred.

 

 

 

Return Value

Type:

number

 

 

Returns the number of elements filled into the EventTime, EventType, and EventElevation arrays

 

Syntax

myVariable1 = mySpacecraft1.PassData(myGroundStation1, myTimeSpanArray1, myArray1, myArray2);

 

 

See also

Spacecraft Object

Spacecraft.PassData

Spacecraft Propagation Guide

Coverage and Contact Analysis Guide