CelestialObject.Range(Variable, TimeSpan) Method

Top

Description

Returns the distance from the center of the calling CelestialObject to the center of the CelestialObject whose BodyID is targetCelestialObjectBodyID at the specified epoch.

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

CelestialObject.Range(	Variable targetCelestialObjectBodyID,
	TimeSpan epoch)

Arguments

targetCelestialObjectBodyID
Description:	The numerical identifier of the CelestialObject to use in the calculation of range from the calling CelestialObject.
Valid Range:	targetCelestialObjectBodyID ≥ 0

epoch
Description:	The epoch at which to calculate the range.

Return Value

Type:	number
Units:	km

Returns the distance from the center of the calling CelestialObject to the desired target object.

Syntax

myVariable1 = myCelestialObject1.Range(myVariable2, myTimeSpan1);