Package org.orekit.models.earth

Class LazyLoadedGeoMagneticFields

java.lang.Object

org.orekit.models.earth.LazyLoadedGeoMagneticFields

All Implemented Interfaces:

GeoMagneticFields

public class LazyLoadedGeoMagneticFields
extends Object
implements GeoMagneticFields

Loads magnetic fields on request and can be configured after creation. Designed to match the behavior of GeoMagneticFieldFactory in Orekit 10.0

Since:

10.1

Author:

Evan Ward, Thomas Neidhart

Constructor Summary

Constructors

Constructor	Description
LazyLoadedGeoMagneticFields(DataProvidersManager dataProvidersManager)	Create a factory for magnetic fields that uses the given data manager to load magnetic field files.

Method Summary

Modifier and Type	Method	Description
GeoMagneticField	getField(GeoMagneticFieldFactory.FieldModel type, double year)	Get the GeoMagneticField for the given model type and year.
GeoMagneticField	getIGRF(double year)	Get the IGRF model for the given year.
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

Constructor Detail

LazyLoadedGeoMagneticFields

public LazyLoadedGeoMagneticFields(DataProvidersManager dataProvidersManager)

Create a factory for magnetic fields that uses the given data manager to load magnetic field files.

Parameters:

dataProvidersManager - provides access to auxiliary data files.

Method Detail

getField

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

Description copied from interface: GeoMagneticFields

Get the GeoMagneticField for the given model type and year.

Specified by:

getField in interface GeoMagneticFields

Parameters:

type - the field model type

year - the decimal year

Returns:

a GeoMagneticField for the given year and model

See Also:

GeoMagneticField.getDecimalYear(int, int, int)

getIGRF

public GeoMagneticField getIGRF(double year)

Description copied from interface: GeoMagneticFields

Get the IGRF model for the given year.

Specified by:

getIGRF in interface GeoMagneticFields

Parameters:

year - the decimal year

Returns:

a GeoMagneticField for the given year

See Also:

GeoMagneticField.getDecimalYear(int, int, int)

getWMM

public GeoMagneticField getWMM(double year)

Description copied from interface: GeoMagneticFields

Get the WMM model for the given year.

Specified by:

getWMM in interface GeoMagneticFields

Parameters:

year - the decimal year

Returns:

a GeoMagneticField for the given year

See Also:

GeoMagneticField.getDecimalYear(int, int, int)