org.orekit.utils

Enum LagrangianPoints

java.lang.Object

java.lang.Enum<LagrangianPoints>

org.orekit.utils.LagrangianPoints

All Implemented Interfaces:

Serializable, Comparable<LagrangianPoints>

public enum LagrangianPoints
extends Enum<LagrangianPoints>

Enumerate for selecting which Lagrangian Point to consider in different classes.

Since:

10.2

Author:

Vincent Mouraux

Enum Constant Summary

Enum Constants

Enum Constant and Description
L1 Lagrangian Point L1.
L2 Lagrangian Point L2.
L3 Lagrangian Point L3.
L4 Lagrangian Point L4.
L5 Lagrangian Point L5.

Method Summary

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

L1

public static final LagrangianPoints L1

Lagrangian Point L1.

L2

public static final LagrangianPoints L2

Lagrangian Point L2.

L3

public static final LagrangianPoints L3

Lagrangian Point L3.

L4

public static final LagrangianPoints L4

Lagrangian Point L4.

L5

public static final LagrangianPoints L5

Lagrangian Point L5.

Method Detail

values

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

Returns:

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

valueOf

public static LagrangianPoints 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