org.orekit.models.earth

Class GeoMagneticFieldFactory

java.lang.Object

org.orekit.models.earth.GeoMagneticFieldFactory

public class GeoMagneticFieldFactory
extends Object

Factory for different GeoMagneticField models.

This is a utility class, so its constructor is private.

Author:

Thomas Neidhart

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeoMagneticFieldFactory.FieldModel The currently supported geomagnetic field models.

Method Summary

Modifier and Type	Method and Description
static GeoMagneticField	getField(GeoMagneticFieldFactory.FieldModel type, double year) Get the GeoMagneticField for the given model type and year.
static GeoMagneticField	getIGRF(double year) Get the IGRF model for the given year.
static GeoMagneticField	getWMM(double year) Get the WMM model for the given year.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getField

public static GeoMagneticField getField(GeoMagneticFieldFactory.FieldModel type,
                                        double year)
                                 throws OrekitException

Get the GeoMagneticField for the given model type and year.

Parameters:

type - the field model type

year - the decimal year

Returns:

a GeoMagneticField for the given year and model

Throws:

OrekitException - if the models could not be loaded

See Also:

GeoMagneticField.getDecimalYear(int, int, int)

getIGRF

public static GeoMagneticField getIGRF(double year)
                                throws OrekitException

Get the IGRF model for the given year.

Parameters:

year - the decimal year

Returns:

a GeoMagneticField for the given year

Throws:

OrekitException - if the IGRF models could not be loaded

See Also:

GeoMagneticField.getDecimalYear(int, int, int)

getWMM

public static GeoMagneticField getWMM(double year)
                               throws OrekitException

Get the WMM model for the given year.

Parameters:

year - the decimal year

Returns:

a GeoMagneticField for the given year

Throws:

OrekitException - if the WMM models could not be loaded

See Also:

GeoMagneticField.getDecimalYear(int, int, int)