agi.foundation.propagators

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

Enum LambertPathType

java.lang.Object

java.lang.Enum<LambertPathType>

agi.foundation.propagators.LambertPathType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<LambertPathType>

public enum LambertPathType
extends Enum<LambertPathType>
implements Enumeration

Indicates which type of path to take in the LambertOrbitSolver. This setting is only relevant for transfer orbits with at least one revolution between the initial and final positions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LONG_PATH Selects the long path, where the semi major axis is larger.
SHORT_PATH Selects the short path, where the semi major axis is smaller.

Method Summary

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

SHORT_PATH

public static final LambertPathType SHORT_PATH

Selects the short path, where the semi major axis is smaller.

LONG_PATH

public static final LambertPathType LONG_PATH

Selects the long path, where the semi major axis is larger.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.