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.time;
18  
19  import org.hipparchus.CalculusFieldElement;
20  
21  /** Time scale with clock offset from another time scale.
22   * @author Luc Maisonobe
23   * @since 12.1
24   */
25  public class ClockTimeScale implements TimeScale {
26  
27      /** Serializable UID. */
28      private static final long serialVersionUID = 20240321L;
29  
30      /** Name of the time scale. */
31      private final String name;
32  
33      /** Reference time scale. */
34      private final TimeScale reference;
35  
36      /** Clock offset model. */
37      private final transient ClockModel clockModel;
38  
39      /** Simple constructor.
40       * @param name name of the time scale
41       * @param reference reference time scale
42       * @param clockModel clock offset model
43       */
44      public ClockTimeScale(final String name,
45                            final TimeScale reference,
46                            final ClockModel clockModel) {
47          this.name       = name;
48          this.reference  = reference;
49          this.clockModel = clockModel;
50      }
51  
52      /** {@inheritDoc} */
53      @Override
54      public double offsetFromTAI(final AbsoluteDate date) {
55          return reference.offsetFromTAI(date) + clockModel.getOffset(date).getOffset();
56      }
57  
58      /** {@inheritDoc} */
59      @Override
60      public <T extends CalculusFieldElement<T>> T offsetFromTAI(final FieldAbsoluteDate<T> date) {
61          return reference.offsetFromTAI(date).add(clockModel.getOffset(date).getOffset());
62      }
63  
64      /** {@inheritDoc} */
65      @Override
66      public String getName() {
67          return name;
68      }
69  
70  }