IgsSsrMessageType.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.parser;

  19. import java.util.ArrayList;
  20. import java.util.HashMap;
  21. import java.util.List;
  22. import java.util.Map;
  23. import java.util.regex.Matcher;
  24. import java.util.regex.Pattern;

  26. import org.orekit.errors.OrekitException;
  27. import org.orekit.errors.OrekitMessages;
  28. import org.orekit.gnss.SatelliteSystem;
  29. import org.orekit.gnss.metric.messages.ParsedMessage;
  30. import org.orekit.gnss.metric.messages.common.ClockCorrection;
  31. import org.orekit.gnss.metric.messages.common.CodeBias;
  32. import org.orekit.gnss.metric.messages.common.OrbitCorrection;
  33. import org.orekit.gnss.metric.messages.common.PhaseBias;
  34. import org.orekit.gnss.metric.messages.ssr.igm.SsrIgm01;
  35. import org.orekit.gnss.metric.messages.ssr.igm.SsrIgm01Data;
  36. import org.orekit.gnss.metric.messages.ssr.igm.SsrIgm01Header;
  37. import org.orekit.gnss.metric.messages.ssr.igm.SsrIgm02;
  38. import org.orekit.gnss.metric.messages.ssr.igm.SsrIgm02Data;
  39. import org.orekit.gnss.metric.messages.ssr.igm.SsrIgm02Header;
  40. import org.orekit.gnss.metric.messages.ssr.igm.SsrIgm03;
  41. import org.orekit.gnss.metric.messages.ssr.igm.SsrIgm03Data;
  42. import org.orekit.gnss.metric.messages.ssr.igm.SsrIgm03Header;
  43. import org.orekit.gnss.metric.messages.ssr.igm.SsrIgm04;
  44. import org.orekit.gnss.metric.messages.ssr.igm.SsrIgm04Data;
  45. import org.orekit.gnss.metric.messages.ssr.igm.SsrIgm04Header;
  46. import org.orekit.gnss.metric.messages.ssr.igm.SsrIgm05;
  47. import org.orekit.gnss.metric.messages.ssr.igm.SsrIgm05Data;
  48. import org.orekit.gnss.metric.messages.ssr.igm.SsrIgm05Header;
  49. import org.orekit.gnss.metric.messages.ssr.igm.SsrIgm06;
  50. import org.orekit.gnss.metric.messages.ssr.igm.SsrIgm06Data;
  51. import org.orekit.gnss.metric.messages.ssr.igm.SsrIgm06Header;
  52. import org.orekit.gnss.metric.messages.ssr.igm.SsrIgm07;
  53. import org.orekit.gnss.metric.messages.ssr.igm.SsrIgm07Data;
  54. import org.orekit.gnss.metric.messages.ssr.igm.SsrIgm07Header;
  55. import org.orekit.gnss.metric.messages.ssr.subtype.SsrIm201;
  56. import org.orekit.gnss.metric.messages.ssr.subtype.SsrIm201Data;
  57. import org.orekit.gnss.metric.messages.ssr.subtype.SsrIm201Header;
  58. import org.orekit.time.TimeScales;

  60. /** Enum containing the supported IGS SSR messages types.
  61.  *
  62.  * @author Luc Maisonobe
  63.  * @author Bryan Cazabonne
  64.  *
  65.  * @see "IGS State Space Representation (SSR) Format, Version 1.00, October 2020."
  66.  *
  67.  * @since 11.0
  68.  */
  69. public enum IgsSsrMessageType implements MessageType {

  71.     /** SSR Orbit Correction. */
  72.     IGM_01("21|41|61|81|101|121") {

  74.         /** {@inheritDoc} */
  75.         @Override
  76.         public ParsedMessage parse(final EncodedMessage encodedMessage,
  77.                                    final int messageNumber,
  78.                                    final TimeScales timeScales) {

  80.             // Satellite system
  81.             final SatelliteSystem system = messageNumberToSatelliteSystem(messageNumber);

  83.             // Header data
  84.             final SsrIgm01Header igm01Header = new SsrIgm01Header();
  85.             igm01Header.setSsrEpoch1s(IgsSsrDataField.IDF003.intValue(encodedMessage));
  86.             igm01Header.setSsrUpdateInterval(IgsSsrDataField.IDF004.intValue(encodedMessage));
  87.             igm01Header.setSsrMultipleMessageIndicator(IgsSsrDataField.IDF005.intValue(encodedMessage));
  88.             igm01Header.setIodSsr(IgsSsrDataField.IDF007.intValue(encodedMessage));
  89.             igm01Header.setSsrProviderId(IgsSsrDataField.IDF008.intValue(encodedMessage));
  90.             igm01Header.setSsrSolutionId(IgsSsrDataField.IDF009.intValue(encodedMessage));
  91.             igm01Header.setCrsIndicator(IgsSsrDataField.IDF006.intValue(encodedMessage));

  93.             // Number of satellites
  94.             final int satNumber = IgsSsrDataField.IDF010.intValue(encodedMessage);
  95.             igm01Header.setNumberOfSatellites(satNumber);

  97.             // Initialize list of data
  98.             final List<SsrIgm01Data> igm01Data = new ArrayList<>();

  100.             // Loop on satellites and fill data
  101.             for (int index = 0; index < satNumber; index++) {

  103.                 // Satellite ID
  104.                 final int igm01SatId = getSatelliteId(system, IgsSsrDataField.IDF011.intValue(encodedMessage));

  106.                 // GNSS IOD
  107.                 final int igm01Iod = IgsSsrDataField.IDF012.intValue(encodedMessage);

  109.                 // Orbit correction
  110.                 final OrbitCorrection igm01OrbitCorr =
  111.                                 new OrbitCorrection(IgsSsrDataField.IDF013.doubleValue(encodedMessage),   // IGM01 dRadial
  112.                                                     IgsSsrDataField.IDF014.doubleValue(encodedMessage),   // IGM01 dAlongTrack
  113.                                                     IgsSsrDataField.IDF015.doubleValue(encodedMessage),   // IGM01 dCrossTrack
  114.                                                     IgsSsrDataField.IDF016.doubleValue(encodedMessage),   // IGM01 dRadialDot
  115.                                                     IgsSsrDataField.IDF017.doubleValue(encodedMessage),   // IGM01 dAlongTrackDot
  116.                                                     IgsSsrDataField.IDF018.doubleValue(encodedMessage));  // IGM01 dCrossTrackDot

  118.                 // Initialize a new container and fill data
  119.                 final SsrIgm01Data currentIgm01Data = new SsrIgm01Data();
  120.                 currentIgm01Data.setSatelliteID(igm01SatId);
  121.                 currentIgm01Data.setGnssIod(igm01Iod);
  122.                 currentIgm01Data.setOrbitCorrection(igm01OrbitCorr);

  124.                 // Update the list
  125.                 igm01Data.add(currentIgm01Data);

  127.             }

  129.             // Return the parsed message
  130.             return new SsrIgm01(messageNumber, system, igm01Header, igm01Data);

  132.         }

  134.     },

  136.     /** SSR Clock Correction. */
  137.     IGM_02("22|42|62|82|102|122") {

  139.         /** {@inheritDoc} */
  140.         @Override
  141.         public ParsedMessage parse(final EncodedMessage encodedMessage, final int messageNumber,
  142.                                    final TimeScales timeScales) {

  144.             // Satellite system
  145.             final SatelliteSystem system = messageNumberToSatelliteSystem(messageNumber);

  147.             // Header data
  148.             final SsrIgm02Header igm02Header = new SsrIgm02Header();
  149.             igm02Header.setSsrEpoch1s(IgsSsrDataField.IDF003.intValue(encodedMessage));
  150.             igm02Header.setSsrUpdateInterval(IgsSsrDataField.IDF004.intValue(encodedMessage));
  151.             igm02Header.setSsrMultipleMessageIndicator(IgsSsrDataField.IDF005.intValue(encodedMessage));
  152.             igm02Header.setIodSsr(IgsSsrDataField.IDF007.intValue(encodedMessage));
  153.             igm02Header.setSsrProviderId(IgsSsrDataField.IDF008.intValue(encodedMessage));
  154.             igm02Header.setSsrSolutionId(IgsSsrDataField.IDF009.intValue(encodedMessage));

  156.             // Number of satellites
  157.             final int satNumber = IgsSsrDataField.IDF010.intValue(encodedMessage);
  158.             igm02Header.setNumberOfSatellites(satNumber);

  160.             // Initialize list of data
  161.             final List<SsrIgm02Data> igm02Data = new ArrayList<>();

  163.             // Loop on satellites and fill data
  164.             for (int index = 0; index < satNumber; index++) {

  166.                 // Satellite ID
  167.                 final int igm02SatId = getSatelliteId(system, IgsSsrDataField.IDF011.intValue(encodedMessage));

  169.                 // Clock correction
  170.                 final ClockCorrection igm02ClockCorr =
  171.                                 new ClockCorrection(IgsSsrDataField.IDF019.doubleValue(encodedMessage),  // IGM02 C0
  172.                                                     IgsSsrDataField.IDF020.doubleValue(encodedMessage),  // IGM02 C1
  173.                                                     IgsSsrDataField.IDF021.doubleValue(encodedMessage)); // IGM02 C2

  175.                 // Initialize a new container and fill data
  176.                 final SsrIgm02Data currentIgm02Data = new SsrIgm02Data();
  177.                 currentIgm02Data.setSatelliteID(igm02SatId);
  178.                 currentIgm02Data.setClockCorrection(igm02ClockCorr);

  180.                 // Update the list
  181.                 igm02Data.add(currentIgm02Data);

  183.             }

  185.             // Return the parsed message
  186.             return new SsrIgm02(messageNumber, system, igm02Header, igm02Data);

  188.         }

  190.     },

  192.     /** SSR Combined Orbit and Clock Correction. */
  193.     IGM_03("23|43|63|83|103|123") {

  195.         /** {@inheritDoc} */
  196.         @Override
  197.         public ParsedMessage parse(final EncodedMessage encodedMessage, final int messageNumber,
  198.                                    final TimeScales timeScales) {

  200.             // Satellite system
  201.             final SatelliteSystem system = messageNumberToSatelliteSystem(messageNumber);

  203.             // Header data
  204.             final SsrIgm03Header igm03Header = new SsrIgm03Header();
  205.             igm03Header.setSsrEpoch1s(IgsSsrDataField.IDF003.intValue(encodedMessage));
  206.             igm03Header.setSsrUpdateInterval(IgsSsrDataField.IDF004.intValue(encodedMessage));
  207.             igm03Header.setSsrMultipleMessageIndicator(IgsSsrDataField.IDF005.intValue(encodedMessage));
  208.             igm03Header.setIodSsr(IgsSsrDataField.IDF007.intValue(encodedMessage));
  209.             igm03Header.setSsrProviderId(IgsSsrDataField.IDF008.intValue(encodedMessage));
  210.             igm03Header.setSsrSolutionId(IgsSsrDataField.IDF009.intValue(encodedMessage));
  211.             igm03Header.setCrsIndicator(IgsSsrDataField.IDF006.intValue(encodedMessage));

  213.             // Number of satellites
  214.             final int satNumber = IgsSsrDataField.IDF010.intValue(encodedMessage);
  215.             igm03Header.setNumberOfSatellites(satNumber);

  217.             // Initialize list of data
  218.             final List<SsrIgm03Data> igm03Data = new ArrayList<>();

  220.             // Loop on satellites and fill data
  221.             for (int index = 0; index < satNumber; index++) {

  223.                 // Satellite ID
  224.                 final int igm03SatId = getSatelliteId(system, IgsSsrDataField.IDF011.intValue(encodedMessage));

  226.                 // GNSS IOD
  227.                 final int igm03Iod = IgsSsrDataField.IDF012.intValue(encodedMessage);

  229.                 // Orbit correction
  230.                 final OrbitCorrection igm03OrbitCorr =
  231.                                 new OrbitCorrection(IgsSsrDataField.IDF013.doubleValue(encodedMessage),   // IGM03 dRadial
  232.                                                     IgsSsrDataField.IDF014.doubleValue(encodedMessage),   // IGM03 dAlongTrack
  233.                                                     IgsSsrDataField.IDF015.doubleValue(encodedMessage),   // IGM03 dCrossTrack
  234.                                                     IgsSsrDataField.IDF016.doubleValue(encodedMessage),   // IGM03 dRadialDot
  235.                                                     IgsSsrDataField.IDF017.doubleValue(encodedMessage),   // IGM03 dAlongTrackDot
  236.                                                     IgsSsrDataField.IDF018.doubleValue(encodedMessage));  // IGM03 dCrossTrackDot

  238.                 // Clock correction
  239.                 final ClockCorrection igm03ClockCorr =
  240.                                 new ClockCorrection(IgsSsrDataField.IDF019.doubleValue(encodedMessage),  // IGM03 C0
  241.                                                     IgsSsrDataField.IDF020.doubleValue(encodedMessage),  // IGM03 C1
  242.                                                     IgsSsrDataField.IDF021.doubleValue(encodedMessage)); // IGM03 C2

  244.                 // Initialize a new container and fill data
  245.                 final SsrIgm03Data currentIgm03Data = new SsrIgm03Data();
  246.                 currentIgm03Data.setSatelliteID(igm03SatId);
  247.                 currentIgm03Data.setGnssIod(igm03Iod);
  248.                 currentIgm03Data.setOrbitCorrection(igm03OrbitCorr);
  249.                 currentIgm03Data.setClockCorrection(igm03ClockCorr);

  251.                 // Update the list
  252.                 igm03Data.add(currentIgm03Data);

  254.             }

  256.             // Return the parsed message
  257.             return new SsrIgm03(messageNumber, system, igm03Header, igm03Data);

  259.         }

  261.     },

  263.     /** SSR High Rate Clock Correction. */
  264.     IGM_04("24|44|64|84|104|124") {

  266.         /** {@inheritDoc} */
  267.         @Override
  268.         public ParsedMessage parse(final EncodedMessage encodedMessage, final int messageNumber,
  269.                                    final TimeScales timeScales) {

  271.             // Satellite system
  272.             final SatelliteSystem system = messageNumberToSatelliteSystem(messageNumber);

  274.             // Header data
  275.             final SsrIgm04Header igm04Header = new SsrIgm04Header();
  276.             igm04Header.setSsrEpoch1s(IgsSsrDataField.IDF003.intValue(encodedMessage));
  277.             igm04Header.setSsrUpdateInterval(IgsSsrDataField.IDF004.intValue(encodedMessage));
  278.             igm04Header.setSsrMultipleMessageIndicator(IgsSsrDataField.IDF005.intValue(encodedMessage));
  279.             igm04Header.setIodSsr(IgsSsrDataField.IDF007.intValue(encodedMessage));
  280.             igm04Header.setSsrProviderId(IgsSsrDataField.IDF008.intValue(encodedMessage));
  281.             igm04Header.setSsrSolutionId(IgsSsrDataField.IDF009.intValue(encodedMessage));

  283.             // Number of satellites
  284.             final int satNumber = IgsSsrDataField.IDF010.intValue(encodedMessage);
  285.             igm04Header.setNumberOfSatellites(satNumber);

  287.             // Initialize list of data
  288.             final List<SsrIgm04Data> igm04Data = new ArrayList<>();

  290.             // Loop on satellites and fill data
  291.             for (int index = 0; index < satNumber; index++) {

  293.                 // Initialize a new container
  294.                 final SsrIgm04Data currentIgm04Data = new SsrIgm04Data();
  295.                 currentIgm04Data.setSatelliteID(getSatelliteId(system, IgsSsrDataField.IDF011.intValue(encodedMessage)));
  296.                 currentIgm04Data.setHighRateClockCorrection(IgsSsrDataField.IDF022.doubleValue(encodedMessage));

  298.                 // Update the list
  299.                 igm04Data.add(currentIgm04Data);

  301.             }

  303.             // Return the parsed message
  304.             return new SsrIgm04(messageNumber, system, igm04Header, igm04Data);

  306.         }

  308.     },

  310.     /** SSR Code Bias. */
  311.     IGM_05("25|45|65|85|105|125") {

  313.         /** {@inheritDoc} */
  314.         @Override
  315.         public ParsedMessage parse(final EncodedMessage encodedMessage, final int messageNumber,
  316.                                    final TimeScales timeScales) {

  318.             // Satellite system
  319.             final SatelliteSystem system = messageNumberToSatelliteSystem(messageNumber);

  321.             // Header data
  322.             final SsrIgm05Header igm05Header = new SsrIgm05Header();
  323.             igm05Header.setSsrEpoch1s(IgsSsrDataField.IDF003.intValue(encodedMessage));
  324.             igm05Header.setSsrUpdateInterval(IgsSsrDataField.IDF004.intValue(encodedMessage));
  325.             igm05Header.setSsrMultipleMessageIndicator(IgsSsrDataField.IDF005.intValue(encodedMessage));
  326.             igm05Header.setIodSsr(IgsSsrDataField.IDF007.intValue(encodedMessage));
  327.             igm05Header.setSsrProviderId(IgsSsrDataField.IDF008.intValue(encodedMessage));
  328.             igm05Header.setSsrSolutionId(IgsSsrDataField.IDF009.intValue(encodedMessage));

  330.             // Number of satellites
  331.             final int satNumber = IgsSsrDataField.IDF010.intValue(encodedMessage);
  332.             igm05Header.setNumberOfSatellites(satNumber);

  334.             // Initialize list of data
  335.             final List<SsrIgm05Data> igm05Data = new ArrayList<>();

  337.             // Loop on satellites
  338.             for (int index = 0; index < satNumber; index++) {

  340.                 // Initialize a new container
  341.                 final SsrIgm05Data currentIgm05Data = new SsrIgm05Data();
  342.                 currentIgm05Data.setSatelliteID(getSatelliteId(system, IgsSsrDataField.IDF011.intValue(encodedMessage)));

  344.                 // Number of biases
  345.                 final int biasesNumber = IgsSsrDataField.IDF023.intValue(encodedMessage);
  346.                 currentIgm05Data.setNumberOfBiasesProcessed(biasesNumber);

  348.                 // Loop on biases
  349.                 for (int biasIndex = 0; biasIndex < biasesNumber; biasIndex++) {
  350.                     // Initialize a new code bias
  351.                     final CodeBias codeBias = new CodeBias(IgsSsrDataField.IDF024.intValue(encodedMessage),
  352.                                                            IgsSsrDataField.IDF025.doubleValue(encodedMessage));
  353.                     // Add the codeBias to the container
  354.                     currentIgm05Data.addCodeBias(codeBias);
  355.                 }

  357.                 // Update the list of data
  358.                 igm05Data.add(currentIgm05Data);

  360.             }

  362.             // Return the parsed message
  363.             return new SsrIgm05(messageNumber, system, igm05Header, igm05Data);

  365.         }

  367.     },

  369.     /** SSR Phase Bias. */
  370.     IGM_06("26|46|66|86|106|126") {

  372.         /** {@inheritDoc} */
  373.         @Override
  374.         public ParsedMessage parse(final EncodedMessage encodedMessage, final int messageNumber,
  375.                                    final TimeScales timeScales) {

  377.             // Satellite system
  378.             final SatelliteSystem system = messageNumberToSatelliteSystem(messageNumber);

  380.             // Header data
  381.             final SsrIgm06Header igm06Header = new SsrIgm06Header();
  382.             igm06Header.setSsrEpoch1s(IgsSsrDataField.IDF003.intValue(encodedMessage));
  383.             igm06Header.setSsrUpdateInterval(IgsSsrDataField.IDF004.intValue(encodedMessage));
  384.             igm06Header.setSsrMultipleMessageIndicator(IgsSsrDataField.IDF005.intValue(encodedMessage));
  385.             igm06Header.setIodSsr(IgsSsrDataField.IDF007.intValue(encodedMessage));
  386.             igm06Header.setSsrProviderId(IgsSsrDataField.IDF008.intValue(encodedMessage));
  387.             igm06Header.setSsrSolutionId(IgsSsrDataField.IDF009.intValue(encodedMessage));
  388.             igm06Header.setIsConsistencyMaintained(IgsSsrDataField.IDF032.booleanValue(encodedMessage));
  389.             igm06Header.setIsMelbourneWubbenaConsistencyMaintained(IgsSsrDataField.IDF033.booleanValue(encodedMessage));

  391.             // Number of satellites
  392.             final int satNumber = IgsSsrDataField.IDF010.intValue(encodedMessage);
  393.             igm06Header.setNumberOfSatellites(satNumber);

  395.             // Initialize list of data
  396.             final List<SsrIgm06Data> igm06Data = new ArrayList<>();

  398.             // Loop on satellites
  399.             for (int index = 0; index < satNumber; index++) {

  401.                 // Initialize a new container
  402.                 final SsrIgm06Data currentIgm06Data = new SsrIgm06Data();
  403.                 currentIgm06Data.setSatelliteID(getSatelliteId(system, IgsSsrDataField.IDF011.intValue(encodedMessage)));

  405.                 // Number of biases
  406.                 final int biasesNumber = IgsSsrDataField.IDF023.intValue(encodedMessage);
  407.                 currentIgm06Data.setNumberOfBiasesProcessed(biasesNumber);

  409.                 // Yaw angle and rate
  410.                 currentIgm06Data.setYawAngle(IgsSsrDataField.IDF026.doubleValue(encodedMessage));
  411.                 currentIgm06Data.setYawRate(IgsSsrDataField.IDF027.doubleValue(encodedMessage));

  413.                 // Loop on biases
  414.                 for (int biasIndex = 0; biasIndex < biasesNumber; biasIndex++) {
  415.                     // Initialize a new phase bias
  416.                     final PhaseBias phaseBias = new PhaseBias(IgsSsrDataField.IDF024.intValue(encodedMessage),
  417.                                                               IgsSsrDataField.IDF029.booleanValue(encodedMessage),
  418.                                                               IgsSsrDataField.IDF030.intValue(encodedMessage),
  419.                                                               IgsSsrDataField.IDF031.intValue(encodedMessage),
  420.                                                               IgsSsrDataField.IDF028.doubleValue(encodedMessage));
  421.                     // Add the codeBias to the container
  422.                     currentIgm06Data.addPhaseBias(phaseBias);
  423.                 }

  425.                 // Update the list of data
  426.                 igm06Data.add(currentIgm06Data);

  428.             }

  430.             // Return the parsed message
  431.             return new SsrIgm06(messageNumber, system, igm06Header, igm06Data);

  433.         }

  435.     },

  437.     /** SSR URA. */
  438.     IGM_07("27|47|67|87|107|127") {

  440.         /** {@inheritDoc} */
  441.         @Override
  442.         public ParsedMessage parse(final EncodedMessage encodedMessage, final int messageNumber,
  443.                                    final TimeScales timeScales) {

  445.             // Satellite system
  446.             final SatelliteSystem system = messageNumberToSatelliteSystem(messageNumber);

  448.             // Header data
  449.             final SsrIgm07Header igm07Header = new SsrIgm07Header();
  450.             igm07Header.setSsrEpoch1s(IgsSsrDataField.IDF003.intValue(encodedMessage));
  451.             igm07Header.setSsrUpdateInterval(IgsSsrDataField.IDF004.intValue(encodedMessage));
  452.             igm07Header.setSsrMultipleMessageIndicator(IgsSsrDataField.IDF005.intValue(encodedMessage));
  453.             igm07Header.setIodSsr(IgsSsrDataField.IDF007.intValue(encodedMessage));
  454.             igm07Header.setSsrProviderId(IgsSsrDataField.IDF008.intValue(encodedMessage));
  455.             igm07Header.setSsrSolutionId(IgsSsrDataField.IDF009.intValue(encodedMessage));

  457.             // Number of satellites
  458.             final int satNumber = IgsSsrDataField.IDF010.intValue(encodedMessage);
  459.             igm07Header.setNumberOfSatellites(satNumber);

  461.             // Initialize list of data
  462.             final List<SsrIgm07Data> igm07Data = new ArrayList<>();

  464.             // Loop on satellites and fill data
  465.             for (int index = 0; index < satNumber; index++) {

  467.                 // Initialize a new container
  468.                 final SsrIgm07Data currentIgm07Data = new SsrIgm07Data();
  469.                 currentIgm07Data.setSatelliteID(getSatelliteId(system, IgsSsrDataField.IDF011.intValue(encodedMessage)));
  470.                 currentIgm07Data.setSsrUra(IgsSsrDataField.IDF034.intValue(encodedMessage));

  472.                 // Update the list
  473.                 igm07Data.add(currentIgm07Data);

  475.             }

  477.             // Return the parsed message
  478.             return new SsrIgm07(messageNumber, system, igm07Header, igm07Data);

  480.         }

  482.     },

  484.     /** SSR Ionosphere VTEC Spherical Harmonics Message. */
  485.     IM_201("201") {

  487.         /** {@inheritDoc} */
  488.         @Override
  489.         public ParsedMessage parse(final EncodedMessage encodedMessage, final int messageNumber,
  490.                                    final TimeScales timeScales) {

  492.             // Header data
  493.             final SsrIm201Header im201Header = new SsrIm201Header();
  494.             im201Header.setSsrEpoch1s(IgsSsrDataField.IDF003.intValue(encodedMessage));
  495.             im201Header.setSsrUpdateInterval(IgsSsrDataField.IDF004.intValue(encodedMessage));
  496.             im201Header.setSsrMultipleMessageIndicator(IgsSsrDataField.IDF005.intValue(encodedMessage));
  497.             im201Header.setIodSsr(IgsSsrDataField.IDF007.intValue(encodedMessage));
  498.             im201Header.setSsrProviderId(IgsSsrDataField.IDF008.intValue(encodedMessage));
  499.             im201Header.setSsrSolutionId(IgsSsrDataField.IDF009.intValue(encodedMessage));
  500.             im201Header.setVtecQualityIndicator(IgsSsrDataField.IDF041.doubleValue(encodedMessage));

  502.             // Number of ionospheric layers
  503.             final int numberOfIonosphericLayers = IgsSsrDataField.IDF035.intValue(encodedMessage);
  504.             im201Header.setNumberOfIonosphericLayers(numberOfIonosphericLayers);

  506.             // Initialize list of data
  507.             final List<SsrIm201Data> im201Data = new ArrayList<>();

  509.             // Loop on ionospheric layers
  510.             for (int layerIndex = 0; layerIndex < numberOfIonosphericLayers; layerIndex++) {

  512.                 // Initialize a new container
  513.                 final SsrIm201Data currentIm201Data = new SsrIm201Data();

  515.                 // Height of the ionospheric layer
  516.                 currentIm201Data.setHeightIonosphericLayer(IgsSsrDataField.IDF036.doubleValue(encodedMessage));

  518.                 // Degree and order of spherical harmonics
  519.                 final int n = IgsSsrDataField.IDF037.intValue(encodedMessage);
  520.                 final int m = IgsSsrDataField.IDF038.intValue(encodedMessage);

  522.                 // Initialize arrays
  523.                 final double[][] cnm = new double[n + 1][m + 1];
  524.                 final double[][] snm = new double[n + 1][m + 1];

  526.                 ////
  527.                 // Cosine coefficients
  528.                 ////

  530.                 // Loop on degree
  531.                 for (int order = 0; order <= m; order++) {
  532.                     // Loop on order
  533.                     for (int degree = order; degree <= n; degree++) {
  534.                         cnm[degree][order] = IgsSsrDataField.IDF039.doubleValue(encodedMessage);
  535.                     }
  536.                 }

  538.                 ////
  539.                 // Sine coefficients
  540.                 ////

  542.                 // Loop on degree
  543.                 for (int order = 1; order <= m; order++) {
  544.                     // Loop on order
  545.                     for (int degree = order; degree <= n; degree++) {
  546.                         snm[degree][order] = IgsSsrDataField.IDF040.doubleValue(encodedMessage);
  547.                     }
  548.                 }

  550.                 currentIm201Data.setSphericalHarmonicsDegree(n);
  551.                 currentIm201Data.setSphericalHarmonicsOrder(m);
  552.                 currentIm201Data.setCnm(cnm);
  553.                 currentIm201Data.setSnm(snm);

  555.                 // Update the list
  556.                 im201Data.add(currentIm201Data);

  558.             }

  560.             // Return the parsed message
  561.             return new SsrIm201(messageNumber, im201Header, im201Data);

  563.         }

  565.     };

  567.     /** Codes map. */
  568.     private static final Map<Pattern, IgsSsrMessageType> CODES_MAP = new HashMap<>();
  569.     static {
  570.         for (final IgsSsrMessageType type : values()) {
  571.             CODES_MAP.put(type.getPattern(), type);
  572.         }
  573.     }

  575.     /** Message pattern (i.e. allowed message numbers). */
  576.     private final Pattern pattern;

  578.     /** Simple constructor.
  579.      * @param regex message regular expression
  580.      */
  581.     IgsSsrMessageType(final String regex) {
  582.         this.pattern = Pattern.compile(regex);
  583.     }

  585.     /** Get the message number.
  586.      * @return message number
  587.      */
  588.     public Pattern getPattern() {
  589.         return pattern;
  590.     }

  592.     /** Get the message type corresponding to a message number.
  593.      * @param number message number
  594.      * @return the message type corresponding to the message number
  595.      */
  596.     public static IgsSsrMessageType getMessageType(final String number) {
  597.         // Try to find a match with an existing message type
  598.         for (Map.Entry<Pattern, IgsSsrMessageType> entry : CODES_MAP.entrySet()) {
  599.             // Matcher
  600.             final Matcher matcher = entry.getKey().matcher(number);
  601.             // Check the match !
  602.             if (matcher.matches()) {
  603.                 // return the message type
  604.                 return entry.getValue();
  605.             }
  606.         }
  607.         // No match found
  608.         throw new OrekitException(OrekitMessages.UNKNOWN_ENCODED_MESSAGE_NUMBER, number);
  609.     }

  611.     /**
  612.      * Find the satellite system corresponding to the sub-type message number.
  613.      * <p>
  614.      * See Table 5 of reference
  615.      * </p>
  616.      * @param subTypeMessage message umber
  617.      * @return the corresponding satellite system
  618.      */
  619.     public static SatelliteSystem messageNumberToSatelliteSystem(final int subTypeMessage) {

  621.         if (subTypeMessage > 20 && subTypeMessage <= 40) {
  622.             // GPS messages
  623.             return SatelliteSystem.GPS;
  624.         } else if (subTypeMessage <= 60) {
  625.             // GLONASS messages
  626.             return SatelliteSystem.GLONASS;
  627.         } else if (subTypeMessage <= 80) {
  628.             // Galileo messages
  629.             return SatelliteSystem.GALILEO;
  630.         } else if (subTypeMessage <= 100) {
  631.             // QZSS messages
  632.             return SatelliteSystem.QZSS;
  633.         } else if (subTypeMessage <= 120) {
  634.             // Beidou messages
  635.             return SatelliteSystem.BEIDOU;
  636.         } else if (subTypeMessage <= 140) {
  637.             // SBAS messages
  638.             return SatelliteSystem.SBAS;
  639.         } else {
  640.             // NavIC messages
  641.             return SatelliteSystem.NAVIC;
  642.         }

  644.     }

  646.     /**
  647.      * Transform the satellite ID parsed from the IGS SSR message to the real ID.
  648.      * @param system the satellite system of the parsed message
  649.      * @param id the parsed satellite ID
  650.      * @return the real satellite ID
  651.      */
  652.     public static int getSatelliteId(final SatelliteSystem system, final int id) {

  654.         // Switch on satellite systems
  655.         switch (system) {
  656.             case QZSS:
  657.                 // ID = ID(parsed) + 192
  658.                 return id + 192;
  659.             case SBAS:
  660.                 // ID = ID(parsed) + 119
  661.                 return id + 119;
  662.             default:
  663.                 // For GPS, GLONASS, Beidou, and Galileo the id is unchanged
  664.                 return id;
  665.         }

  667.     }

  669. }
Created with JaCoCo 0.8.12.202403310830