CivilianNavigationMessage.java

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

  18. /**
  19.  * Container for data contained in a GPS/QZNSS civilian navigation message.
  20.  * @author Luc Maisonobe
  21.  * @since 12.0
  22.  */
  23. public class CivilianNavigationMessage extends AbstractNavigationMessage implements GNSSClockElements {

  24.     /** Identifier for message type. */
  25.     public static final String CNAV = "CNAV";

  26.     /** Identifier for message type. */
  27.     public static final String CNV2 = "CNV2";

  28.     /** Indicator for CNV 2 messages. */
  29.     private final boolean cnv2;

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

  32.     /** Change rate in Δn₀. */
  33.     private double deltaN0Dot;

  34.     /** Group Delay Differential (s). */
  35.     private double tgd;

  36.     /** The user SV accuracy (m). */
  37.     private double svAccuracy;

  38.     /** Satellite health status. */
  39.     private int svHealth;

  40.     /** Inter Signal Delay for L1 C/A. */
  41.     private double iscL1CA;

  42.     /** Inter Signal Delay for L1 CD. */
  43.     private double iscL1CD;

  44.     /** Inter Signal Delay for L1 CP. */
  45.     private double iscL1CP;

  46.     /** Inter Signal Delay for L2 C. */
  47.     private double iscL2C;

  48.     /** Inter Signal Delay for L5I. */
  49.     private double iscL5I5;

  50.     /** Inter Signal Delay for L5Q. */
  51.     private double iscL5Q5;

  52.     /** Elevation-Dependent User Range Accuracy. */
  53.     private int uraiEd;

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

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

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

  60.     /**
  61.      * Constructor.
  62.      * @param cnv2 indicator for CNV2 messages
  63.      * @param mu Earth's universal gravitational parameter
  64.      * @param angularVelocity mean angular velocity of the Earth for the GNSS model
  65.      * @param weekNumber number of weeks in the GNSS cycle
  66.      */
  67.     protected CivilianNavigationMessage(final boolean cnv2,
  68.                                         final double mu,
  69.                                         final double angularVelocity,
  70.                                         final int weekNumber) {
  71.         super(mu, angularVelocity, weekNumber);
  72.         this.cnv2 = cnv2;
  73.     }

  74.     /** Check it message is a CNV2 message.
  75.      * @return true if message is a CNV2 message
  76.      */
  77.     public boolean isCnv2() {
  78.         return cnv2;
  79.     }

  80.     /**
  81.      * Getter for the change rate in semi-major axis.
  82.      * @return the change rate in semi-major axis
  83.      */
  84.     public double getADot() {
  85.         return aDot;
  86.     }

  87.     /**
  88.      * Setter for the change rate in semi-major axis.
  89.      * @param value the change rate in semi-major axis
  90.      */
  91.     public void setADot(final double value) {
  92.         this.aDot = value;
  93.     }

  94.     /**
  95.      * Getter for change rate in Δn₀.
  96.      * @return change rate in Δn₀
  97.      */
  98.     public double getDeltaN0Dot() {
  99.         return deltaN0Dot;
  100.     }

  101.     /**
  102.      * Setter for change rate in Δn₀.
  103.      * @param deltaN0Dot change rate in Δn₀
  104.      */
  105.     public void setDeltaN0Dot(final double deltaN0Dot) {
  106.         this.deltaN0Dot = deltaN0Dot;
  107.     }

  108.     /**
  109.      * Getter for the Group Delay Differential (s).
  110.      * @return the Group Delay Differential in seconds
  111.      */
  112.     public double getTGD() {
  113.         return tgd;
  114.     }

  115.     /**
  116.      * Setter for the Group Delay Differential (s).
  117.      * @param time the group delay differential to set
  118.      */
  119.     public void setTGD(final double time) {
  120.         this.tgd = time;
  121.     }

  122.     /**
  123.      * Getter for the user SV accuray (meters).
  124.      * @return the user SV accuracy
  125.      */
  126.     public double getSvAccuracy() {
  127.         return svAccuracy;
  128.     }

  129.     /**
  130.      * Setter for the user SV accuracy.
  131.      * @param svAccuracy the value to set
  132.      */
  133.     public void setSvAccuracy(final double svAccuracy) {
  134.         this.svAccuracy = svAccuracy;
  135.     }

  136.     /**
  137.      * Getter for the satellite health status.
  138.      * @return the satellite health status
  139.      */
  140.     public int getSvHealth() {
  141.         return svHealth;
  142.     }

  143.     /**
  144.      * Setter for the satellite health status.
  145.      * @param svHealth the value to set
  146.      */
  147.     public void setSvHealth(final int svHealth) {
  148.         this.svHealth = svHealth;
  149.     }

  150.     /**
  151.      * Getter for inter Signal Delay for L1 C/A.
  152.      * @return inter signal delay
  153.      */
  154.     public double getIscL1CA() {
  155.         return iscL1CA;
  156.     }

  157.     /**
  158.      * Setter for inter Signal Delay for L1 C/A.
  159.      * @param delay delay to set
  160.      */
  161.     public void setIscL1CA(final double delay) {
  162.         this.iscL1CA = delay;
  163.     }

  164.     /**
  165.      * Getter for inter Signal Delay for L1 CD.
  166.      * @return inter signal delay
  167.      */
  168.     public double getIscL1CD() {
  169.         return iscL1CD;
  170.     }

  171.     /**
  172.      * Setter for inter Signal Delay for L1 CD.
  173.      * @param delay delay to set
  174.      */
  175.     public void setIscL1CD(final double delay) {
  176.         this.iscL1CD = delay;
  177.     }

  178.     /**
  179.      * Getter for inter Signal Delay for L1 CP.
  180.      * @return inter signal delay
  181.      */
  182.     public double getIscL1CP() {
  183.         return iscL1CP;
  184.     }

  185.     /**
  186.      * Setter for inter Signal Delay for L1 CP.
  187.      * @param delay delay to set
  188.      */
  189.     public void setIscL1CP(final double delay) {
  190.         this.iscL1CP = delay;
  191.     }

  192.     /**
  193.      * Getter for inter Signal Delay for L2 C.
  194.      * @return inter signal delay
  195.      */
  196.     public double getIscL2C() {
  197.         return iscL2C;
  198.     }

  199.     /**
  200.      * Setter for inter Signal Delay for L2 C.
  201.      * @param delay delay to set
  202.      */
  203.     public void setIscL2C(final double delay) {
  204.         this.iscL2C = delay;
  205.     }

  206.     /**
  207.      * Getter for inter Signal Delay for L5I.
  208.      * @return inter signal delay
  209.      */
  210.     public double getIscL5I5() {
  211.         return iscL5I5;
  212.     }

  213.     /**
  214.      * Setter for inter Signal Delay for L5I.
  215.      * @param delay delay to set
  216.      */
  217.     public void setIscL5I5(final double delay) {
  218.         this.iscL5I5 = delay;
  219.     }

  220.     /**
  221.      * Getter for inter Signal Delay for L5Q.
  222.      * @return inter signal delay
  223.      */
  224.     public double getIscL5Q5() {
  225.         return iscL5Q5;
  226.     }

  227.     /**
  228.      * Setter for inter Signal Delay for L5Q.
  229.      * @param delay delay to set
  230.      */
  231.     public void setIscL5Q5(final double delay) {
  232.         this.iscL5Q5 = delay;
  233.     }

  234.     /**
  235.      * Getter for Elevation-Dependent User Range Accuracy.
  236.      * @return Elevation-Dependent User Range Accuracy
  237.      */
  238.     public int getUraiEd() {
  239.         return uraiEd;
  240.     }

  241.     /**
  242.      * Setter for Elevation-Dependent User Range Accuracy.
  243.      * @param uraiEd Elevation-Dependent User Range Accuracy
  244.      */
  245.     public void setUraiEd(final int uraiEd) {
  246.         this.uraiEd = uraiEd;
  247.     }

  248.     /**
  249.      * Getter for term 0 of Non-Elevation-Dependent User Range Accuracy.
  250.      * @return term 0 of Non-Elevation-Dependent User Range Accuracy
  251.      */
  252.     public int getUraiNed0() {
  253.         return uraiNed0;
  254.     }

  255.     /**
  256.      * Setter for term 0 of Non-Elevation-Dependent User Range Accuracy.
  257.      * @param uraiNed0 term 0 of Non-Elevation-Dependent User Range Accuracy
  258.      */
  259.     public void setUraiNed0(final int uraiNed0) {
  260.         this.uraiNed0 = uraiNed0;
  261.     }

  262.     /**
  263.      * Getter for term 1 of Non-Elevation-Dependent User Range Accuracy.
  264.      * @return term 1 of Non-Elevation-Dependent User Range Accuracy
  265.      */
  266.     public int getUraiNed1() {
  267.         return uraiNed1;
  268.     }

  269.     /**
  270.      * Setter for term 1 of Non-Elevation-Dependent User Range Accuracy.
  271.      * @param uraiNed1 term 1 of Non-Elevation-Dependent User Range Accuracy
  272.      */
  273.     public void setUraiNed1(final int uraiNed1) {
  274.         this.uraiNed1 = uraiNed1;
  275.     }

  276.     /**
  277.      * Getter for term 2 of Non-Elevation-Dependent User Range Accuracy.
  278.      * @return term 2 of Non-Elevation-Dependent User Range Accuracy
  279.      */
  280.     public int getUraiNed2() {
  281.         return uraiNed2;
  282.     }

  283.     /**
  284.      * Setter for term 2 of Non-Elevation-Dependent User Range Accuracy.
  285.      * @param uraiNed2 term 2 of Non-Elevation-Dependent User Range Accuracy
  286.      */
  287.     public void setUraiNed2(final int uraiNed2) {
  288.         this.uraiNed2 = uraiNed2;
  289.     }

  290. }