RtcmCorrectionHeader.java

  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.messages.rtcm.correction;

  19. import org.orekit.gnss.metric.messages.common.SsrUpdateInterval;

  21. /**
  22.  * Container for common data in RTCM Correction Message type header.
  23.  * @author Bryan Cazabonne
  24.  * @since 12.0
  25.  */
  26. public class RtcmCorrectionHeader {

  28.     /** SSR Epoch Time 1s. */
  29.     private double epochTime1s;

  31.     /** SSR Update Interval. */
  32.     private SsrUpdateInterval ssrUpdateInterval;

  34.     /** Multiple Message Indicator. */
  35.     private int multipleMessageIndicator;

  37.     /** IOD SSR. */
  38.     private int iodSsr;

  40.     /** SSR Provider ID. */
  41.     private int ssrProviderId;

  43.     /** SSR Solution ID. */
  44.     private int ssrSolutionId;

  46.     /** Number of satellites. */
  47.     private int numberOfSatellites;

  49.     /** Constructor. */
  50.     public RtcmCorrectionHeader() {
  51.         // Nothing to do ...
  52.     }

  54.     /**
  55.      * Get the Epoch Time 1s.
  56.      * <p>
  57.      * Full seconds since the beginning of the GNSS week for
  58.      * or full seconds since the beginning of GLONASS day
  59.      * </p>
  60.      * @return the Epoch Time 1s in seconds
  61.      */
  62.     public double getEpochTime1s() {
  63.         return epochTime1s;
  64.     }

  66.     /**
  67.      * Set the Epoch Time 1s.
  68.      * @param epochTime1s the Epoch Time 1s to set
  69.      */
  70.     public void setEpochTime1s(final double epochTime1s) {
  71.         this.epochTime1s = epochTime1s;
  72.     }

  74.     /**
  75.      * Get the SSR Update Interval.
  76.      * @return the SSR Update Interval
  77.      */
  78.     public SsrUpdateInterval getSsrUpdateInterval() {
  79.         return ssrUpdateInterval;
  80.     }

  82.     /**
  83.      * Set the SSR Update Interval.
  84.      * @param ssrUpdateInterval the SSR Update Interval to set
  85.      */
  86.     public void setSsrUpdateInterval(final SsrUpdateInterval ssrUpdateInterval) {
  87.         this.ssrUpdateInterval = ssrUpdateInterval;
  88.     }

  90.     /**
  91.      * Get the Multiple Message Indicator.
  92.      * <p>
  93.      * 0 - Last message of a sequence. 1 - Multiple message transmitted
  94.      * </p>
  95.      * @return the SSR Multiple Message Indicator
  96.      */
  97.     public int getMultipleMessageIndicator() {
  98.         return multipleMessageIndicator;
  99.     }

  101.     /**
  102.      * Set the Multiple Message Indicator.
  103.      * @param multipleMessageIndicator the Multiple Message Indicator to set
  104.      */
  105.     public void setMultipleMessageIndicator(final int multipleMessageIndicator) {
  106.         this.multipleMessageIndicator = multipleMessageIndicator;
  107.     }

  109.     /**
  110.      * Get the IOD SSR.
  111.      * <p>
  112.      * A change of Issue of Data SSR is used to
  113.      * indicate a change in the SSR generating configuration.
  114.      * </p>
  115.      * @return the IOD SSR
  116.      */
  117.     public int getIodSsr() {
  118.         return iodSsr;
  119.     }

  121.     /**
  122.      * Set the IOD SSR.
  123.      * @param iodSsr the IOF SSR to set
  124.      */
  125.     public void setIodSsr(final int iodSsr) {
  126.         this.iodSsr = iodSsr;
  127.     }

  129.     /**
  130.      * Get the SSR Provider ID.
  131.      * @return the SSR Provider ID
  132.      */
  133.     public int getSsrProviderId() {
  134.         return ssrProviderId;
  135.     }

  137.     /**
  138.      * Set the SSR Provider ID.
  139.      * @param ssrProviderId the SSR Provider ID to set
  140.      */
  141.     public void setSsrProviderId(final int ssrProviderId) {
  142.         this.ssrProviderId = ssrProviderId;
  143.     }

  145.     /**
  146.      * Get the SSR Solution ID.
  147.      * @return the SSR Solution ID
  148.      */
  149.     public int getSsrSolutionId() {
  150.         return ssrSolutionId;
  151.     }

  153.     /**
  154.      * Set the SSR Solution ID.
  155.      * @param ssrSolutionId the SSR Solution ID to set
  156.      */
  157.     public void setSsrSolutionId(final int ssrSolutionId) {
  158.         this.ssrSolutionId = ssrSolutionId;
  159.     }

  161.     /**
  162.      * Get the number of satellites for the current IGM message.
  163.      * @return the number of satellites for the current IGM message
  164.      */
  165.     public int getNumberOfSatellites() {
  166.         return numberOfSatellites;
  167.     }

  169.     /**
  170.      * Set the number of satellites for the current IGM message.
  171.      * @param numberOfSatellites the number of satellites to set
  172.      */
  173.     public void setNumberOfSatellites(final int numberOfSatellites) {
  174.         this.numberOfSatellites = numberOfSatellites;
  175.     }

  177. }
Created with JaCoCo 0.8.12.202403310830