agi.foundation.celestial

(agi.foundation.models-2024r2.jar)

Enum EclipseType

java.lang.Object

java.lang.Enum<EclipseType>

agi.foundation.celestial.EclipseType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<EclipseType>

public enum EclipseType
extends Enum<EclipseType>
implements Enumeration

Enumerates the different types of shadowing that can occur during an eclipse.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANTUMBRA The entire body is eclipsing the sun, however it is too small to completely block out the sun (also known as an annular eclipse).
NONE The object is in full sunlight.
PARTIAL A Partial eclipse is a Penumbra or Antumbra eclipse.
PENUMBRA Part of a body is eclipsing the sun.
UMBRA The object is totally occulted.

Method Summary

Modifier and Type	Method and Description
static EclipseType	getDefault() Get the enum constant that is considered to be the default.
static EclipseType	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 EclipseType	valueOf(String name) Returns the enum constant of this type with the specified name.
static EclipseType[]	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

NONE

public static final EclipseType NONE

The object is in full sunlight.

UMBRA

public static final EclipseType UMBRA

The object is totally occulted.

PENUMBRA

public static final EclipseType PENUMBRA

Part of a body is eclipsing the sun.

ANTUMBRA

public static final EclipseType ANTUMBRA

The entire body is eclipsing the sun, however it is too small to completely block out the sun (also known as an annular eclipse).

PARTIAL

public static final EclipseType PARTIAL

A Partial eclipse is a Penumbra or Antumbra eclipse.

Method Detail

values

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

Returns:

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

valueOf

public static EclipseType 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 EclipseType 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 EclipseType getDefault()

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

Returns:

The default enum constant.