gov.nasa.gsfc.spdf.ssc
Enum DistanceUnits

java.lang.Object
  java.lang.Enum<DistanceUnits>
      gov.nasa.gsfc.spdf.ssc.DistanceUnits

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DistanceUnits>

public enum DistanceUnits
extends java.lang.Enum<DistanceUnits>

This class represents the different units for distance values supported by SSC.

Note: The integer values for this enumeration cannot be arbitrarily assigned. They must match the values expected by other parts of the SSC software.

Version:

$Revison: $

Author:

B. Harris

Enum Constant Summary

E_KM
Scientific Notation Kilometers.

INT_KM
Integer Kilometers.

KM
Kilometers (km).

RE
Earth Radii (RE).

Method Summary

static DistanceUnits	fromValue(int value) Provides the distance units corresponding to the given integer value.
java.lang.String	toString() Provides a string representation of this distance units.
int	value() Provides the integer value corresponding to this distance units.
static DistanceUnits	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DistanceUnits[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RE

public static final DistanceUnits RE

Earth Radii (RE).

KM

public static final DistanceUnits KM

Kilometers (km).

INT_KM

public static final DistanceUnits INT_KM

Integer Kilometers.

E_KM

public static final DistanceUnits E_KM

Scientific Notation Kilometers.

Method Detail

values

public static DistanceUnits[] 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 (DistanceUnits c : DistanceUnits.values())
    System.out.println(c);

Returns:

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

valueOf

public static DistanceUnits 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

value

public int value()

Provides the integer value corresponding to this distance units.

Returns:

integer value corrsponding to this distance units.

fromValue

public static DistanceUnits fromValue(int value)

Provides the distance units corresponding to the given integer value.

Parameters:

value - integer value corresponding to a distance units

Returns:

DistanceUnits corresponding to the given value

Throws:

java.lang.IllegalArgumentException - if the given value does not correspond to any distance units

toString

public java.lang.String toString()

Provides a string representation of this distance units.

Overrides:

toString in class java.lang.Enum<DistanceUnits>

Returns:

a string representation of this distance units