VisibilitySegment.VisibilityTimes(TimeSpan, TimeSpanArray, Array) Method

Top

Description

Detects start of visibility (AOS) and end of visibility (LOS) events.

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

VisibilitySegment.VisibilityTimes(	TimeSpan evaluationEpoch,
	TimeSpanArray eventTimes,
	Array eventTypes)

Arguments

evaluationEpoch
Description:	This epoch defines an end-point of the evaluation interval. FreeFlyer will determine whether any events have occurred between this epoch and the previous evaluationEpoch specified for this argument.

eventTimes
Description:	An Array to be filled with the detected event times.

eventTypes

Description:

An Array to be filled with the detected event types.

Event Type == 1 is start of visibility.

Event Type == 2 is end of visibility.

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

Return Value

Type:

number

Returns the number of detected event.

Syntax

myVariable1 = myVisibilitySegment1.VisibilityTimes(myTimeSpan1, myTimeSpanArray1, myArray1);