com.isti.util.gis
Class LocationDistanceInformation

java.lang.Object
  extended by com.isti.util.gis.LocationDistanceInformation
All Implemented Interfaces:
MeasurementUnitsInformation

public class LocationDistanceInformation
extends java.lang.Object
implements MeasurementUnitsInformation


Field Summary
protected  double azim
           
protected  double distance
           
protected  java.lang.String name
           
 
Fields inherited from interface com.isti.util.MeasurementUnitsInformation
DEFAULT_MEASUREMENT_UNITS, FEET, FEET_TO_METER, KILOM, KM_TO_MILE, METER, METER_TO_FEET, METER_TO_KM, METER_TO_MILE, MILE_TO_KM, MILE_TO_METER, MILES
 
Constructor Summary
LocationDistanceInformation()
          Constructs the distance information with default values.
LocationDistanceInformation(double distance, double azim, java.lang.String name)
          Constructs the distance information with the specified values.
 
Method Summary
 double getAzim()
          Gets the azimuth value.
 java.lang.String getAzimString()
          Gets the azimuth string.
 double getDistance()
          Gets the distance value in the current units.
 java.lang.String getDistanceString()
          Gets the distance string in the current units.
 double getDistMeters()
          Returns the distance value in meters.
 int getMeasurementUnits()
          Gets the measurement units.
 java.lang.String getName()
          Gets the name of the closest point.
 void setMeasurementUnits(int mu)
          Sets the measurement units.
 java.lang.String toString()
          Gets a string representation of the distance information.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

distance

protected double distance

azim

protected double azim

name

protected java.lang.String name
Constructor Detail

LocationDistanceInformation

public LocationDistanceInformation()
Constructs the distance information with default values.


LocationDistanceInformation

public LocationDistanceInformation(double distance,
                                   double azim,
                                   java.lang.String name)
Constructs the distance information with the specified values.

Parameters:
distance - distance between the points, in meters.
azim - azimuth from point to point.
name - name of the location.
Method Detail

getAzim

public double getAzim()
Gets the azimuth value.

Returns:
the azimuth value.

getAzimString

public java.lang.String getAzimString()
Gets the azimuth string.

Returns:
the azimuth direction string.

getMeasurementUnits

public int getMeasurementUnits()
Gets the measurement units.

Specified by:
getMeasurementUnits in interface MeasurementUnitsInformation
Returns:
the measurement units.

setMeasurementUnits

public void setMeasurementUnits(int mu)
Sets the measurement units.

Specified by:
setMeasurementUnits in interface MeasurementUnitsInformation
Parameters:
mu - the measurement units.

getDistMeters

public double getDistMeters()
Returns the distance value in meters.

Returns:
The distance value in meters.

getDistance

public double getDistance()
Gets the distance value in the current units.

Returns:
the distance value.

getDistanceString

public java.lang.String getDistanceString()
Gets the distance string in the current units.

Returns:
the distance string.

getName

public java.lang.String getName()
Gets the name of the closest point.

Returns:
the name of the closest point.

toString

public java.lang.String toString()
Gets a string representation of the distance information.

Overrides:
toString in class java.lang.Object
Returns:
a string representation of the distance information.