ProximityZone.InRange(Spacecraft) Method

Top 

Description

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. 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 nanosecond timing precision mode.

Click here to see the documentation for this object in millisecond timing precision mode.

 

Method Signature

ProximityZone.InRange(

Spacecraft targetSpacecraft)

 

 

Arguments

targetSpacecraft


Description:

Spacecraft to be used as the target in the range calculation.

 

 

 

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 = myProximityZone1.InRange(mySpacecraft1);

 

 

See also

ProximityZone Object

ProximityZone.InRange

Coverage and Contact Analysis Guide

ProximityZones Guide