1   /* Copyright 2002-2024 Thales Alenia Space
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.troposphere;
18  
19  import org.hipparchus.CalculusFieldElement;
20  import org.orekit.bodies.FieldGeodeticPoint;
21  import org.orekit.bodies.GeodeticPoint;
22  import org.orekit.models.earth.weather.FieldPressureTemperatureHumidity;
23  import org.orekit.models.earth.weather.PressureTemperatureHumidity;
24  import org.orekit.time.AbsoluteDate;
25  import org.orekit.time.FieldAbsoluteDate;
26  import org.orekit.utils.FieldTrackingCoordinates;
27  import org.orekit.utils.ParameterDriversProvider;
28  import org.orekit.utils.TrackingCoordinates;
29  
30  /** Defines a tropospheric model, used to calculate the path delay imposed to
31   * electro-magnetic signals between an orbital satellite and a ground station.
32   * @author Luc Maisonobe
33   * @since 12.1
34   */
35  public interface TroposphericModel extends ParameterDriversProvider {
36  
37      /** Calculates the tropospheric path delay for the signal path from a ground
38       * station to a satellite.
39       *
40       * @param trackingCoordinates tracking coordinates of the satellite
41       * @param point station location
42       * @param weather weather parameters
43       * for constant default values)
44       * @param parameters tropospheric model parameters
45       * @param date current date
46       * @return the path delay due to the troposphere
47       */
48      TroposphericDelay pathDelay(TrackingCoordinates trackingCoordinates, GeodeticPoint point,
49                                  PressureTemperatureHumidity weather,
50                                  double[] parameters, AbsoluteDate date);
51  
52      /** Calculates the tropospheric path delay for the signal path from a ground
53       * station to a satellite.
54       *
55       * @param <T> type of the elements
56       * @param trackingCoordinates tracking coordinates of the satellite
57       * @param point station location
58       * @param weather weather parameters
59       * for constant default values)
60       * @param parameters tropospheric model parameters at current date
61       * @param date current date
62       * @return the path delay due to the troposphere
63       */
64      <T extends CalculusFieldElement<T>> FieldTroposphericDelay<T> pathDelay(FieldTrackingCoordinates<T> trackingCoordinates,
65                                                                              FieldGeodeticPoint<T> point,
66                                                                              FieldPressureTemperatureHumidity<T> weather,
67                                                                              T[] parameters, FieldAbsoluteDate<T> date);
68  }