org.hermit.geo
Class Vector

java.lang.Object
  extended by org.hermit.geo.Vector

public final class Vector
extends java.lang.Object

This class represents a vector over the Earth's surface -- ie. a distance and azimuth.

Author:
Ian Cameron Smith

Constructor Summary
Vector(Distance distance, Azimuth azimuth)
          Create a Vector from a given distance and azimuth.
 
Method Summary
 java.lang.String formatDegMin()
          Format this vector for user display in degrees and minutes.
 java.lang.String formatDegMinSec()
          Format this vector for user display in degrees and minutes.
static Vector fromMetresRadians(double metres, double radians)
          Create a Vector from distance in metres and an azimuth given in radians.
static Vector fromNmRadians(double nmiles, double radians)
          Create a Vector from distance in nautical miles and an azimuth given in radians.
 Azimuth getAzimuth()
          Get the azimuth.
 double getAzimuthDegrees()
          Get the azimuth in degrees.
 double getAzimuthRadians()
          Get the azimuth in radians.
 Distance getDistance()
          Get the distance.
 double getDistanceMetres()
          Get the distance in metres.
 double getDistanceNm()
          Get the distance in nautical miles.
 java.lang.String toString()
          Format this vector as a String.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Vector

public Vector(Distance distance,
              Azimuth azimuth)
Create a Vector from a given distance and azimuth.

Parameters:
distance - Source distance.
azimuth - Source azimuth.
Method Detail

fromMetresRadians

public static Vector fromMetresRadians(double metres,
                                       double radians)
Create a Vector from distance in metres and an azimuth given in radians.

Parameters:
metres - Source distance in metres.
radians - Source azimuth in radians, clockwise from north.
Returns:
The new Vector.

fromNmRadians

public static Vector fromNmRadians(double nmiles,
                                   double radians)
Create a Vector from distance in nautical miles and an azimuth given in radians.

Parameters:
nmiles - Source distance in nautical miles.
radians - Source azimuth in radians, clockwise from north.
Returns:
The new Vector.

getAzimuth

public final Azimuth getAzimuth()
Get the azimuth.

Returns:
The azimuth.

getAzimuthRadians

public final double getAzimuthRadians()
Get the azimuth in radians.

Returns:
The azimuth in radians, clockwise from north. This will be in the range 0 <= radians < 2 * PI.

getAzimuthDegrees

public final double getAzimuthDegrees()
Get the azimuth in degrees.

Returns:
The azimuth in degrees, clockwise from north. This will be in the range 0 <= degrees < 360.0.

getDistance

public final Distance getDistance()
Get the distance.

Returns:
The distance.

getDistanceMetres

public final double getDistanceMetres()
Get the distance in metres.

Returns:
The distance in metres.

getDistanceNm

public final double getDistanceNm()
Get the distance in nautical miles.

Returns:
The distance in nautical miles.

formatDegMin

public java.lang.String formatDegMin()
Format this vector for user display in degrees and minutes.

Returns:
The formatted vector.

formatDegMinSec

public java.lang.String formatDegMinSec()
Format this vector for user display in degrees and minutes.

Returns:
The formatted vector.

toString

public java.lang.String toString()
Format this vector as a String.

Overrides:
toString in class java.lang.Object
Returns:
This vector as a string, in degrees and minutes.