BlockageDiagram.LineOfSightTimes(Spacecraft, Star, Array, Array, Array) Method

Top 

Description

Determines the start or end of sight between the source Spacecraft and the target Star using the loaded blockage diagram. The source's body-fixed frame defines the base for the blockage diagram look angle frame orientation. The specified occulting bodies are also considered.

 

Timing Precision Mode

This page describes functionality in millisecond 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

BlockageDiagram.LineOfSightTimes(

Spacecraft source,


Star target,


Array occultingBodies,


Array eventTimes,


Array eventTypes)

 

 

Arguments

source


Description:

The Spacecraft from which to consider line-of-sight calculates. The body-fixed frame of source defines the base for the blockage diagram look angle frame orientation.

 

 

target


Description:

The target Star for line-of-sight calcuations.

 

 

occultingBodies


Description:

Specifies which CelestialObjects to consider for occultations by BodyId.

 

 

eventTimes


Description:

The times that the events occurred.

 

The FF_Preferences.IntervalEventReportingBehavior property controls whether the start of propagation is reported as an event. By default, if line of sight starts before the beginning of the propagation span, FreeFlyer will label the start of the propagation as the start of line of sight.

 

 

eventTypes


Description:

The types of the events that occurred. Event Type == 1 is entry into sight. Event Type == 2 is exit from sight.

 

 

 

Return Value

Type:

number

 

 

Returns the number of events detected. Event types and times are stored in eventTypes and eventTimes respectively.

 

Syntax

myVariable1 = myBlockageDiagram1.LineOfSightTimes(mySpacecraft1, myStar1, myArray1, myArray2, myArray3);

 

 

Example 1

 

 

See also

BlockageDiagram Object

BlockageDiagram.LineOfSightTimes

Blockage Diagram Viewpoints Guide

Coverage and Contact Analysis Guide

Blockage Diagrams Guide