agi.foundation.propagators

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

Enum BallisticPropagatorSolutionType

java.lang.Object

java.lang.Enum<BallisticPropagatorSolutionType>

agi.foundation.propagators.BallisticPropagatorSolutionType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<BallisticPropagatorSolutionType>

public enum BallisticPropagatorSolutionType
extends Enum<BallisticPropagatorSolutionType>
implements Enumeration

Species the kind of solution that was calculated by a BallisticPropagator, IE whether the desired trajectory was successfully calculated, the propagator failed to converge on a solution, or the specified constraint was invalid.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONVERGENCE_FAILED The propagator was not able to converge on the specified constraint.
EXCESSIVE_DELTA_V The specified delta-V too high for a valid trajectory.
INSUFFICIENT_DELTA_V The specified delta-V insufficient for a valid trajectory.
INSUFFICIENT_FLIGHT_DURATION The specified time of flight was insufficient for a valid trajectory.
SUCCESSFUL_CALCULATION The propagator successfully calculated the trajectory.

Method Summary

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

SUCCESSFUL_CALCULATION

public static final BallisticPropagatorSolutionType SUCCESSFUL_CALCULATION

The propagator successfully calculated the trajectory. The relevant property still has the constraint value, and the others have been populated with their values for the calculated trajectory.

CONVERGENCE_FAILED

public static final BallisticPropagatorSolutionType CONVERGENCE_FAILED

The propagator was not able to converge on the specified constraint. All properties, including the constraint value, have been set to the value of the guess the propagator converged on.

INSUFFICIENT_DELTA_V

public static final BallisticPropagatorSolutionType INSUFFICIENT_DELTA_V

The specified delta-V insufficient for a valid trajectory. A minimum energy/delta-V solution was calculated instead.

EXCESSIVE_DELTA_V

public static final BallisticPropagatorSolutionType EXCESSIVE_DELTA_V

The specified delta-V too high for a valid trajectory. A minimum eccentricity solution was calculated instead.

INSUFFICIENT_FLIGHT_DURATION

public static final BallisticPropagatorSolutionType INSUFFICIENT_FLIGHT_DURATION

The specified time of flight was insufficient for a valid trajectory. The minimum eccentricity solution was calculated instead.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.