agi.foundation.coordinates

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

Enum OrbitType

java.lang.Object

java.lang.Enum<OrbitType>

agi.foundation.coordinates.OrbitType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<OrbitType>

public enum OrbitType
extends Enum<OrbitType>
implements Enumeration

An enumeration of the possible types and special cases of orbits.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CIRCULAR An orbit where the eccentricity is zero.
ELLIPTICAL An orbit where the eccentricity is between zero and unity.
HYPERBOLIC An orbit with an eccentricity greater than unity.
INVALID An orbit where the eccentricity is less than zero.
PARABOLIC An orbit where the eccentricity is exactly unity.

Method Summary

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

CIRCULAR

public static final OrbitType CIRCULAR

An orbit where the eccentricity is zero.

ELLIPTICAL

public static final OrbitType ELLIPTICAL

An orbit where the eccentricity is between zero and unity.

PARABOLIC

public static final OrbitType PARABOLIC

An orbit where the eccentricity is exactly unity.

HYPERBOLIC

public static final OrbitType HYPERBOLIC

An orbit with an eccentricity greater than unity.

INVALID

public static final OrbitType INVALID

An orbit where the eccentricity is less than zero.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.