Spacecraft.InRange(Array, ProximityZone) Method

Top

Description

Returns a value of 0 when targetArray is outside all the specified rangeDefinitionProximityZone on the calling Spacecraft, and returns a value of 1 if targetArray is within the boundary of at least one ProximityZone. FreeFlyer uses a definitive analytical solution to evaluate this event.

Since the evaluation is instantaneous, care must be taken to adjust the propagator step size such that events of interest aren't skipped over.

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.

Method Signature

Spacecraft.InRange(	Array targetArray,
	ProximityZone rangeDefinitionProximityZone)

Arguments

targetArray
Description:	A 3-component Array containing a position vector in the Earth-Centered, Earth-Fixed Coordinate System to be used as the target in the range calculation.
Required Size:	At least 3

rangeDefinitionProximityZone
Description:	ProximityZone used to define range boundaries.
Repeatable:	1 to 30 times

Return Value

Type:

boolean

Returns a value of 0 when the specified object is outside the specified ProximityZone(s) on the calling Spacecraft, and returns a value of 1 if the object is within the boundary of one or more ProximityZones.

Syntax

myVariable1 = mySpacecraft1.InRange(myArray1, myProximityZone1);