org.hermit.astro
Enum Body.Name

java.lang.Object
  extended by java.lang.Enum<Body.Name>
      extended by org.hermit.astro.Body.Name
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Body.Name>
Enclosing class:
Body

public static enum Body.Name
extends java.lang.Enum<Body.Name>

This enumeration defines the celestial bodies we know about. Each member of the enum also contains the following information for the body:

Note that not all parameters are relevant to all objects. The Moon's diameter and magnitude are calculated in a special way.

Note: for Jupiter and Saturn, the apparent diameter and hence magnitude depend on the angle at which they present themselves to the Earth. We ignore this since we only need a rough magnitude.

NOTE: the angular data in the definitions is presented in the units noted. However we convert to RADIANS for the stored values.


Enum Constant Summary
EARTH
          The Earth.
JUPITER
          Jupiter.
MARS
          Mars.
MERCURY
          Mercury.
MOON
          The Moon.
NEPTUNE
          Neptune.
SATURN
          Saturn.
SUN
          The Sun.
URANUS
          Uranus.
VENUS
          Venus.
 
Field Summary
 java.lang.String name
          Name of this body.
 char symbol
          Symbol of this body.
 org.hermit.astro.Vsop87 terms
          VSOP Periodic terms; null for the Sun and Moon.
 double V_o
          Base factor for magnitude, from AA chapter 41.
 double θ_o
          Apparent diameter in radians at 1 AU (not semi-diameter!).
 
Method Summary
static Body.Name valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Body.Name[] 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

SUN

public static final Body.Name SUN
The Sun.


MOON

public static final Body.Name MOON
The Moon.


MERCURY

public static final Body.Name MERCURY
Mercury.


VENUS

public static final Body.Name VENUS
Venus.


EARTH

public static final Body.Name EARTH
The Earth.


MARS

public static final Body.Name MARS
Mars.


JUPITER

public static final Body.Name JUPITER
Jupiter.


SATURN

public static final Body.Name SATURN
Saturn.


URANUS

public static final Body.Name URANUS
Uranus.


NEPTUNE

public static final Body.Name NEPTUNE
Neptune.

Field Detail

name

public final java.lang.String name
Name of this body.


symbol

public final char symbol
Symbol of this body.


terms

public final org.hermit.astro.Vsop87 terms
VSOP Periodic terms; null for the Sun and Moon.


θ_o

public final double θ_o
Apparent diameter in radians at 1 AU (not semi-diameter!).


V_o

public final double V_o
Base factor for magnitude, from AA chapter 41.

Method Detail

values

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

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

valueOf

public static Body.Name 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