org.orekit.models.earth

Enum GeoMagneticFieldFactory.FieldModel

java.lang.Object

java.lang.Enum<GeoMagneticFieldFactory.FieldModel>

org.orekit.models.earth.GeoMagneticFieldFactory.FieldModel

All Implemented Interfaces:

Serializable, Comparable<GeoMagneticFieldFactory.FieldModel>

Enclosing class:

GeoMagneticFieldFactory

public static enum GeoMagneticFieldFactory.FieldModel
extends Enum<GeoMagneticFieldFactory.FieldModel>

The currently supported geomagnetic field models.

Enum Constant Summary

Enum Constants

Enum Constant and Description
IGRF International Geomagnetic Reference Field.
WMM World Magnetic Model.

Method Summary

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

WMM

public static final GeoMagneticFieldFactory.FieldModel WMM

World Magnetic Model.

IGRF

public static final GeoMagneticFieldFactory.FieldModel IGRF

International Geomagnetic Reference Field.

Method Detail

values

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

Returns:

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

valueOf

public static GeoMagneticFieldFactory.FieldModel 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