agi.foundation.segmentpropagation

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

Enum InvalidFuelStateBehavior

java.lang.Object

java.lang.Enum<InvalidFuelStateBehavior>

agi.foundation.segmentpropagation.InvalidFuelStateBehavior

All Implemented Interfaces:

Enumeration, Serializable, Comparable<InvalidFuelStateBehavior>

public enum InvalidFuelStateBehavior
extends Enum<InvalidFuelStateBehavior>
implements Enumeration

An enum that will let a maneuver segment know what to do if an maneuver can not be completed due to lack of fuel.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DO_AS_MUCH_AS_POSSIBLE Do as much of the delta-V as possible given how much fuel is available.
DO_FULL_DELTA_V Do the entire delta-V regardless of how much fuel is available.
STOP_PROPAGATING This will do as much of the maneuver as possible, and stop propagation.
THROW_EXCEPTION Throw an exception if there is not enough fuel to perform the maneuver.

Method Summary

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

DO_FULL_DELTA_V

public static final InvalidFuelStateBehavior DO_FULL_DELTA_V

Do the entire delta-V regardless of how much fuel is available. No warning will be given except for the RanOutOfFuel (get / set) for this segment will be set to true.

DO_AS_MUCH_AS_POSSIBLE

public static final InvalidFuelStateBehavior DO_AS_MUCH_AS_POSSIBLE

Do as much of the delta-V as possible given how much fuel is available. The RanOutOfFuel (get / set) for this segment will be set to true.

THROW_EXCEPTION

public static final InvalidFuelStateBehavior THROW_EXCEPTION

Throw an exception if there is not enough fuel to perform the maneuver.

STOP_PROPAGATING

public static final InvalidFuelStateBehavior STOP_PROPAGATING

This will do as much of the maneuver as possible, and stop propagation. The RanOutOfFuel (get / set) for this segment will be set to true.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.