Package org.orekit.models.earth
Class GeoMagneticFieldFactory
- java.lang.Object
-
- org.orekit.models.earth.GeoMagneticFieldFactory
-
public class GeoMagneticFieldFactory extends Object
Factory for differentGeoMagneticField
models.This is a utility class, so its constructor is private.
- Author:
- Thomas Neidhart, Evan Ward
- See Also:
GeoMagneticFields
,LazyLoadedGeoMagneticFields
,DataContext.getGeoMagneticFields()
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GeoMagneticFieldFactory.FieldModel
The currently supported geomagnetic field models.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static GeoMagneticField
getField(GeoMagneticFieldFactory.FieldModel type, double year)
Get theGeoMagneticField
for the given model type and year.static LazyLoadedGeoMagneticFields
getGeoMagneticFields()
Get the instance ofGeoMagneticFields
that is called by methods in this class.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.
-
-
-
Method Detail
-
getGeoMagneticFields
@DefaultDataContext public static LazyLoadedGeoMagneticFields getGeoMagneticFields()
Get the instance ofGeoMagneticFields
that is called by methods in this class.- Returns:
- the geomagnetic fields used by this factory.
- Since:
- 10.1
-
getField
@DefaultDataContext public static GeoMagneticField getField(GeoMagneticFieldFactory.FieldModel type, double year)
Get theGeoMagneticField
for the given model type and year.- Parameters:
type
- the field model typeyear
- the decimal year- Returns:
- a
GeoMagneticField
for the given year and model - See Also:
GeoMagneticField.getDecimalYear(int, int, int)
-
getIGRF
@DefaultDataContext public static GeoMagneticField getIGRF(double year)
Get the IGRF model for the given year.- Parameters:
year
- the decimal year- Returns:
- a
GeoMagneticField
for the given year - See Also:
GeoMagneticField.getDecimalYear(int, int, int)
-
getWMM
@DefaultDataContext public static GeoMagneticField getWMM(double year)
Get the WMM model for the given year.- Parameters:
year
- the decimal year- Returns:
- a
GeoMagneticField
for the given year - See Also:
GeoMagneticField.getDecimalYear(int, int, int)
-
-