Package org.orekit.orbits.cr3bp

Enum Class LibrationOrbitFamily

java.lang.Object

java.lang.Enum<LibrationOrbitFamily>

org.orekit.orbits.cr3bp.LibrationOrbitFamily

All Implemented Interfaces:

Serializable, Comparable<LibrationOrbitFamily>, Constable

public enum LibrationOrbitFamily
extends Enum<LibrationOrbitFamily>

Enumerate for Libration Orbit family.

The Northern and Southern families of Libration orbits are related to through symmetry.

Since:

10.2

Author:

Vincent Mouraux

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NORTHERN	Northern.
SOUTHERN	Southern.

Method Summary

Modifier and Type	Method	Description
static LibrationOrbitFamily	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LibrationOrbitFamily[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NORTHERN

public static final LibrationOrbitFamily NORTHERN

Northern.

SOUTHERN

public static final LibrationOrbitFamily SOUTHERN

Southern.

Method Details

values

public static LibrationOrbitFamily[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static LibrationOrbitFamily valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null