DistanceUnit

java.lang.Object
- java.lang.Enum<DistanceUnit>
- - org.ka2ddo.util.DistanceUnit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DistanceUnit>, UnitEnum<DistanceUnit>, UnitEnumHasShortUnit<DistanceUnit>
```
public enum DistanceUnit
extends java.lang.Enum<DistanceUnit>
implements UnitEnumHasShortUnit<DistanceUnit>
```
This enumeration declares units (with conversion factors) for measuring distances.

Author:

Andrew Pavlin, KA2DDO

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CM` Distances in centimeters.
`DEG_LAT` Distances in degrees of latitude upon the Earth.
`FEET` Distances in feet.
`INCH` Distances in inches.
`KM` Distances in kilometers,
`METER` Distances in meters.
`MI` Distances in statute miles.
`MM` Distances in millimeters.
`NM` Distances in nautical miles.
`STORIES` Distances (heights) in building floors or stories.

Field Summary

Fields
Modifier and Type	Field and Description
`static float`	`CONV_DEGLAT_TO_METERS` Convenience constant for degrees latitude to meters when both units are fixed in equation.
`static float`	`CONV_METERS_TO_DEGLAT` Convenience constant for meters to degrees latitude when both units are fixed in equation.
`static float`	`CONV_METERS_TO_FT` Convenience constant for meters to feet when both units are fixed in equation.
`static float`	`CONV_METERS_TO_MI` Convenience constant for meters to statute miles when both units are fixed in equation.
`static float`	`CONV_NM_TO_METERS` Convenience constant for nautical miles to meters when both units are fixed in equation.
`static float`	`CONV_NM_TO_MI` Convenience constant for nautical miles to statute miles.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`float`	`from(DistanceUnit other)` Get the multiplicative conversion factor to convert a distance from the specified units to this unit.
`java.lang.String`	`getAbbreviation()` Get short standard abbreviations for this DistanceUnit.
`int`	`getDepth()` Get depth index for this unit instance's hierarchy of different-sized units.
`static DistanceUnit[]`	`getLandDistanceUnits()` Get an array of all DistanceUnits that are commonly used for traveling distances across land or sea.
`float`	`getOffset(DistanceUnit other)` Get the additive offset to convert a value from the specified unit to this unit.
`DistanceUnit`	`getShortUnit()` Get the shorter DistanceUnit associated with this DistanceUnit.
`float`	`getSpeedDurationScaleToHr()` Get the scaling factor for a speed duration unit relative to the most common unit of hours (e.g., miles per hour).
`java.lang.String`	`getSpeedString()` Get the descriptive String for a DistanceUnit when used for velocity as DistanceUnit per hour.
`DistanceUnit`	`getTinyUnit()` Get the extremely short DistanceUnit associated with this DistanceUnit.
`static DistanceUnit`	`getUnitForName(java.lang.String name)` Convert a string representing the abbreviations for a DistanceUnit into the enum instance for that unit.
`static DistanceUnit`	`lookupSpeedUnit(java.lang.String speedUnit)` Find the DistanceUnit whose speed has the specified unit name.
`static DistanceUnit`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static DistanceUnit[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - MM
```
public static final DistanceUnit MM
```
    Distances in millimeters.
  - CM
```
public static final DistanceUnit CM
```
    Distances in centimeters.
  - INCH
```
public static final DistanceUnit INCH
```
    Distances in inches.
  - METER
```
public static final DistanceUnit METER
```
    Distances in meters.
  - FEET
```
public static final DistanceUnit FEET
```
    Distances in feet.
  - KM
```
public static final DistanceUnit KM
```
    Distances in kilometers,
  - MI
```
public static final DistanceUnit MI
```
    Distances in statute miles.
  - NM
```
public static final DistanceUnit NM
```
    Distances in nautical miles.
  - DEG_LAT
```
public static final DistanceUnit DEG_LAT
```
    Distances in degrees of latitude upon the Earth.
  - STORIES
```
public static final DistanceUnit STORIES
```
    Distances (heights) in building floors or stories.
- Field Detail
  - CONV_DEGLAT_TO_METERS
```
public static final float CONV_DEGLAT_TO_METERS
```
    Convenience constant for degrees latitude to meters when both units are fixed in equation.
  - CONV_METERS_TO_DEGLAT
```
public static final float CONV_METERS_TO_DEGLAT
```
    Convenience constant for meters to degrees latitude when both units are fixed in equation.
  - CONV_NM_TO_METERS
```
public static final float CONV_NM_TO_METERS
```
    Convenience constant for nautical miles to meters when both units are fixed in equation.
  - CONV_METERS_TO_MI
```
public static final float CONV_METERS_TO_MI
```
    Convenience constant for meters to statute miles when both units are fixed in equation.
  - CONV_METERS_TO_FT
```
public static final float CONV_METERS_TO_FT
```
    Convenience constant for meters to feet when both units are fixed in equation.
  - CONV_NM_TO_MI
```
public static final float CONV_NM_TO_MI
```
    Convenience constant for nautical miles to statute miles.
- Method Detail
  - values
```
public static DistanceUnit[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (DistanceUnit c : DistanceUnit.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DistanceUnit valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - from
```
public final float from(DistanceUnit other)
```
    Get the multiplicative conversion factor to convert a distance from the specified units to this unit.
    
    Specified by:
    
    from in interface UnitEnum<DistanceUnit>
    
    Parameters:
    
    other - another DistanceUnit representing the existing units of a distance value
    
    Returns:
    
    the conversion factor to change a distance value into this unit
  - getOffset
```
public float getOffset(DistanceUnit other)
```
    Get the additive offset to convert a value from the specified unit to this unit.
    
    Specified by:
    
    getOffset in interface UnitEnum<DistanceUnit>
    
    Parameters:
    
    other - another DistanceUnit representing the existing units of a value
    
    Returns:
    
    the offset (after multiplying by the from() factor) to add to get the value in this unit
  - getShortUnit
```
public final DistanceUnit getShortUnit()
```
    Get the shorter DistanceUnit associated with this DistanceUnit.
    
    Specified by:
    
    getShortUnit in interface UnitEnumHasShortUnit<DistanceUnit>
    
    Returns:
    
    shorter DistanceUnit in same system of measurement
  - getTinyUnit
```
public final DistanceUnit getTinyUnit()
```
    Get the extremely short DistanceUnit associated with this DistanceUnit.
    
    Returns:
    
    much shorter DistanceUnit in same system of measurement, or null if no such unit
  - lookupSpeedUnit
```
public static DistanceUnit lookupSpeedUnit(java.lang.String speedUnit)
```
    Find the DistanceUnit whose speed has the specified unit name.
    
    Parameters:
    
    speedUnit - String of speed unit, such as "mph", "kph", etc.
    
    Returns:
    
    DistanceUnit for this speed string, or null if no match
  - getSpeedString
```
public java.lang.String getSpeedString()
```
    Get the descriptive String for a DistanceUnit when used for velocity as DistanceUnit per hour.
    
    Returns:
    
    speed unit String
  - getSpeedDurationScaleToHr
```
public float getSpeedDurationScaleToHr()
```
    Get the scaling factor for a speed duration unit relative to the most common unit of hours (e.g., miles per hour). For example, feet can appear as a speed unit of feet per minute (1/60 of an hour).
    
    Returns:
    
    return the scaling factor that would convert units-per-hour into the time unit in the speed name
  - getAbbreviation
```
public java.lang.String getAbbreviation()
```
    Get short standard abbreviations for this DistanceUnit.
    
    Returns:
    
    abbreviations string
  - getUnitForName
```
public static DistanceUnit getUnitForName(java.lang.String name)
```
    Convert a string representing the abbreviations for a DistanceUnit into the enum instance for that unit.
    
    Parameters:
    
    name - String to be translated into a DistanceUnit
    
    Returns:
    
    corresponding DistanceUnit, or null if no match found
  - getLandDistanceUnits
```
public static DistanceUnit[] getLandDistanceUnits()
```
    Get an array of all DistanceUnits that are commonly used for traveling distances across land or sea. This is to prevent cases where shorter units in the same system of units can be picked on the Preferences dialog.
    
    Returns:
    
    array of DistanceUnits
  - getDepth
```
public int getDepth()
```
    Get depth index for this unit instance's hierarchy of different-sized units.
    
    Specified by:
    
    getDepth in interface UnitEnumHasShortUnit<DistanceUnit>
    
    Returns:
    
    zero-based index of how many times you can get a shorter unit before you reach the smallest unit

Enum DistanceUnit

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

MM

CM

INCH

METER

FEET

KM

MI

NM

DEG_LAT

STORIES

Field Detail

CONV_DEGLAT_TO_METERS

CONV_METERS_TO_DEGLAT

CONV_NM_TO_METERS

CONV_METERS_TO_MI

CONV_METERS_TO_FT

CONV_NM_TO_MI

Method Detail

values

valueOf

from

getOffset

getShortUnit

getTinyUnit

lookupSpeedUnit

getSpeedString

getSpeedDurationScaleToHr

getAbbreviation

getUnitForName

getLandDistanceUnits

getDepth