Package gaiasky.util

Enum Class Settings.DistanceUnits

java.lang.Object

java.lang.Enum<Settings.DistanceUnits>

gaiasky.util.Settings.DistanceUnits

All Implemented Interfaces:

Serializable, Comparable<Settings.DistanceUnits>, Constable

Enclosing class:

Settings

public static enum Settings.DistanceUnits
extends Enum<Settings.DistanceUnits>

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
AU
INTERNAL
KM
LY
M
PC

Field Summary

Fields

Modifier and Type	Field	Description
final double	fromKm
final double	toKm

Method Summary

Modifier and Type	Method	Description
double	fromInternalUnits(double internal)	Returns the given value, given in internal units, in the units represented by this object.
String	getUnitString()
double	toInternalUnits(double value)	Converts the given value in the units represented by this object in internal units.
static Settings.DistanceUnits	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Settings.DistanceUnits[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INTERNAL

public static final Settings.DistanceUnits INTERNAL

M

public static final Settings.DistanceUnits M

KM

public static final Settings.DistanceUnits KM

AU

public static final Settings.DistanceUnits AU

PC

public static final Settings.DistanceUnits PC

LY

public static final Settings.DistanceUnits LY

Field Details

toKm

public final double toKm

fromKm

public final double fromKm

Method Details

values

public static Settings.DistanceUnits[] 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 Settings.DistanceUnits 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

getUnitString

public String getUnitString()

toInternalUnits

public double toInternalUnits(double value)

Converts the given value in the units represented by this object in internal units.

Parameters:

value - The value in the units represented by this object.

Returns:

The value in internal units.

fromInternalUnits

public double fromInternalUnits(double internal)

Returns the given value, given in internal units, in the units represented by this object.

Parameters:

internal - The value in internal units.

Returns:

The value in the units represented by this object.