Spacecraft.InRange 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.

 

Overload List

Signatures

Return Value

Description

Spacecraft.InRange(Array targetArray)

Variable

Returns a value of 0 when targetArray is outside all the ProximityZones 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.

Spacecraft.InRange(PointGroup targetPointGroup)

Variable

Returns a value of 0 when the first point of the targetPointGroup is outside all the ProximityZones on the calling Spacecraft, and returns a value of 1 if the first point of the targetPointGroup is within the boundary of at least one ProximityZone. Only the first point in the PointGroup is used for this analysis. 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.

Spacecraft.InRange(ProximityZone rangeDefinitionProximityZone)

Variable

Returns a value of 0 when the calling Spacecraft is outside the rangeDefinitionProximityZone and a 1 when the calling Spacecraft is within the rangeDefinitionProximityZone.

 

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

Spacecraft.InRange(Spacecraft targetSpacecraft)

Variable

Returns a value of 0 when targetSpacecraft is outside all the ProximityZones on the calling Spacecraft, and returns a value of 1 if targetSpacecraft 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.

Spacecraft.InRange(Array targetArray, ProximityZone rangeDefinitionProximityZone)

Variable

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.

Spacecraft.InRange(PointGroup targetPointGroup, ProximityZone rangeDefinitionProximityZone)

Variable

Returns a value of 0 when the first point of the targetPointGroup is outside all the specified rangeDefinitionProximityZone on the calling Spacecraft, and returns a value of 1 if the first point of the targetPointGroup is within the boundary of at least one ProximityZone. Only the first point in the PointGroup is used for this analysis. 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.

Spacecraft.InRange(Spacecraft targetSpacecraft, ProximityZone rangeDefinitionProximityZone)

Variable

Returns a value of 0 when targetSpacecraft is outside all the specified rangeDefinitionProximityZone on the calling Spacecraft, and returns a value of 1 if targetSpacecraft 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.

 

 

See also

Spacecraft Object

Spacecraft Propagation Guide

Coverage and Contact Analysis Guide