org.hermit.astro
Enum Body.Field

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

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

This enumeration defines the data fields that are stored for each body.


Enum Constant Summary
ABS_BRIGHT_LIMB
          The position angle of the bright limb of this body from North.
APPARENT_DIAMETER
          The apparent diameter of the body from the observer's position, in radians.
DECLINATION_AP
          The declination of the body, in radians.
DECLINATION_TOPO
          The topocentric declination of the body, in radians.
EARTH_DISTANCE
          The distance of the body from the Earth, in AU.
EC_LATITUDE
          The ecliptic latitude of the body, in radians.
EC_LONGITUDE
          The ecliptic longitude of the body, in radians.
HE_LATITUDE
          The heliocentric latitude of the body, in radians.
HE_LONGITUDE
          The heliocentric longitude of the body, in radians.
HE_RADIUS
          The heliocentric radius of the body, in AU.
HORIZ_PARALLAX
          The equatorial horizontal parallax, in radians.
LOCAL_ALTITUDE
          The altitude of the body from the observer, in radians.
LOCAL_AZIMUTH
          The azimuth of the body from the observer, in radians, 0=north.
LOCAL_HOUR_ANGLE
          The local hour angle of the body from the observer, in radians.
MAGNITUDE
          The magnitude of this body as seen from Earth.
OBS_BRIGHT_LIMB
          The position angle of the bright limb of this body as seen from Earth.
PARALLACTIC
          Parallactic angle of this body as seen from the Earth.
PHASE
          The phase, as the fraction (0-1) of the disc which is illuminated.
PHASE_ANGLE
          The phase angle, i.e.
RIGHT_ASCENSION_AP
          The right ascension of the body, in radians.
RIGHT_ASCENSION_TOPO
          The topocentric right ascension of the body, in radians.
RISE_TIME
          Rise time.
RISE_TWILIGHT
          Time at which nautical twilight begins before sunrise (SUN only).
SET_TIME
          Set time.
SET_TWILIGHT
          Time at which nautical twilight ends after sunset (SUN only).
TRANSIT_TIME
          Transit time.
 
Method Summary
static Body.Field valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Body.Field[] 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

HE_LATITUDE

public static final Body.Field HE_LATITUDE
The heliocentric latitude of the body, in radians.


HE_LONGITUDE

public static final Body.Field HE_LONGITUDE
The heliocentric longitude of the body, in radians.


HE_RADIUS

public static final Body.Field HE_RADIUS
The heliocentric radius of the body, in AU.


EC_LONGITUDE

public static final Body.Field EC_LONGITUDE
The ecliptic longitude of the body, in radians.


EC_LATITUDE

public static final Body.Field EC_LATITUDE
The ecliptic latitude of the body, in radians.


RIGHT_ASCENSION_AP

public static final Body.Field RIGHT_ASCENSION_AP
The right ascension of the body, in radians.


DECLINATION_AP

public static final Body.Field DECLINATION_AP
The declination of the body, in radians.


HORIZ_PARALLAX

public static final Body.Field HORIZ_PARALLAX
The equatorial horizontal parallax, in radians.


RIGHT_ASCENSION_TOPO

public static final Body.Field RIGHT_ASCENSION_TOPO
The topocentric right ascension of the body, in radians. This is RIGHT_ASCENSION_AP corrected for parallax.


DECLINATION_TOPO

public static final Body.Field DECLINATION_TOPO
The topocentric declination of the body, in radians. This is DECLINATION_AP corrected for parallax.


LOCAL_AZIMUTH

public static final Body.Field LOCAL_AZIMUTH
The azimuth of the body from the observer, in radians, 0=north.


LOCAL_ALTITUDE

public static final Body.Field LOCAL_ALTITUDE
The altitude of the body from the observer, in radians.


LOCAL_HOUR_ANGLE

public static final Body.Field LOCAL_HOUR_ANGLE
The local hour angle of the body from the observer, in radians.


EARTH_DISTANCE

public static final Body.Field EARTH_DISTANCE
The distance of the body from the Earth, in AU.


APPARENT_DIAMETER

public static final Body.Field APPARENT_DIAMETER
The apparent diameter of the body from the observer's position, in radians.


RISE_TWILIGHT

public static final Body.Field RISE_TWILIGHT
Time at which nautical twilight begins before sunrise (SUN only).


RISE_TIME

public static final Body.Field RISE_TIME
Rise time.


TRANSIT_TIME

public static final Body.Field TRANSIT_TIME
Transit time.


SET_TIME

public static final Body.Field SET_TIME
Set time.


SET_TWILIGHT

public static final Body.Field SET_TWILIGHT
Time at which nautical twilight ends after sunset (SUN only).


PHASE_ANGLE

public static final Body.Field PHASE_ANGLE
The phase angle, i.e. Sun-Body_Earth angle, in radians.


PHASE

public static final Body.Field PHASE
The phase, as the fraction (0-1) of the disc which is illuminated. This fraction applies to both area and diameter.


PARALLACTIC

public static final Body.Field PARALLACTIC
Parallactic angle of this body as seen from the Earth.


ABS_BRIGHT_LIMB

public static final Body.Field ABS_BRIGHT_LIMB
The position angle of the bright limb of this body from North.


OBS_BRIGHT_LIMB

public static final Body.Field OBS_BRIGHT_LIMB
The position angle of the bright limb of this body as seen from Earth.


MAGNITUDE

public static final Body.Field MAGNITUDE
The magnitude of this body as seen from Earth.

Method Detail

values

public static Body.Field[] 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.Field c : Body.Field.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.Field 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