agi.foundation.propagators

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

Enum LifetimeCalculationLimitType

java.lang.Object

java.lang.Enum<LifetimeCalculationLimitType>

agi.foundation.propagators.LifetimeCalculationLimitType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<LifetimeCalculationLimitType>

public enum LifetimeCalculationLimitType
extends Enum<LifetimeCalculationLimitType>
implements Enumeration

Specifies how the LifetimeOrbitPropagator should behave when determining completion of the computation. This will limit the run time of the orbit lifetime computation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LIMIT_ALL Limit computation to either a maximum elapsed time or a max number of orbits.
LIMIT_DURATION Limit computation to a maximum elapsed time.
LIMIT_ORBIT_COUNT Limit computation to a maximum number of orbits.

Method Summary

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

LIMIT_ORBIT_COUNT

public static final LifetimeCalculationLimitType LIMIT_ORBIT_COUNT

Limit computation to a maximum number of orbits.

LIMIT_DURATION

public static final LifetimeCalculationLimitType LIMIT_DURATION

Limit computation to a maximum elapsed time.

LIMIT_ALL

public static final LifetimeCalculationLimitType LIMIT_ALL

Limit computation to either a maximum elapsed time or a max number of orbits.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.