Spacecraft.ExclusionZone(Region) Method

Top

Description

Returns the start time, end time, and duration of a pass based on a Spacecraft's location over a Region. The ExclusionZone time is based on the Spacecraft's sub-satellite point within a Region.

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

Region Region)

Arguments

Region
Description:	Region to use in the exclusion zone calculation.

Return Value

Type:

string

Returns the start time, end time, and duration of a pass based on a Spacecraft 's location over a Region. The ExclusionZone time is based on the Spacecraft's sub-satellite point within a Region.

The FF_Preferences.IntervalEventReportingBehavior property controls whether the start and end of propagation are reported as events. 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. If the pass extends past the end of the propagation span, FreeFlyer labels the end of propagation as the end of the pass.

Syntax

myString1 = mySpacecraft1.ExclusionZone(myRegion1);