Package ucar.nc2.dt.ugrid.utils

Enum Class AsaUnits.DistanceType

java.lang.Object

java.lang.Enum<AsaUnits.DistanceType>

ucar.nc2.dt.ugrid.utils.AsaUnits.DistanceType

All Implemented Interfaces:

Serializable, Comparable<AsaUnits.DistanceType>, java.lang.constant.Constable

Enclosing class:

AsaUnits

public static enum AsaUnits.DistanceType
extends Enum<AsaUnits.DistanceType>

Enumeration used in converting between different distance units. Meters are used as a conversion base.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FEET
KILOMETERS
METERS
MILES
NAUTICAL_MILES
UNKNOWN

Method Summary

Modifier and Type	Method	Description
double	convertFromMeters(double n)
double	convertToMeters(double n)
String	getDisplayName()
static AsaUnits.DistanceType	getDistanceType(String string)
String	toString()
static AsaUnits.DistanceType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AsaUnits.DistanceType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final AsaUnits.DistanceType UNKNOWN

METERS

public static final AsaUnits.DistanceType METERS

KILOMETERS

public static final AsaUnits.DistanceType KILOMETERS

MILES

public static final AsaUnits.DistanceType MILES

FEET

public static final AsaUnits.DistanceType FEET

NAUTICAL_MILES

public static final AsaUnits.DistanceType NAUTICAL_MILES

Method Details

values

public static AsaUnits.DistanceType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AsaUnits.DistanceType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

convertToMeters

public double convertToMeters(double n)

Returns:

the number of meters equal to n when n is in the units specified by this enumeration

convertFromMeters

public double convertFromMeters(double n)

Returns:

a number in the units specified by this enumeration equal to n meters

getDisplayName

public String getDisplayName()

toString

public String toString()

Overrides:

toString in class Enum<AsaUnits.DistanceType>

getDistanceType

public static AsaUnits.DistanceType getDistanceType(String string)