agi.foundation.stk

Enum StkEphemerisFile.DistanceUnit

java.lang.Object

java.lang.Enum<StkEphemerisFile.DistanceUnit>

agi.foundation.stk.StkEphemerisFile.DistanceUnit

All Implemented Interfaces:

Enumeration, Serializable, Comparable<StkEphemerisFile.DistanceUnit>

Enclosing class:

StkEphemerisFile

public static enum StkEphemerisFile.DistanceUnit
extends Enum<StkEphemerisFile.DistanceUnit>
implements Enumeration

The supported distance units of measure for ephemeris and covariance information.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FEET Distance units are in feet.
KILOFEET Distance units are in kilofeet.
KILOMETERS Distance units are in kilometers.
METERS Distance units are in meters.
NAUTICAL_MILES Distance units are in nautical miles.
STATUTE_MILES Distance units are in statute miles.

Method Summary

Modifier and Type	Method and Description
static StkEphemerisFile.DistanceUnit	getDefault() Get the enum constant that is considered to be the default.
static StkEphemerisFile.DistanceUnit	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static StkEphemerisFile.DistanceUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static StkEphemerisFile.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

METERS

public static final StkEphemerisFile.DistanceUnit METERS

Distance units are in meters.

KILOMETERS

public static final StkEphemerisFile.DistanceUnit KILOMETERS

Distance units are in kilometers.

FEET

public static final StkEphemerisFile.DistanceUnit FEET

Distance units are in feet.

KILOFEET

public static final StkEphemerisFile.DistanceUnit KILOFEET

Distance units are in kilofeet.

NAUTICAL_MILES

public static final StkEphemerisFile.DistanceUnit NAUTICAL_MILES

Distance units are in nautical miles.

STATUTE_MILES

public static final StkEphemerisFile.DistanceUnit STATUTE_MILES

Distance units are in statute miles.

Method Detail

values

public static StkEphemerisFile.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 (StkEphemerisFile.DistanceUnit c : StkEphemerisFile.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 StkEphemerisFile.DistanceUnit valueOf(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:

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

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static StkEphemerisFile.DistanceUnit getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static StkEphemerisFile.DistanceUnit getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.