Position.DistanceTo Method

Gets the distance to the given position

Syntax

[Visual Basic]
object.DistanceTo(Position)

[C#]
object.DistanceTo(Position)

[C++]
object->DistanceTo(Position)

Parameters

object

An object expression that evaluates to a GPSToolKit object.

Position

A Position object to which the distance is calculated

Return Value

An Distance object containing the beraring to the given position

Remarks

Distance is calculated using the great circle method.

Errors

If either of the positions in the bearing calculation are not valid, the IsValid property of the returned Angle object will be false.

Example

[Visual Basic]
' Get distance from an initial position to the current position
Dim dist As Distance
Dim currPosition, initialPosition As Position

initialPosition = New Position(42.10, -75.2)
currPosition = myGPSToolKit.Position

dist = initialPosition.DistanceTo(currPosition)


[C#]
// Get distance from an initial position to the current position
Distance dist;
Position currPosition, initialPosition;

initialPosition = new Position(42.10, -75.2);
currPosition = myGPSToolKit.Position;

dist = initialPosition.DistanceTo(currPosition);


[C++]
// Get bearing from an initial position to the current position
Distance *dist;
Position *currPosition, *initialPosition;

initialPosition = new Position(42.10, -75.2);
currPosition = myGPSToolKit->Position;

dist = initialPosition->DistanceTo(currPosition);

See Also