agi.foundation.coordinates

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

Enum KeplerianElement

java.lang.Object

java.lang.Enum<KeplerianElement>

agi.foundation.coordinates.KeplerianElement

All Implemented Interfaces:

Enumeration, Serializable, Comparable<KeplerianElement>

public enum KeplerianElement
extends Enum<KeplerianElement>
implements Enumeration

An enumeration indicating a specific element in Keplerian elements. This enumeration can be used to identify specific elements in a ModifiedKeplerianElements, a KeplerianElements, or any of the other classical element types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARGUMENT_OF_PERIAPSIS Argument of periapsis.
ECCENTRICITY Eccentricity.
INCLINATION Inclination.
INVERSE_SEMIMAJOR_AXIS Inverse of the semi-major axis.
MEAN_ANOMALY Mean anomaly
PERIOD The orbital period of the orbit in seconds.
RADIUS_OF_APOAPSIS Radius of apoapsis.
RADIUS_OF_PERIAPSIS Radius of periapsis.
RIGHT_ASCENSION_OF_ASCENDING_NODE Right ascension of ascending node.
SEMIMAJOR_AXIS Semi-major axis.
TRUE_ANOMALY True anomaly.

Method Summary

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

RADIUS_OF_PERIAPSIS

public static final KeplerianElement RADIUS_OF_PERIAPSIS

Radius of periapsis.

RADIUS_OF_APOAPSIS

public static final KeplerianElement RADIUS_OF_APOAPSIS

Radius of apoapsis.

INVERSE_SEMIMAJOR_AXIS

public static final KeplerianElement INVERSE_SEMIMAJOR_AXIS

Inverse of the semi-major axis.

INCLINATION

public static final KeplerianElement INCLINATION

Inclination.

ARGUMENT_OF_PERIAPSIS

public static final KeplerianElement ARGUMENT_OF_PERIAPSIS

Argument of periapsis.

RIGHT_ASCENSION_OF_ASCENDING_NODE

public static final KeplerianElement RIGHT_ASCENSION_OF_ASCENDING_NODE

Right ascension of ascending node.

TRUE_ANOMALY

public static final KeplerianElement TRUE_ANOMALY

True anomaly.

MEAN_ANOMALY

public static final KeplerianElement MEAN_ANOMALY

Mean anomaly

ECCENTRICITY

public static final KeplerianElement ECCENTRICITY

Eccentricity.

PERIOD

public static final KeplerianElement PERIOD

The orbital period of the orbit in seconds.

SEMIMAJOR_AXIS

public static final KeplerianElement SEMIMAJOR_AXIS

Semi-major axis.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.