IgsSsrMessageType.java

  1. /* Copyright 2002-2023 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;

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

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

  73.         /** {@inheritDoc} */
  74.         @Override
  75.         public ParsedMessage parse(final EncodedMessage encodedMessage, final int messageNumber) {

  77.             // Satellite system
  78.             final SatelliteSystem system = messageNumberToSatelliteSystem(messageNumber);

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

  90.             // Number of satellites
  91.             final int satNumber = IgsSsrDataField.IDF010.intValue(encodedMessage);
  92.             igm01Header.setNumberOfSatellites(satNumber);

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

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

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

  103.                 // GNSS IOD
  104.                 final int igm01Iod = IgsSsrDataField.IDF012.intValue(encodedMessage);

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

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

  121.                 // Update the list
  122.                 igm01Data.add(currentIgm01Data);

  124.             }

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

  129.         }

  131.     },

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

  136.         /** {@inheritDoc} */
  137.         @Override
  138.         public ParsedMessage parse(final EncodedMessage encodedMessage, final int messageNumber) {

  140.             // Satellite system
  141.             final SatelliteSystem system = messageNumberToSatelliteSystem(messageNumber);

  143.             // Header data
  144.             final SsrIgm02Header igm02Header = new SsrIgm02Header();
  145.             igm02Header.setSsrEpoch1s(IgsSsrDataField.IDF003.intValue(encodedMessage));
  146.             igm02Header.setSsrUpdateInterval(IgsSsrDataField.IDF004.intValue(encodedMessage));
  147.             igm02Header.setSsrMultipleMessageIndicator(IgsSsrDataField.IDF005.intValue(encodedMessage));
  148.             igm02Header.setIodSsr(IgsSsrDataField.IDF007.intValue(encodedMessage));
  149.             igm02Header.setSsrProviderId(IgsSsrDataField.IDF008.intValue(encodedMessage));
  150.             igm02Header.setSsrSolutionId(IgsSsrDataField.IDF009.intValue(encodedMessage));

  152.             // Number of satellites
  153.             final int satNumber = IgsSsrDataField.IDF010.intValue(encodedMessage);
  154.             igm02Header.setNumberOfSatellites(satNumber);

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

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

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

  165.                 // Clock correction
  166.                 final ClockCorrection igm02ClockCorr =
  167.                                 new ClockCorrection(IgsSsrDataField.IDF019.doubleValue(encodedMessage),  // IGM02 C0
  168.                                                     IgsSsrDataField.IDF020.doubleValue(encodedMessage),  // IGM02 C1
  169.                                                     IgsSsrDataField.IDF021.doubleValue(encodedMessage)); // IGM02 C2

  171.                 // Initialize a new container and fill data
  172.                 final SsrIgm02Data currentIgm02Data = new SsrIgm02Data();
  173.                 currentIgm02Data.setSatelliteID(igm02SatId);
  174.                 currentIgm02Data.setClockCorrection(igm02ClockCorr);

  176.                 // Update the list
  177.                 igm02Data.add(currentIgm02Data);

  179.             }

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

  184.         }

  186.     },

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

  191.         /** {@inheritDoc} */
  192.         @Override
  193.         public ParsedMessage parse(final EncodedMessage encodedMessage, final int messageNumber) {

  195.             // Satellite system
  196.             final SatelliteSystem system = messageNumberToSatelliteSystem(messageNumber);

  198.             // Header data
  199.             final SsrIgm03Header igm03Header = new SsrIgm03Header();
  200.             igm03Header.setSsrEpoch1s(IgsSsrDataField.IDF003.intValue(encodedMessage));
  201.             igm03Header.setSsrUpdateInterval(IgsSsrDataField.IDF004.intValue(encodedMessage));
  202.             igm03Header.setSsrMultipleMessageIndicator(IgsSsrDataField.IDF005.intValue(encodedMessage));
  203.             igm03Header.setIodSsr(IgsSsrDataField.IDF007.intValue(encodedMessage));
  204.             igm03Header.setSsrProviderId(IgsSsrDataField.IDF008.intValue(encodedMessage));
  205.             igm03Header.setSsrSolutionId(IgsSsrDataField.IDF009.intValue(encodedMessage));
  206.             igm03Header.setCrsIndicator(IgsSsrDataField.IDF006.intValue(encodedMessage));

  208.             // Number of satellites
  209.             final int satNumber = IgsSsrDataField.IDF010.intValue(encodedMessage);
  210.             igm03Header.setNumberOfSatellites(satNumber);

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

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

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

  221.                 // GNSS IOD
  222.                 final int igm03Iod = IgsSsrDataField.IDF012.intValue(encodedMessage);

  224.                 // Orbit correction
  225.                 final OrbitCorrection igm03OrbitCorr =
  226.                                 new OrbitCorrection(IgsSsrDataField.IDF013.doubleValue(encodedMessage),   // IGM03 dRadial
  227.                                                     IgsSsrDataField.IDF014.doubleValue(encodedMessage),   // IGM03 dAlongTrack
  228.                                                     IgsSsrDataField.IDF015.doubleValue(encodedMessage),   // IGM03 dCrossTrack
  229.                                                     IgsSsrDataField.IDF016.doubleValue(encodedMessage),   // IGM03 dRadialDot
  230.                                                     IgsSsrDataField.IDF017.doubleValue(encodedMessage),   // IGM03 dAlongTrackDot
  231.                                                     IgsSsrDataField.IDF018.doubleValue(encodedMessage));  // IGM03 dCrossTrackDot

  233.                 // Clock correction
  234.                 final ClockCorrection igm03ClockCorr =
  235.                                 new ClockCorrection(IgsSsrDataField.IDF019.doubleValue(encodedMessage),  // IGM03 C0
  236.                                                     IgsSsrDataField.IDF020.doubleValue(encodedMessage),  // IGM03 C1
  237.                                                     IgsSsrDataField.IDF021.doubleValue(encodedMessage)); // IGM03 C2

  239.                 // Initialize a new container and fill data
  240.                 final SsrIgm03Data currentIgm03Data = new SsrIgm03Data();
  241.                 currentIgm03Data.setSatelliteID(igm03SatId);
  242.                 currentIgm03Data.setGnssIod(igm03Iod);
  243.                 currentIgm03Data.setOrbitCorrection(igm03OrbitCorr);
  244.                 currentIgm03Data.setClockCorrection(igm03ClockCorr);

  246.                 // Update the list
  247.                 igm03Data.add(currentIgm03Data);

  249.             }

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

  254.         }

  256.     },

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

  261.         /** {@inheritDoc} */
  262.         @Override
  263.         public ParsedMessage parse(final EncodedMessage encodedMessage, final int messageNumber) {

  265.             // Satellite system
  266.             final SatelliteSystem system = messageNumberToSatelliteSystem(messageNumber);

  268.             // Header data
  269.             final SsrIgm04Header igm04Header = new SsrIgm04Header();
  270.             igm04Header.setSsrEpoch1s(IgsSsrDataField.IDF003.intValue(encodedMessage));
  271.             igm04Header.setSsrUpdateInterval(IgsSsrDataField.IDF004.intValue(encodedMessage));
  272.             igm04Header.setSsrMultipleMessageIndicator(IgsSsrDataField.IDF005.intValue(encodedMessage));
  273.             igm04Header.setIodSsr(IgsSsrDataField.IDF007.intValue(encodedMessage));
  274.             igm04Header.setSsrProviderId(IgsSsrDataField.IDF008.intValue(encodedMessage));
  275.             igm04Header.setSsrSolutionId(IgsSsrDataField.IDF009.intValue(encodedMessage));

  277.             // Number of satellites
  278.             final int satNumber = IgsSsrDataField.IDF010.intValue(encodedMessage);
  279.             igm04Header.setNumberOfSatellites(satNumber);

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

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

  287.                 // Initialize a new container
  288.                 final SsrIgm04Data currentIgm04Data = new SsrIgm04Data();
  289.                 currentIgm04Data.setSatelliteID(getSatelliteId(system, IgsSsrDataField.IDF011.intValue(encodedMessage)));
  290.                 currentIgm04Data.setHighRateClockCorrection(IgsSsrDataField.IDF022.doubleValue(encodedMessage));

  292.                 // Update the list
  293.                 igm04Data.add(currentIgm04Data);

  295.             }

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

  300.         }

  302.     },

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

  307.         /** {@inheritDoc} */
  308.         @Override
  309.         public ParsedMessage parse(final EncodedMessage encodedMessage, final int messageNumber) {

  311.             // Satellite system
  312.             final SatelliteSystem system = messageNumberToSatelliteSystem(messageNumber);

  314.             // Header data
  315.             final SsrIgm05Header igm05Header = new SsrIgm05Header();
  316.             igm05Header.setSsrEpoch1s(IgsSsrDataField.IDF003.intValue(encodedMessage));
  317.             igm05Header.setSsrUpdateInterval(IgsSsrDataField.IDF004.intValue(encodedMessage));
  318.             igm05Header.setSsrMultipleMessageIndicator(IgsSsrDataField.IDF005.intValue(encodedMessage));
  319.             igm05Header.setIodSsr(IgsSsrDataField.IDF007.intValue(encodedMessage));
  320.             igm05Header.setSsrProviderId(IgsSsrDataField.IDF008.intValue(encodedMessage));
  321.             igm05Header.setSsrSolutionId(IgsSsrDataField.IDF009.intValue(encodedMessage));

  323.             // Number of satellites
  324.             final int satNumber = IgsSsrDataField.IDF010.intValue(encodedMessage);
  325.             igm05Header.setNumberOfSatellites(satNumber);

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

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

  333.                 // Initialize a new container
  334.                 final SsrIgm05Data currentIgm05Data = new SsrIgm05Data();
  335.                 currentIgm05Data.setSatelliteID(getSatelliteId(system, IgsSsrDataField.IDF011.intValue(encodedMessage)));

  337.                 // Number of biases
  338.                 final int biasesNumber = IgsSsrDataField.IDF023.intValue(encodedMessage);
  339.                 currentIgm05Data.setNumberOfBiasesProcessed(biasesNumber);

  341.                 // Loop on biases
  342.                 for (int biasIndex = 0; biasIndex < biasesNumber; biasIndex++) {
  343.                     // Initialize a new code bias
  344.                     final CodeBias codeBias = new CodeBias(IgsSsrDataField.IDF024.intValue(encodedMessage),
  345.                                                            IgsSsrDataField.IDF025.doubleValue(encodedMessage));
  346.                     // Add the codeBias to the container
  347.                     currentIgm05Data.addCodeBias(codeBias);
  348.                 }

  350.                 // Update the list of data
  351.                 igm05Data.add(currentIgm05Data);

  353.             }

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

  358.         }

  360.     },

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

  365.         /** {@inheritDoc} */
  366.         @Override
  367.         public ParsedMessage parse(final EncodedMessage encodedMessage, final int messageNumber) {

  369.             // Satellite system
  370.             final SatelliteSystem system = messageNumberToSatelliteSystem(messageNumber);

  372.             // Header data
  373.             final SsrIgm06Header igm06Header = new SsrIgm06Header();
  374.             igm06Header.setSsrEpoch1s(IgsSsrDataField.IDF003.intValue(encodedMessage));
  375.             igm06Header.setSsrUpdateInterval(IgsSsrDataField.IDF004.intValue(encodedMessage));
  376.             igm06Header.setSsrMultipleMessageIndicator(IgsSsrDataField.IDF005.intValue(encodedMessage));
  377.             igm06Header.setIodSsr(IgsSsrDataField.IDF007.intValue(encodedMessage));
  378.             igm06Header.setSsrProviderId(IgsSsrDataField.IDF008.intValue(encodedMessage));
  379.             igm06Header.setSsrSolutionId(IgsSsrDataField.IDF009.intValue(encodedMessage));
  380.             igm06Header.setIsConsistencyMaintained(IgsSsrDataField.IDF032.booleanValue(encodedMessage));
  381.             igm06Header.setIsMelbourneWubbenaConsistencyMaintained(IgsSsrDataField.IDF033.booleanValue(encodedMessage));

  383.             // Number of satellites
  384.             final int satNumber = IgsSsrDataField.IDF010.intValue(encodedMessage);
  385.             igm06Header.setNumberOfSatellites(satNumber);

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

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

  393.                 // Initialize a new container
  394.                 final SsrIgm06Data currentIgm06Data = new SsrIgm06Data();
  395.                 currentIgm06Data.setSatelliteID(getSatelliteId(system, IgsSsrDataField.IDF011.intValue(encodedMessage)));

  397.                 // Number of biases
  398.                 final int biasesNumber = IgsSsrDataField.IDF023.intValue(encodedMessage);
  399.                 currentIgm06Data.setNumberOfBiasesProcessed(biasesNumber);

  401.                 // Yaw angle and rate
  402.                 currentIgm06Data.setYawAngle(IgsSsrDataField.IDF026.doubleValue(encodedMessage));
  403.                 currentIgm06Data.setYawRate(IgsSsrDataField.IDF027.doubleValue(encodedMessage));

  405.                 // Loop on biases
  406.                 for (int biasIndex = 0; biasIndex < biasesNumber; biasIndex++) {
  407.                     // Initialize a new phase bias
  408.                     final PhaseBias phaseBias = new PhaseBias(IgsSsrDataField.IDF024.intValue(encodedMessage),
  409.                                                               IgsSsrDataField.IDF029.booleanValue(encodedMessage),
  410.                                                               IgsSsrDataField.IDF030.intValue(encodedMessage),
  411.                                                               IgsSsrDataField.IDF031.intValue(encodedMessage),
  412.                                                               IgsSsrDataField.IDF028.doubleValue(encodedMessage));
  413.                     // Add the codeBias to the container
  414.                     currentIgm06Data.addPhaseBias(phaseBias);
  415.                 }

  417.                 // Update the list of data
  418.                 igm06Data.add(currentIgm06Data);

  420.             }

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

  425.         }

  427.     },

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

  432.         /** {@inheritDoc} */
  433.         @Override
  434.         public ParsedMessage parse(final EncodedMessage encodedMessage, final int messageNumber) {

  436.             // Satellite system
  437.             final SatelliteSystem system = messageNumberToSatelliteSystem(messageNumber);

  439.             // Header data
  440.             final SsrIgm07Header igm07Header = new SsrIgm07Header();
  441.             igm07Header.setSsrEpoch1s(IgsSsrDataField.IDF003.intValue(encodedMessage));
  442.             igm07Header.setSsrUpdateInterval(IgsSsrDataField.IDF004.intValue(encodedMessage));
  443.             igm07Header.setSsrMultipleMessageIndicator(IgsSsrDataField.IDF005.intValue(encodedMessage));
  444.             igm07Header.setIodSsr(IgsSsrDataField.IDF007.intValue(encodedMessage));
  445.             igm07Header.setSsrProviderId(IgsSsrDataField.IDF008.intValue(encodedMessage));
  446.             igm07Header.setSsrSolutionId(IgsSsrDataField.IDF009.intValue(encodedMessage));

  448.             // Number of satellites
  449.             final int satNumber = IgsSsrDataField.IDF010.intValue(encodedMessage);
  450.             igm07Header.setNumberOfSatellites(satNumber);

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

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

  458.                 // Initialize a new container
  459.                 final SsrIgm07Data currentIgm07Data = new SsrIgm07Data();
  460.                 currentIgm07Data.setSatelliteID(getSatelliteId(system, IgsSsrDataField.IDF011.intValue(encodedMessage)));
  461.                 currentIgm07Data.setSsrUra(IgsSsrDataField.IDF034.intValue(encodedMessage));

  463.                 // Update the list
  464.                 igm07Data.add(currentIgm07Data);

  466.             }

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

  471.         }

  473.     },

  475.     /** SSR Ionosphere VTEC Spherical Harmonics Message. */
  476.     IM_201("201") {

  478.         /** {@inheritDoc} */
  479.         @Override
  480.         public ParsedMessage parse(final EncodedMessage encodedMessage, final int messageNumber) {

  482.             // Header data
  483.             final SsrIm201Header im201Header = new SsrIm201Header();
  484.             im201Header.setSsrEpoch1s(IgsSsrDataField.IDF003.intValue(encodedMessage));
  485.             im201Header.setSsrUpdateInterval(IgsSsrDataField.IDF004.intValue(encodedMessage));
  486.             im201Header.setSsrMultipleMessageIndicator(IgsSsrDataField.IDF005.intValue(encodedMessage));
  487.             im201Header.setIodSsr(IgsSsrDataField.IDF007.intValue(encodedMessage));
  488.             im201Header.setSsrProviderId(IgsSsrDataField.IDF008.intValue(encodedMessage));
  489.             im201Header.setSsrSolutionId(IgsSsrDataField.IDF009.intValue(encodedMessage));
  490.             im201Header.setVtecQualityIndicator(IgsSsrDataField.IDF041.doubleValue(encodedMessage));

  492.             // Number of ionospheric layers
  493.             final int numberOfIonosphericLayers = IgsSsrDataField.IDF035.intValue(encodedMessage);
  494.             im201Header.setNumberOfIonosphericLayers(numberOfIonosphericLayers);

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

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

  502.                 // Initialize a new container
  503.                 final SsrIm201Data currentIm201Data = new SsrIm201Data();

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

  508.                 // Degree and order of spherical harmonics
  509.                 final int n = IgsSsrDataField.IDF037.intValue(encodedMessage);
  510.                 final int m = IgsSsrDataField.IDF038.intValue(encodedMessage);

  512.                 // Initialize arrays
  513.                 final double[][] cnm = new double[n + 1][m + 1];
  514.                 final double[][] snm = new double[n + 1][m + 1];

  516.                 ////
  517.                 // Cosine coefficients
  518.                 ////

  520.                 // Loop on degree
  521.                 for (int order = 0; order <= m; order++) {
  522.                     // Loop on order
  523.                     for (int degree = order; degree <= n; degree++) {
  524.                         cnm[degree][order] = IgsSsrDataField.IDF039.doubleValue(encodedMessage);
  525.                     }
  526.                 }

  528.                 ////
  529.                 // Sine coefficients
  530.                 ////

  532.                 // Loop on degree
  533.                 for (int order = 1; order <= m; order++) {
  534.                     // Loop on order
  535.                     for (int degree = order; degree <= n; degree++) {
  536.                         snm[degree][order] = IgsSsrDataField.IDF040.doubleValue(encodedMessage);
  537.                     }
  538.                 }

  540.                 currentIm201Data.setSphericalHarmonicsDegree(n);
  541.                 currentIm201Data.setSphericalHarmonicsOrder(m);
  542.                 currentIm201Data.setCnm(cnm);
  543.                 currentIm201Data.setSnm(snm);

  545.                 // Update the list
  546.                 im201Data.add(currentIm201Data);

  548.             }

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

  553.         }

  555.     };

  557.     /** Codes map. */
  558.     private static final Map<Pattern, IgsSsrMessageType> CODES_MAP = new HashMap<>();
  559.     static {
  560.         for (final IgsSsrMessageType type : values()) {
  561.             CODES_MAP.put(type.getPattern(), type);
  562.         }
  563.     }

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

  568.     /** Simple constructor.
  569.      * @param regex message regular expression
  570.      */
  571.     IgsSsrMessageType(final String regex) {
  572.         this.pattern = Pattern.compile(regex);
  573.     }

  575.     /** Get the message number.
  576.      * @return message number
  577.      */
  578.     public Pattern getPattern() {
  579.         return pattern;
  580.     }

  582.     /** Get the message type corresponding to a message number.
  583.      * @param number message number
  584.      * @return the message type corresponding to the message number
  585.      */
  586.     public static IgsSsrMessageType getMessageType(final String number) {
  587.         // Try to find a match with an existing message type
  588.         for (Map.Entry<Pattern, IgsSsrMessageType> entry : CODES_MAP.entrySet()) {
  589.             // Matcher
  590.             final Matcher matcher = entry.getKey().matcher(number);
  591.             // Check the match !
  592.             if (matcher.matches()) {
  593.                 // return the message type
  594.                 return entry.getValue();
  595.             }
  596.         }
  597.         // No match found
  598.         throw new OrekitException(OrekitMessages.UNKNOWN_ENCODED_MESSAGE_NUMBER, number);
  599.     }

  601.     /**
  602.      * Find the satellite system corresponding to the sub-type message number.
  603.      * <p>
  604.      * See Table 5 of reference
  605.      * </p>
  606.      * @param subTypeMessage message umber
  607.      * @return the corresponding satellite system
  608.      */
  609.     public static SatelliteSystem messageNumberToSatelliteSystem(final int subTypeMessage) {

  611.         if (subTypeMessage > 20 && subTypeMessage <= 40) {
  612.             // GPS messages
  613.             return SatelliteSystem.GPS;
  614.         } else if (subTypeMessage <= 60) {
  615.             // GLONASS messages
  616.             return SatelliteSystem.GLONASS;
  617.         } else if (subTypeMessage <= 80) {
  618.             // Galileo messages
  619.             return SatelliteSystem.GALILEO;
  620.         } else if (subTypeMessage <= 100) {
  621.             // QZSS messages
  622.             return SatelliteSystem.QZSS;
  623.         } else if (subTypeMessage <= 120) {
  624.             // Beidou messages
  625.             return SatelliteSystem.BEIDOU;
  626.         } else if (subTypeMessage <= 140) {
  627.             // SBAS messages
  628.             return SatelliteSystem.SBAS;
  629.         } else {
  630.             // IRNSS messages
  631.             return SatelliteSystem.IRNSS;
  632.         }

  634.     }

  636.     /**
  637.      * Transform the satellite ID parsed from the IGS SSR message to the real ID.
  638.      * @param system the satellite system of the parsed message
  639.      * @param id the parsed satellite ID
  640.      * @return the real satellite ID
  641.      */
  642.     public static int getSatelliteId(final SatelliteSystem system, final int id) {

  644.         // Switch on satellite systems
  645.         switch (system) {
  646.             case QZSS:
  647.                 // ID = ID(parsed) + 192
  648.                 return id + 192;
  649.             case SBAS:
  650.                 // ID = ID(parsed) + 119
  651.                 return id + 119;
  652.             default:
  653.                 // For GPS, GLONASS, Beidou, and Galileo the id is unchanged
  654.                 return id;
  655.         }

  657.     }

  659. }
Created with JaCoCo 0.8.11.202310140853