Units (Coordinate Reference Systems 1.0.0 API)

java.lang.Object
- mil.nga.crs.common.Units

```
public class Units
extends Object
```
Common Units

Author:

osbornb

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ARC_MINUTE` Arc-minute unit name
`static String`	`ARC_SECOND` Arc-second unit name
`static String`	`BIN` Bin unit name
`static String`	`CALENDAR_MONTH` Calendar month unit name
`static String`	`CALENDAR_SECOND` Calendar second unit name
`static String`	`DAY` Day unit name
`static String`	`DEGREE` Degree unit name
`static String`	`GERMAN_LEGAL_METRE` German legal metre unit name
`static String`	`GRAD` Grad unit name
`static String`	`HECTOPASCAL` Hectopascal unit name
`static String`	`HOUR` Hour unit name
`static String`	`KILOMETRE` Kilometre unit name
`static String`	`METRE` Metre unit name
`static String`	`MICROMETRE` Micrometre unit name
`static String`	`MICRORADIAN` Microradian unit name
`static String`	`MICROSECOND` Microsecond unit name
`static String`	`MILLIMETRE` Millimetre unit name
`static String`	`MILLIRADIAN` Milliradian unit name
`static String`	`MILLISECOND` Millisecond unit name
`static String`	`MINUTE` Minute unit name
`static String`	`PARTS_PER_MILLION` Parts per million unit name
`static String`	`PASCAL` Pascal unit name
`static String`	`RADIAN` Radian unit name
`static String`	`SECOND` Second unit name
`static String`	`UNITY` Unity unit name
`static String`	`US_SURVEY_FOOT` US survey foot unit name
`static String`	`YEAR` Year unit name

Constructor Summary

Constructors
Constructor and Description

Units()

Constructors
Constructor and Description
`Units()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`canConvert(Unit unit1, Unit unit2)` Determine if values can be converted between the two units
`static double`	`convert(double value, Unit from, Unit to)` Convert the value from a unit to a same typed unit, both with conversion factors
`static Unit`	`getArcMinute()` Get an arc-minute unit
`static Unit`	`getArcSecond()` Get an arc-second unit
`static Unit`	`getBin()` Get a bin unit
`static Unit`	`getCalendarMonth()` Get a calendar month unit
`static Unit`	`getCalendarSecond()` Get a calendar second unit
`static Unit`	`getDay()` Get a day unit
`static Unit`	`getDefaultUnit(UnitType type)` Get the default unit for the unit type
`static Unit`	`getDegree()` Get a degree unit
`static Unit`	`getGermanLegalMetre()` Get a German legal metre unit
`static Unit`	`getGrad()` Get a grad unit
`static Unit`	`getHectopascal()` Get a hectopascal unit
`static Unit`	`getHour()` Get a hour unit
`static Unit`	`getKilometre()` Get a kilometre unit
`static Unit`	`getMetre()` Get a metre unit
`static Unit`	`getMicrometre()` Get a micrometre unit
`static Unit`	`getMicroradian()` Get a microradian unit
`static Unit`	`getMicrosecond()` Get a microsecond unit
`static Unit`	`getMillimetre()` Get a millimetre unit
`static Unit`	`getMilliradian()` Get a milliradian unit
`static Unit`	`getMillisecond()` Get a millisecond unit
`static Unit`	`getMinute()` Get a minute unit
`static Unit`	`getPartsPerMillion()` Get a parts per million unit
`static Unit`	`getPascal()` Get a pascal unit
`static Unit`	`getRadian()` Get a radian unit
`static Unit`	`getSecond()` Get a second unit
`static Unit`	`getUnity()` Get a unity unit
`static Unit`	`getUSSurveyFoot()` Get a US survey foot unit
`static Unit`	`getYear()` Get a year unit

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MICROMETRE
```
public static final String MICROMETRE
```
    Micrometre unit name
    
    See Also:
    
    Constant Field Values
  - MILLIMETRE
```
public static final String MILLIMETRE
```
    Millimetre unit name
    
    See Also:
    
    Constant Field Values
  - METRE
```
public static final String METRE
```
    Metre unit name
    
    See Also:
    
    Constant Field Values
  - KILOMETRE
```
public static final String KILOMETRE
```
    Kilometre unit name
    
    See Also:
    
    Constant Field Values
  - GERMAN_LEGAL_METRE
```
public static final String GERMAN_LEGAL_METRE
```
    German legal metre unit name
    
    See Also:
    
    Constant Field Values
  - US_SURVEY_FOOT
```
public static final String US_SURVEY_FOOT
```
    US survey foot unit name
    
    See Also:
    
    Constant Field Values
  - MICRORADIAN
```
public static final String MICRORADIAN
```
    Microradian unit name
    
    See Also:
    
    Constant Field Values
  - MILLIRADIAN
```
public static final String MILLIRADIAN
```
    Milliradian unit name
    
    See Also:
    
    Constant Field Values
  - RADIAN
```
public static final String RADIAN
```
    Radian unit name
    
    See Also:
    
    Constant Field Values
  - ARC_SECOND
```
public static final String ARC_SECOND
```
    Arc-second unit name
    
    See Also:
    
    Constant Field Values
  - ARC_MINUTE
```
public static final String ARC_MINUTE
```
    Arc-minute unit name
    
    See Also:
    
    Constant Field Values
  - DEGREE
```
public static final String DEGREE
```
    Degree unit name
    
    See Also:
    
    Constant Field Values
  - GRAD
```
public static final String GRAD
```
    Grad unit name
    
    See Also:
    
    Constant Field Values
  - UNITY
```
public static final String UNITY
```
    Unity unit name
    
    See Also:
    
    Constant Field Values
  - BIN
```
public static final String BIN
```
    Bin unit name
    
    See Also:
    
    Constant Field Values
  - PARTS_PER_MILLION
```
public static final String PARTS_PER_MILLION
```
    Parts per million unit name
    
    See Also:
    
    Constant Field Values
  - PASCAL
```
public static final String PASCAL
```
    Pascal unit name
    
    See Also:
    
    Constant Field Values
  - HECTOPASCAL
```
public static final String HECTOPASCAL
```
    Hectopascal unit name
    
    See Also:
    
    Constant Field Values
  - MICROSECOND
```
public static final String MICROSECOND
```
    Microsecond unit name
    
    See Also:
    
    Constant Field Values
  - MILLISECOND
```
public static final String MILLISECOND
```
    Millisecond unit name
    
    See Also:
    
    Constant Field Values
  - SECOND
```
public static final String SECOND
```
    Second unit name
    
    See Also:
    
    Constant Field Values
  - MINUTE
```
public static final String MINUTE
```
    Minute unit name
    
    See Also:
    
    Constant Field Values
  - HOUR
```
public static final String HOUR
```
    Hour unit name
    
    See Also:
    
    Constant Field Values
  - DAY
```
public static final String DAY
```
    Day unit name
    
    See Also:
    
    Constant Field Values
  - YEAR
```
public static final String YEAR
```
    Year unit name
    
    See Also:
    
    Constant Field Values
  - CALENDAR_SECOND
```
public static final String CALENDAR_SECOND
```
    Calendar second unit name
    
    See Also:
    
    Constant Field Values
  - CALENDAR_MONTH
```
public static final String CALENDAR_MONTH
```
    Calendar month unit name
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Units
```
public Units()
```
- Method Detail
  - getMicrometre
```
public static Unit getMicrometre()
```
    Get a micrometre unit
    
    Returns:
    
    micrometre unit
  - getMillimetre
```
public static Unit getMillimetre()
```
    Get a millimetre unit
    
    Returns:
    
    millimetre unit
  - getMetre
```
public static Unit getMetre()
```
    Get a metre unit
    
    Returns:
    
    metre unit
  - getKilometre
```
public static Unit getKilometre()
```
    Get a kilometre unit
    
    Returns:
    
    kilometre unit
  - getGermanLegalMetre
```
public static Unit getGermanLegalMetre()
```
    Get a German legal metre unit
    
    Returns:
    
    German legal metre unit
  - getUSSurveyFoot
```
public static Unit getUSSurveyFoot()
```
    Get a US survey foot unit
    
    Returns:
    
    US survey foot unit
  - getMicroradian
```
public static Unit getMicroradian()
```
    Get a microradian unit
    
    Returns:
    
    microradian unit
  - getMilliradian
```
public static Unit getMilliradian()
```
    Get a milliradian unit
    
    Returns:
    
    milliradian unit
  - getRadian
```
public static Unit getRadian()
```
    Get a radian unit
    
    Returns:
    
    radian unit
  - getArcSecond
```
public static Unit getArcSecond()
```
    Get an arc-second unit
    
    Returns:
    
    arc-second unit
  - getArcMinute
```
public static Unit getArcMinute()
```
    Get an arc-minute unit
    
    Returns:
    
    arc-minute unit
  - getDegree
```
public static Unit getDegree()
```
    Get a degree unit
    
    Returns:
    
    degree unit
  - getGrad
```
public static Unit getGrad()
```
    Get a grad unit
    
    Returns:
    
    grad unit
  - getUnity
```
public static Unit getUnity()
```
    Get a unity unit
    
    Returns:
    
    unity unit
  - getBin
```
public static Unit getBin()
```
    Get a bin unit
    
    Returns:
    
    bin unit
  - getPartsPerMillion
```
public static Unit getPartsPerMillion()
```
    Get a parts per million unit
    
    Returns:
    
    parts per million unit
  - getPascal
```
public static Unit getPascal()
```
    Get a pascal unit
    
    Returns:
    
    pascal unit
  - getHectopascal
```
public static Unit getHectopascal()
```
    Get a hectopascal unit
    
    Returns:
    
    hectopascal unit
  - getMicrosecond
```
public static Unit getMicrosecond()
```
    Get a microsecond unit
    
    Returns:
    
    microsecond unit
  - getMillisecond
```
public static Unit getMillisecond()
```
    Get a millisecond unit
    
    Returns:
    
    millisecond unit
  - getSecond
```
public static Unit getSecond()
```
    Get a second unit
    
    Returns:
    
    second unit
  - getMinute
```
public static Unit getMinute()
```
    Get a minute unit
    
    Returns:
    
    minute unit
  - getHour
```
public static Unit getHour()
```
    Get a hour unit
    
    Returns:
    
    hour unit
  - getDay
```
public static Unit getDay()
```
    Get a day unit
    
    Returns:
    
    day unit
  - getYear
```
public static Unit getYear()
```
    Get a year unit
    
    Returns:
    
    year unit
  - getCalendarSecond
```
public static Unit getCalendarSecond()
```
    Get a calendar second unit
    
    Returns:
    
    calendar second unit
  - getCalendarMonth
```
public static Unit getCalendarMonth()
```
    Get a calendar month unit
    
    Returns:
    
    calendar month unit
  - getDefaultUnit
```
public static Unit getDefaultUnit(UnitType type)
```
    Get the default unit for the unit type
    
    Parameters:
    
    type - unit type
    
    Returns:
    
    default unit or null if no default
  - canConvert
```
public static boolean canConvert(Unit unit1,
                                 Unit unit2)
```
    Determine if values can be converted between the two units
    
    Parameters:
    
    unit1 - first unit
    
    unit2 - second unit
    
    Returns:
    
    true if can convert
  - convert
```
public static double convert(double value,
                             Unit from,
                             Unit to)
```
    Convert the value from a unit to a same typed unit, both with conversion factors
    
    Parameters:
    
    value - value to convert
    
    from - unit to convert from
    
    to - unit to convert to
    
    Returns:
    
    converted value

Class Units

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MICROMETRE

MILLIMETRE

METRE

KILOMETRE

GERMAN_LEGAL_METRE

US_SURVEY_FOOT

MICRORADIAN

MILLIRADIAN

RADIAN

ARC_SECOND

ARC_MINUTE

DEGREE

GRAD

UNITY

BIN

PARTS_PER_MILLION

PASCAL

HECTOPASCAL

MICROSECOND

MILLISECOND

SECOND

MINUTE

HOUR

DAY

YEAR

CALENDAR_SECOND

CALENDAR_MONTH

Constructor Detail

Units

Method Detail

getMicrometre

getMillimetre

getMetre

getKilometre

getGermanLegalMetre

getUSSurveyFoot

getMicroradian

getMilliradian

getRadian

getArcSecond

getArcMinute

getDegree

getGrad

getUnity

getBin

getPartsPerMillion

getPascal

getHectopascal

getMicrosecond

getMillisecond

getSecond

getMinute

getHour

getDay

getYear

getCalendarSecond

getCalendarMonth

getDefaultUnit

canConvert

convert