agi.foundation.propagators

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

Enum SimpleAscentPropagatorBurnoutVelocityFrame

java.lang.Object

java.lang.Enum<SimpleAscentPropagatorBurnoutVelocityFrame>

agi.foundation.propagators.SimpleAscentPropagatorBurnoutVelocityFrame

All Implemented Interfaces:

Enumeration, Serializable, Comparable<SimpleAscentPropagatorBurnoutVelocityFrame>

public enum SimpleAscentPropagatorBurnoutVelocityFrame
extends Enum<SimpleAscentPropagatorBurnoutVelocityFrame>
implements Enumeration

Sets the CentralBody-relative frame used to specify the burnout velocity in SimpleAscentPropagator.

The appropriate burnout velocity properties will need to be set.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIXED_FRAME Use the CentralBody's fixed frame for specifying the burnout velocity vector.
INERTIAL_FRAME Use the CentralBody's inertial frame for specifying the burnout velocity vector.

Method Summary

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

FIXED_FRAME

public static final SimpleAscentPropagatorBurnoutVelocityFrame FIXED_FRAME

Use the CentralBody's fixed frame for specifying the burnout velocity vector.

INERTIAL_FRAME

public static final SimpleAscentPropagatorBurnoutVelocityFrame INERTIAL_FRAME

Use the CentralBody's inertial frame for specifying the burnout velocity vector.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.