1   /* Copyright 2002-2024 CS GROUP
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  
18  package org.orekit.files.sinex;
19  
20  import org.orekit.gnss.TimeSystem;
21  
22  /**
23   * Class to store the DCB description parameters.
24   * <p>
25   * This class gives important parameters from the analysis and defines the fields in the block ’BIAS/SOLUTION’
26   * of the loaded Sinex file.
27   * </p>
28   * @author Louis Aucouturier
29   * @since 12.0
30   */
31  public class DcbDescription {
32  
33      /** Determination mode used to generate the bias results. */
34      private String determinationMethod;
35  
36      /** Describes how the included GNSS bias values have to be interpreted and applied. */
37      private String biasMode;
38  
39      /** Time system. */
40      private TimeSystem timeSystem;
41  
42      /** Observation sampling interval used for data analysis (s). */
43      private int observationSampling;
44  
45      /** Parameter spacing interval between the bias value (s). */
46      private int parameterSpacing;
47  
48      /** Simple constructor. */
49      public DcbDescription() {
50          this.determinationMethod = "";
51          this.observationSampling = -1;
52          this.parameterSpacing    = -1;
53      }
54  
55      /**
56       * Get the determination mode used to generate the bias results.
57       * <p>
58       * This value is optional. If the value is not present in the file, the method returns an empty string.
59       * </p>
60       * @return the determination mode used to generate the bias results.
61       */
62      public final String getDeterminationMethod() {
63          return determinationMethod;
64      }
65  
66      /**
67       * Get the bias mode
68       * <p>
69       * The bias mode describes how the included GNSS bias values have to be interpreted and applied.
70       * </p>
71       * @return the bias mode
72       */
73      public final String getBiasMode() {
74          return biasMode;
75      }
76  
77      /**
78       * Get the time system for DCB data.
79       *
80       * @return the time system
81       */
82      public final TimeSystem getTimeSystem() {
83          return timeSystem;
84      }
85  
86      /**
87       * Get the observation sampling interval used for data analysis.
88       * <p>
89       * This value is optional. If the value is not present in the file, the method returns -1.
90       * </p>
91       * @return the observation sampling interval used for data analysis in seconds
92       */
93      public final int getObservationSampling() {
94          return observationSampling;
95      }
96  
97      /**
98       * Get the parameter spacing interval between the bias value.
99       * <p>
100      * This value is optional. If the value is not present in the file, the method returns -1.
101      * </p>
102      * @return the pParameter spacing interval between the bias value in seconds
103      */
104     public final int getParameterSpacing() {
105         return parameterSpacing;
106     }
107 
108     /**
109      * Set the determination mode used to generate the bias results.
110      *
111      * @param determinationMethod the determination method to set
112      */
113     public void setDeterminationMethod(final String determinationMethod) {
114         this.determinationMethod = determinationMethod;
115     }
116 
117     /**
118      * Set the bias mode.
119      *
120      * @param biasMode the bias mode to set
121      */
122     public void setBiasMode(final String biasMode) {
123         this.biasMode = biasMode;
124     }
125 
126     /**
127      * Set the time system used for DCB data.
128      *
129      * @param timeSystem the time system to set
130      */
131     public void setTimeSystem(final TimeSystem timeSystem) {
132         this.timeSystem = timeSystem;
133     }
134 
135     /**
136      * Set the observation sampling interval used for data analysis.
137      *
138      * @param observationSampling the observation sampling to set in seconds
139      */
140     public void setObservationSampling(final int observationSampling) {
141         this.observationSampling = observationSampling;
142     }
143 
144     /**
145      * Set the parameter spacing interval between the bias value.
146      *
147      * @param parameterSpacing the parameter spacing to set in seconds
148      */
149     public void setParameterSpacing(final int parameterSpacing) {
150         this.parameterSpacing = parameterSpacing;
151     }
152 
153 }