com.askgeo.astronomy
Enum ZenithEvent.Type

java.lang.Object
  java.lang.Enum<ZenithEvent.Type>
      com.askgeo.astronomy.ZenithEvent.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ZenithEvent.Type>

Enclosing class:

ZenithEvent

public static enum ZenithEvent.Type
extends java.lang.Enum<ZenithEvent.Type>

Enumerates the event types that mark important moments in the course of astronomical body's passage across the celestial sphere of an observer.

Enum Constant Summary

ASTRONOMICAL_DAWN
Astronomical dawn occurs when the Sun climbs to 18 degrees below the horizon.

ASTRONOMICAL_DUSK
Astronomical dusk occurs when the Sun falls to 18 degrees below the horizon.

CIVIL_DAWN
Civil dawn occurs when the Sun climbs to 6 degrees below the horizon.

CIVIL_DUSK
Civil dusk occurs when the Sun falls to 6 degrees below the horizon.

MAX_ELEVATION
The moment when the body is at a local maximum in elevation (i.e., the highest above the horizon).

MIN_ELEVATION
The moment when the body is at a local minimum in elevation (i.e., the furthest below the horizon).

NAUTICAL_DAWN
Nautical dawn occurs when the Sun climbs to 12 degrees below the horizon.

NAUTICAL_DUSK
Nautical dusk occurs when the Sun falls to 12 degrees below the horizon.

RISE_CENTER
The rise of the center of the disk of an astronomical body is a less common definition for the rise of the Sun or Moon, but it is included for the sake of completeness.

RISE_LOWER_LIMB
The rise of the lower limb of an astronomical body is the time when the bottom of the body rises above the horizon.

RISE_UPPER_LIMB
The rise of the upper limb of an astronomical body is the time when the top of the body first rises above the horizon.

SAMPLE
A moment in time that is not otherwise important but that has been recorded for internal reasons.

SET_CENTER
The setting of the center of the disk of an astronomical body is a less common definition for the setting of the Sun or Moon, but it is included for the sake of completeness.

SET_LOWER_LIMB
The set of the lower limb of an astronomical body is the time when the bottom of the body falls below the horizon.

SET_UPPER_LIMB
The setting of the upper limb of an astronomical body is the time when the top of the body falls below the horizon and no part of the body is visible any longer.

SOLAR_DAWN
Solar dawn occurs when the Sun climbs to 6 degrees above the horizon.

SOLAR_DUSK
Solar dusk occurs when the Sun falls to 6 degrees above the horizon.

Method Summary

double	elevationDeg() The elevation above the horizon (in degrees) at which this event takes place.
int	signAfter() Indicates whether this event occurs during a rising of the body (the elevation is increasing over time), the setting of the body (the elevation is degreasing over time), or at a time when the body is neither rising nor setting (e.g., at minimum or maximum elevation), or when it is indeterminate (e.g., with a sample).
static ZenithEvent.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ZenithEvent.Type[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SAMPLE

public static final ZenithEvent.Type SAMPLE

A moment in time that is not otherwise important but that has been recorded for internal reasons. Includes the end points of the user-specified interval during which the library is searching for ZenithEvents. In most cases, the user will not need to consider ZenithEvent objects with this type.

MIN_ELEVATION

public static final ZenithEvent.Type MIN_ELEVATION

The moment when the body is at a local minimum in elevation (i.e., the furthest below the horizon). For the Sun, this corresponds to solar midnight.

ASTRONOMICAL_DAWN

public static final ZenithEvent.Type ASTRONOMICAL_DAWN

Astronomical dawn occurs when the Sun climbs to 18 degrees below the horizon. To a human the sky is still dark but it is no longer night from an astronomical perspective. This event is typically only talked about for the Sun.

NAUTICAL_DAWN

public static final ZenithEvent.Type NAUTICAL_DAWN

Nautical dawn occurs when the Sun climbs to 12 degrees below the horizon. This is the time after which navigation at sea by the horizon is possible. This event is typically only talked about for the Sun.

CIVIL_DAWN

public static final ZenithEvent.Type CIVIL_DAWN

Civil dawn occurs when the Sun climbs to 6 degrees below the horizon. This is the time after which outdoor activities may be possible without artificial lighting. This event is typically only talked about for the Sun.

RISE_UPPER_LIMB

public static final ZenithEvent.Type RISE_UPPER_LIMB

The rise of the upper limb of an astronomical body is the time when the top of the body first rises above the horizon. This is the moment that is most commonly thought of as sunrise or moonrise.

RISE_CENTER

public static final ZenithEvent.Type RISE_CENTER

The rise of the center of the disk of an astronomical body is a less common definition for the rise of the Sun or Moon, but it is included for the sake of completeness.

RISE_LOWER_LIMB

public static final ZenithEvent.Type RISE_LOWER_LIMB

The rise of the lower limb of an astronomical body is the time when the bottom of the body rises above the horizon. After this time the full disk of the body is fully visible. In some cases, this moment is considered to be sunrise or moonrise.

SOLAR_DAWN

public static final ZenithEvent.Type SOLAR_DAWN

Solar dawn occurs when the Sun climbs to 6 degrees above the horizon. This is the time after which the sky appears fully illuminated. This event is typically only talked about for the Sun.

MAX_ELEVATION

public static final ZenithEvent.Type MAX_ELEVATION

The moment when the body is at a local maximum in elevation (i.e., the highest above the horizon). For the Sun, this corresponds to solar noon.

SOLAR_DUSK

public static final ZenithEvent.Type SOLAR_DUSK

Solar dusk occurs when the Sun falls to 6 degrees above the horizon. This is the time after which the sky begins to darken as sunset approaches. This event is typically only talked about for the Sun.

SET_LOWER_LIMB

public static final ZenithEvent.Type SET_LOWER_LIMB

The set of the lower limb of an astronomical body is the time when the bottom of the body falls below the horizon. After this time the full disk of the body is no longer fully visible. In some cases, this moment is considered to be sunset or moonset.

SET_CENTER

public static final ZenithEvent.Type SET_CENTER

The setting of the center of the disk of an astronomical body is a less common definition for the setting of the Sun or Moon, but it is included for the sake of completeness.

SET_UPPER_LIMB

public static final ZenithEvent.Type SET_UPPER_LIMB

The setting of the upper limb of an astronomical body is the time when the top of the body falls below the horizon and no part of the body is visible any longer. This is the moment that is most commonly thought of as sunset or moonset.

CIVIL_DUSK

public static final ZenithEvent.Type CIVIL_DUSK

Civil dusk occurs when the Sun falls to 6 degrees below the horizon. This is the time after which outdoor activities may not be possible without artificial lighting. This event is typically only talked about for the Sun.

NAUTICAL_DUSK

public static final ZenithEvent.Type NAUTICAL_DUSK

Nautical dusk occurs when the Sun falls to 12 degrees below the horizon. This is the time after which navigation at sea by the horizon is no longer possible. This event is typically only talked about for the Sun.

ASTRONOMICAL_DUSK

public static final ZenithEvent.Type ASTRONOMICAL_DUSK

Astronomical dusk occurs when the Sun falls to 18 degrees below the horizon. To a human the sky has been dark at this point for some time already, but it is after this time and before astronomical dawn that the sky is dark enough for all astronomical observations. This event is typically only talked about for the Sun.

Method Detail

values

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

Returns:

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

valueOf

public static ZenithEvent.Type 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

elevationDeg

public double elevationDeg()

The elevation above the horizon (in degrees) at which this event takes place. If the event does not take place at a particular elevation, such as the minimum or maximum elevation, then this value is Double.NaN.

Returns:

The elevation in degrees of the event type in question, or NaN if the event type is not at a particular elevation.

signAfter

public int signAfter()

Indicates whether this event occurs during a rising of the body (the elevation is increasing over time), the setting of the body (the elevation is degreasing over time), or at a time when the body is neither rising nor setting (e.g., at minimum or maximum elevation), or when it is indeterminate (e.g., with a sample).

Returns:

1 for rising, -1 for setting, and 0 otherwise.