agi.foundation.propagators

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

Enum LifetimeCalculationStatus

java.lang.Object

java.lang.Enum<LifetimeCalculationStatus>

agi.foundation.propagators.LifetimeCalculationStatus

All Implemented Interfaces:

Enumeration, Serializable, Comparable<LifetimeCalculationStatus>

public enum LifetimeCalculationStatus
extends Enum<LifetimeCalculationStatus>
implements Enumeration

An indication of the final state of the LifetimeOrbitPropagator calculation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CALCULATION_COMPLETE Indicates that the calculation completed normally and the orbit decayed without any errors.
CANCELLED Indicates that the calculation was cancelled before it could determine the decay date.
EARLY_DECAY Indicates that the orbit was already decayed before the calculation could begin.
NO_DECAY Indicates that the orbit does not decay.
NO_DECAY_DURATION Indicates that the calculation encountered the DurationLimit (get / set) before the orbit could decay.
NO_DECAY_ORBIT Indicates that the calculation encountered the OrbitCountLimit (get / set) before the orbit could decay.

Method Summary

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

CALCULATION_COMPLETE

public static final LifetimeCalculationStatus CALCULATION_COMPLETE

Indicates that the calculation completed normally and the orbit decayed without any errors.

EARLY_DECAY

public static final LifetimeCalculationStatus EARLY_DECAY

Indicates that the orbit was already decayed before the calculation could begin. When seeing this result, verify that the initial conditions are using the correct units and that the minimum altitude and duration constraints are set correctly.

NO_DECAY

public static final LifetimeCalculationStatus NO_DECAY

Indicates that the orbit does not decay.

CANCELLED

public static final LifetimeCalculationStatus CANCELLED

Indicates that the calculation was cancelled before it could determine the decay date.

NO_DECAY_ORBIT

public static final LifetimeCalculationStatus NO_DECAY_ORBIT

Indicates that the calculation encountered the OrbitCountLimit (get / set) before the orbit could decay.

NO_DECAY_DURATION

public static final LifetimeCalculationStatus NO_DECAY_DURATION

Indicates that the calculation encountered the DurationLimit (get / set) before the orbit could decay.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.