CivilianNavigationMessage.java

  1. /* Copyright 2022-2025 Luc Maisonobe
  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.propagation.analytical.gnss.data;

  19. import org.hipparchus.CalculusFieldElement;
  20. import org.orekit.gnss.SatelliteSystem;
  21. import org.orekit.time.TimeScales;

  23. /**
  24.  * Container for data contained in a GPS/QZNSS civilian navigation message.
  25.  * @param <O> type of the orbital elements
  26.  * @author Luc Maisonobe
  27.  * @since 12.0
  28.  */
  29. public abstract class CivilianNavigationMessage<O extends CivilianNavigationMessage<O>> extends AbstractNavigationMessage<O> implements GNSSClockElements {

  31.     /** Indicator for CNV 2 messages. */
  32.     private final boolean cnv2;

  34.     /** Change rate in semi-major axis (m/s). */
  35.     private double aDot;

  37.     /** Change rate in Δn₀. */
  38.     private double deltaN0Dot;

  40.     /** The user SV accuracy (m). */
  41.     private double svAccuracy;

  43.     /** Satellite health status. */
  44.     private int svHealth;

  46.     /** Inter Signal Delay for L1 C/A. */
  47.     private double iscL1CA;

  49.     /** Inter Signal Delay for L1 CD. */
  50.     private double iscL1CD;

  52.     /** Inter Signal Delay for L1 CP. */
  53.     private double iscL1CP;

  55.     /** Inter Signal Delay for L2 C. */
  56.     private double iscL2C;

  58.     /** Inter Signal Delay for L5I. */
  59.     private double iscL5I5;

  61.     /** Inter Signal Delay for L5Q. */
  62.     private double iscL5Q5;

  64.     /** Elevation-Dependent User Range Accuracy. */
  65.     private int uraiEd;

  67.     /** Term 0 of Non-Elevation-Dependent User Range Accuracy. */
  68.     private int uraiNed0;

  70.     /** Term 1 of Non-Elevation-Dependent User Range Accuracy. */
  71.     private int uraiNed1;

  73.     /** Term 2 of Non-Elevation-Dependent User Range Accuracy. */
  74.     private int uraiNed2;

  76.     /** Flags.
  77.      * @since 14.0
  78.      */
  79.     private int flags;

  81.     /**
  82.      * Constructor.
  83.      * @param cnv2            indicator for CNV2 messages
  84.      * @param mu              Earth's universal gravitational parameter
  85.      * @param angularVelocity mean angular velocity of the Earth for the GNSS model
  86.      * @param weeksInCycle    number of weeks in the GNSS cycle
  87.      * @param timeScales      known time scales
  88.      * @param system          satellite system to consider for interpreting week number
  89.      *                        (may be different from real system, for example in Rinex nav, weeks
  90.      *                        are always according to GPS)
  91.      * @param type            message type
  92.      */
  93.     protected CivilianNavigationMessage(final boolean cnv2,
  94.                                         final double mu, final double angularVelocity, final int weeksInCycle,
  95.                                         final TimeScales timeScales, final SatelliteSystem system,
  96.                                         final String type) {
  97.         super(mu, angularVelocity, weeksInCycle, timeScales, system, type);
  98.         this.cnv2 = cnv2;
  99.     }

  101.     /** Constructor from field instance.
  102.      * @param <T> type of the field elements
  103.      * @param <A> type of the orbital elements (non-field version)
  104.      * @param original regular field instance
  105.      */
  106.     protected <T extends CalculusFieldElement<T>,
  107.                A extends CivilianNavigationMessage<A>> CivilianNavigationMessage(final FieldCivilianNavigationMessage<T, A> original) {
  108.         super(original);
  109.         this.cnv2 = original.isCnv2();
  110.         setADot(original.getADot().getReal());
  111.         setDeltaN0Dot(original.getDeltaN0Dot().getReal());
  112.         setSvAccuracy(original.getSvAccuracy().getReal());
  113.         setSvHealth(original.getSvHealth());
  114.         setIscL1CA(original.getIscL1CA().getReal());
  115.         setIscL1CD(original.getIscL1CD().getReal());
  116.         setIscL1CP(original.getIscL1CP().getReal());
  117.         setIscL2C(original.getIscL2C().getReal());
  118.         setIscL5I5(original.getIscL5I5().getReal());
  119.         setIscL5Q5(original.getIscL5Q5().getReal());
  120.         setUraiEd(original.getUraiEd());
  121.         setUraiNed0(original.getUraiNed0());
  122.         setUraiNed1(original.getUraiNed1());
  123.         setUraiNed2(original.getUraiNed2());
  124.         setFlags(original.getFlags());
  125.     }

  127.     /** Check it message is a CNV2 message.
  128.      * @return true if message is a CNV2 message
  129.      */
  130.     public boolean isCnv2() {
  131.         return cnv2;
  132.     }

  134.     /** {@inheritDoc} */
  135.     @Override
  136.     public double getADot() {
  137.         return aDot;
  138.     }

  140.     /**
  141.      * Setter for the change rate in semi-major axis.
  142.      * @param value the change rate in semi-major axis
  143.      */
  144.     public void setADot(final double value) {
  145.         this.aDot = value;
  146.     }

  148.     /** {@inheritDoc} */
  149.     @Override
  150.     public double getDeltaN0Dot() {
  151.         return deltaN0Dot;
  152.     }

  154.     /**
  155.      * Setter for change rate in Δn₀.
  156.      * @param deltaN0Dot change rate in Δn₀
  157.      */
  158.     public void setDeltaN0Dot(final double deltaN0Dot) {
  159.         this.deltaN0Dot = deltaN0Dot;
  160.     }

  162.     /**
  163.      * Getter for the user SV accuray (meters).
  164.      * @return the user SV accuracy
  165.      */
  166.     public double getSvAccuracy() {
  167.         return svAccuracy;
  168.     }

  170.     /**
  171.      * Setter for the user SV accuracy.
  172.      * @param svAccuracy the value to set
  173.      */
  174.     public void setSvAccuracy(final double svAccuracy) {
  175.         this.svAccuracy = svAccuracy;
  176.     }

  178.     /**
  179.      * Getter for the satellite health status.
  180.      * @return the satellite health status
  181.      */
  182.     public int getSvHealth() {
  183.         return svHealth;
  184.     }

  186.     /**
  187.      * Setter for the satellite health status.
  188.      * @param svHealth the value to set
  189.      */
  190.     public void setSvHealth(final int svHealth) {
  191.         this.svHealth = svHealth;
  192.     }

  194.     /**
  195.      * Getter for inter Signal Delay for L1 C/A.
  196.      * @return inter signal delay
  197.      */
  198.     public double getIscL1CA() {
  199.         return iscL1CA;
  200.     }

  202.     /**
  203.      * Setter for inter Signal Delay for L1 C/A.
  204.      * @param delay delay to set
  205.      */
  206.     public void setIscL1CA(final double delay) {
  207.         this.iscL1CA = delay;
  208.     }

  210.     /**
  211.      * Getter for inter Signal Delay for L1 CD.
  212.      * @return inter signal delay
  213.      */
  214.     public double getIscL1CD() {
  215.         return iscL1CD;
  216.     }

  218.     /**
  219.      * Setter for inter Signal Delay for L1 CD.
  220.      * @param delay delay to set
  221.      */
  222.     public void setIscL1CD(final double delay) {
  223.         this.iscL1CD = delay;
  224.     }

  226.     /**
  227.      * Getter for inter Signal Delay for L1 CP.
  228.      * @return inter signal delay
  229.      */
  230.     public double getIscL1CP() {
  231.         return iscL1CP;
  232.     }

  234.     /**
  235.      * Setter for inter Signal Delay for L1 CP.
  236.      * @param delay delay to set
  237.      */
  238.     public void setIscL1CP(final double delay) {
  239.         this.iscL1CP = delay;
  240.     }

  242.     /**
  243.      * Getter for inter Signal Delay for L2 C.
  244.      * @return inter signal delay
  245.      */
  246.     public double getIscL2C() {
  247.         return iscL2C;
  248.     }

  250.     /**
  251.      * Setter for inter Signal Delay for L2 C.
  252.      * @param delay delay to set
  253.      */
  254.     public void setIscL2C(final double delay) {
  255.         this.iscL2C = delay;
  256.     }

  258.     /**
  259.      * Getter for inter Signal Delay for L5I.
  260.      * @return inter signal delay
  261.      */
  262.     public double getIscL5I5() {
  263.         return iscL5I5;
  264.     }

  266.     /**
  267.      * Setter for inter Signal Delay for L5I.
  268.      * @param delay delay to set
  269.      */
  270.     public void setIscL5I5(final double delay) {
  271.         this.iscL5I5 = delay;
  272.     }

  274.     /**
  275.      * Getter for inter Signal Delay for L5Q.
  276.      * @return inter signal delay
  277.      */
  278.     public double getIscL5Q5() {
  279.         return iscL5Q5;
  280.     }

  282.     /**
  283.      * Setter for inter Signal Delay for L5Q.
  284.      * @param delay delay to set
  285.      */
  286.     public void setIscL5Q5(final double delay) {
  287.         this.iscL5Q5 = delay;
  288.     }

  290.     /**
  291.      * Getter for Elevation-Dependent User Range Accuracy.
  292.      * @return Elevation-Dependent User Range Accuracy
  293.      */
  294.     public int getUraiEd() {
  295.         return uraiEd;
  296.     }

  298.     /**
  299.      * Setter for Elevation-Dependent User Range Accuracy.
  300.      * @param uraiEd Elevation-Dependent User Range Accuracy
  301.      */
  302.     public void setUraiEd(final int uraiEd) {
  303.         this.uraiEd = uraiEd;
  304.     }

  306.     /**
  307.      * Getter for term 0 of Non-Elevation-Dependent User Range Accuracy.
  308.      * @return term 0 of Non-Elevation-Dependent User Range Accuracy
  309.      */
  310.     public int getUraiNed0() {
  311.         return uraiNed0;
  312.     }

  314.     /**
  315.      * Setter for term 0 of Non-Elevation-Dependent User Range Accuracy.
  316.      * @param uraiNed0 term 0 of Non-Elevation-Dependent User Range Accuracy
  317.      */
  318.     public void setUraiNed0(final int uraiNed0) {
  319.         this.uraiNed0 = uraiNed0;
  320.     }

  322.     /**
  323.      * Getter for term 1 of Non-Elevation-Dependent User Range Accuracy.
  324.      * @return term 1 of Non-Elevation-Dependent User Range Accuracy
  325.      */
  326.     public int getUraiNed1() {
  327.         return uraiNed1;
  328.     }

  330.     /**
  331.      * Setter for term 1 of Non-Elevation-Dependent User Range Accuracy.
  332.      * @param uraiNed1 term 1 of Non-Elevation-Dependent User Range Accuracy
  333.      */
  334.     public void setUraiNed1(final int uraiNed1) {
  335.         this.uraiNed1 = uraiNed1;
  336.     }

  338.     /**
  339.      * Getter for term 2 of Non-Elevation-Dependent User Range Accuracy.
  340.      * @return term 2 of Non-Elevation-Dependent User Range Accuracy
  341.      */
  342.     public int getUraiNed2() {
  343.         return uraiNed2;
  344.     }

  346.     /**
  347.      * Setter for term 2 of Non-Elevation-Dependent User Range Accuracy.
  348.      * @param uraiNed2 term 2 of Non-Elevation-Dependent User Range Accuracy
  349.      */
  350.     public void setUraiNed2(final int uraiNed2) {
  351.         this.uraiNed2 = uraiNed2;
  352.     }

  354.     /** Get the flags.
  355.      * @return flags
  356.      * @since 14.0
  357.      */
  358.     public int getFlags() {
  359.         return flags;
  360.     }

  362.     /** Set the flags.
  363.      * @param flags flags
  364.      * @since 14.0
  365.      */
  366.     public void setFlags(final int flags) {
  367.         this.flags = flags;
  368.     }

  370. }
Created with JaCoCo 0.8.12.202403310830