EncodedMessage.java

  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. package org.orekit.gnss.metric.parser;

  18. /** Interface for getting bits forming encoded messages.
  19.  * <p>
  20.  * Classes implementing this interface must contain exactly one complete message.
  21.  * </p>
  22.  * @author Luc Maisonobe
  23.  * @since 11.0
  24.  */
  25. public interface EncodedMessage {

  26.     /** Start message extraction.
  27.      */
  28.     default void start() {
  29.         // nothing by default
  30.     }

  31.     /** Extract the next n bits from the encoded message.
  32.      * @param n number of bits to extract (cannot exceed 32 bits)
  33.      * @return bits packed as the LSB of a 64 bits primitive long
  34.      */
  35.     long extractBits(int n);

  36. }