1   /* Copyright 2002-2025 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  package org.orekit.gnss.metric.parser;
18  
19  import org.orekit.errors.OrekitInternalError;
20  
21  /**
22   * Interface for data fields used to parsed encoded messages.
23   * @author Bryan Cazabonne
24   * @since 11.0
25   */
26  public interface DataField {
27  
28      /** Get the value of the field as a boolean.
29       * @param message message containing the data
30       * @return boolean value of the field
31       */
32      default boolean booleanValue(EncodedMessage message) {
33          // this method should be overwritten
34          throw new OrekitInternalError(null);
35      }
36  
37      /** Get the value of the field as an integer.
38       * @param message message containing the data
39       * @return integer value of the field
40       */
41      default int intValue(EncodedMessage message) {
42          // this method should be overwritten
43          throw new OrekitInternalError(null);
44      }
45  
46      /** Get the value of the field as a double.
47       * @param message message containing the data
48       * @return double value of the field
49       */
50      default double doubleValue(EncodedMessage message) {
51          // this method should be overwritten
52          throw new OrekitInternalError(null);
53      }
54  
55      /** Get the value of the field as a String.
56       * @param message message containing the data
57       * @param n number of UTF8 characters
58       * @return String value of the field
59       */
60      default String stringValue(EncodedMessage message, int n) {
61          // this method should be overwritten
62          throw new OrekitInternalError(null);
63      }
64  
65  }