agi.foundation.coordinates

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

Enum OrbitDirectionType

java.lang.Object

java.lang.Enum<OrbitDirectionType>

agi.foundation.coordinates.OrbitDirectionType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<OrbitDirectionType>

public enum OrbitDirectionType
extends Enum<OrbitDirectionType>
implements Enumeration

Defines the direction of orbital motion of an object with respect to the rotation of its primary body.

Enum Constant Summary

Enum Constants

Enum Constant and Description
POLAR The orbital motion of the object is orthogonal to the direction of rotation of its primary body.
PROGRADE The orbital motion of the object is in the same direction as the rotation of its primary body.
RETROGRADE The orbital motion of the object is in the opposite direction as the rotation of its primary body.

Method Summary

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

PROGRADE

public static final OrbitDirectionType PROGRADE

The orbital motion of the object is in the same direction as the rotation of its primary body.

POLAR

public static final OrbitDirectionType POLAR

The orbital motion of the object is orthogonal to the direction of rotation of its primary body.

RETROGRADE

public static final OrbitDirectionType RETROGRADE

The orbital motion of the object is in the opposite direction as the rotation of its primary body.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.