org.orekit.frames

Enum LocalMagneticFieldFrame.LOFBuilderVector

java.lang.Object

java.lang.Enum<LocalMagneticFieldFrame.LOFBuilderVector>

org.orekit.frames.LocalMagneticFieldFrame.LOFBuilderVector

All Implemented Interfaces:

Serializable, Comparable<LocalMagneticFieldFrame.LOFBuilderVector>

Enclosing class:

LocalMagneticFieldFrame

public static enum LocalMagneticFieldFrame.LOFBuilderVector
extends Enum<LocalMagneticFieldFrame.LOFBuilderVector>

Enum defining how the +j axis of the local orbital frame will be defined.

For example, if MINUS_MOMENTUM is chosen, +j aligned as the cross product of the momentum vector and the magnetic field vector. The resulting body frame will be +x aligned with magnetic field, +z aligned with negative momentum, +y orthonormal.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MINUS_MOMENTUM Negative orbital momentum vector.
MINUS_POSITION Negative position vector.
MINUS_VELOCITY Negative velocity vector.
PLUS_MOMENTUM Positive orbital momentum vector.
PLUS_POSITION Positive position vector.
PLUS_VELOCITY Positive velocity vector.

Method Summary

Modifier and Type	Method and Description
static LocalMagneticFieldFrame.LOFBuilderVector	valueOf(String name) Returns the enum constant of this type with the specified name.
static LocalMagneticFieldFrame.LOFBuilderVector[]	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

PLUS_POSITION

public static final LocalMagneticFieldFrame.LOFBuilderVector PLUS_POSITION

Positive position vector.

PLUS_VELOCITY

public static final LocalMagneticFieldFrame.LOFBuilderVector PLUS_VELOCITY

Positive velocity vector.

PLUS_MOMENTUM

public static final LocalMagneticFieldFrame.LOFBuilderVector PLUS_MOMENTUM

Positive orbital momentum vector.

MINUS_POSITION

public static final LocalMagneticFieldFrame.LOFBuilderVector MINUS_POSITION

Negative position vector.

MINUS_VELOCITY

public static final LocalMagneticFieldFrame.LOFBuilderVector MINUS_VELOCITY

Negative velocity vector.

MINUS_MOMENTUM

public static final LocalMagneticFieldFrame.LOFBuilderVector MINUS_MOMENTUM

Negative orbital momentum vector.

Method Detail

values

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

Returns:

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

valueOf

public static LocalMagneticFieldFrame.LOFBuilderVector 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