1   /* Contributed in the public domain.
2    * Licensed to CS GROUP (CS) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * CS licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *   http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.orekit.models.earth;
18  
19  import org.orekit.models.earth.GeoMagneticFieldFactory.FieldModel;
20  
21  /**
22   * Methods for obtaining geomagnetic fields.
23   *
24   * @author Evan Ward
25   * @author Thomas Neidhart
26   * @see GeoMagneticFieldFactory
27   * @see LazyLoadedGeoMagneticFields
28   * @since 10.1
29   */
30  public interface GeoMagneticFields {
31  
32      /**
33       * Get the {@link GeoMagneticField} for the given model type and year.
34       *
35       * @param type the field model type
36       * @param year the decimal year
37       * @return a {@link GeoMagneticField} for the given year and model
38       * @see GeoMagneticField#getDecimalYear(int, int, int)
39       */
40      GeoMagneticField getField(FieldModel type, double year);
41  
42      /**
43       * Get the IGRF model for the given year.
44       *
45       * @param year the decimal year
46       * @return a {@link GeoMagneticField} for the given year
47       * @see GeoMagneticField#getDecimalYear(int, int, int)
48       */
49      GeoMagneticField getIGRF(double year);
50  
51      /**
52       * Get the WMM model for the given year.
53       *
54       * @param year the decimal year
55       * @return a {@link GeoMagneticField} for the given year
56       * @see GeoMagneticField#getDecimalYear(int, int, int)
57       */
58      GeoMagneticField getWMM(double year);
59  
60  }