1   /* Copyright 2022-2025 Luc Maisonobe
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.estimation.measurements.gnss;
18  
19  import org.hipparchus.analysis.differentiation.Gradient;
20  import org.orekit.estimation.measurements.CommonParametersWithDerivatives;
21  import org.orekit.propagation.SpacecraftState;
22  import org.orekit.utils.TimeStampedFieldPVCoordinates;
23  
24  import java.util.Map;
25  
26  /** Common intermediate parameters used to estimate measurements where receiver is a satellite.
27   * @author Luc Maisonobe
28   * @since 12.1
29   */
30  public class OnBoardCommonParametersWithDerivatives
31      extends CommonParametersWithDerivatives {
32  
33      /** Local clock offset. */
34      private final Gradient localOffset;
35  
36      /** Local clock rate. */
37      private final Gradient localRate;
38  
39      /** Remote clock offset. */
40      private final Gradient remoteOffset;
41  
42      /** Remote clock rate. */
43      private final Gradient remoteRate;
44  
45      /** Remote satellite position/velocity. */
46      private final TimeStampedFieldPVCoordinates<Gradient> remotePV;
47  
48      /** Simple constructor.
49       * @param localState local spacecraft state
50       * @param indices derivatives indices map
51       * @param localOffset local clock offset
52       * @param localRate local clock rate
53       * @param remoteOffset remote clock offset
54       * @param remoteRate remote clock rate
55       * @param tauD downlink delay
56       * @param localPV local satellite position/velocity
57       * @param remotePV remote satellite position/velocity
58       */
59      public OnBoardCommonParametersWithDerivatives(final SpacecraftState localState,
60                                                    final Map<String, Integer> indices,
61                                                    final Gradient localOffset, final Gradient localRate,
62                                                    final Gradient remoteOffset, final Gradient remoteRate,
63                                                    final Gradient tauD,
64                                                    final TimeStampedFieldPVCoordinates<Gradient> localPV,
65                                                    final TimeStampedFieldPVCoordinates<Gradient> remotePV) {
66          super(localState, indices, tauD, localState, localPV);
67          this.localOffset  = localOffset;
68          this.localRate    = localRate;
69          this.remoteOffset = remoteOffset;
70          this.remoteRate   = remoteRate;
71          this.remotePV     = remotePV;
72      }
73  
74      /** Get local clock offset.
75       * @return local clock offset
76       */
77      public Gradient getLocalOffset() {
78          return localOffset;
79      }
80  
81      /** Get local clock rate.
82       * @return local clock rate
83       */
84      public Gradient getLocalRate() {
85          return localRate;
86      }
87  
88      /** Get remote clock offset.
89       * @return remote clock offset
90       */
91      public Gradient getRemoteOffset() {
92          return remoteOffset;
93      }
94  
95      /** Get remote clock rate.
96       * @return remote clock rate
97       */
98      public Gradient getRemoteRate() {
99          return remoteRate;
100     }
101 
102     /** Get remote satellite position/velocity.
103      * @return remote satellite position/velocity
104      */
105     public TimeStampedFieldPVCoordinates<Gradient> getRemotePV() {
106         return remotePV;
107     }
108 
109 }