FieldCivilianNavigationMessage.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.hipparchus.Field;

  22. import java.util.function.Function;

  24. /**
  25.  * Container for data contained in a GPS/QZNSS civilian navigation message.
  26.  * @param <T> type of the field elements
  27.  * @param <O> type of the orbital elements (non-field version)
  28.  * @author Luc Maisonobe
  29.  * @since 13.0
  30.  */
  31. public abstract class FieldCivilianNavigationMessage<T extends CalculusFieldElement<T>,
  32.                                                      O extends CivilianNavigationMessage<O>>
  33.     extends FieldAbstractNavigationMessage<T, O>
  34.     implements FieldGNSSClockElements<T> {

  36.     /** Indicator for CNV 2 messages. */
  37.     private final boolean cnv2;

  39.     /** Change rate in semi-major axis (m/s). */
  40.     private T aDot;

  42.     /** Change rate in Δn₀. */
  43.     private T deltaN0Dot;

  45.     /** The user SV accuracy (m). */
  46.     private T svAccuracy;

  48.     /** Satellite health status. */
  49.     private int svHealth;

  51.     /** Inter Signal Delay for L1 C/A. */
  52.     private T iscL1CA;

  54.     /** Inter Signal Delay for L1 CD. */
  55.     private T iscL1CD;

  57.     /** Inter Signal Delay for L1 CP. */
  58.     private T iscL1CP;

  60.     /** Inter Signal Delay for L2 C. */
  61.     private T iscL2C;

  63.     /** Inter Signal Delay for L5I. */
  64.     private T iscL5I5;

  66.     /** Inter Signal Delay for L5Q. */
  67.     private T iscL5Q5;

  69.     /** Elevation-Dependent User Range Accuracy. */
  70.     private int uraiEd;

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

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

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

  81.     /** Flags.
  82.      * @since 14.0
  83.      */
  84.     private int flags;

  86.     /** Constructor from non-field instance.
  87.      * @param field    field to which elements belong
  88.      * @param original regular non-field instance
  89.      */
  90.     protected FieldCivilianNavigationMessage(final Field<T> field, final O original) {
  91.         super(field, original);
  92.         this.cnv2 = original.isCnv2();
  93.         setADot(field.getZero().newInstance(original.getADot()));
  94.         setDeltaN0Dot(field.getZero().newInstance(original.getDeltaN0Dot()));
  95.         setSvAccuracy(field.getZero().newInstance(original.getSvAccuracy()));
  96.         setSvHealth(original.getSvHealth());
  97.         setIscL1CA(field.getZero().newInstance(original.getIscL1CA()));
  98.         setIscL1CD(field.getZero().newInstance(original.getIscL1CD()));
  99.         setIscL1CP(field.getZero().newInstance(original.getIscL1CP()));
  100.         setIscL2C(field.getZero().newInstance(original.getIscL2C()));
  101.         setIscL5I5(field.getZero().newInstance(original.getIscL5I5()));
  102.         setIscL5Q5(field.getZero().newInstance(original.getIscL5Q5()));
  103.         setUraiEd(original.getUraiEd());
  104.         setUraiNed0(original.getUraiNed0());
  105.         setUraiNed1(original.getUraiNed1());
  106.         setUraiNed2(original.getUraiNed2());
  107.         setFlags(original.getFlags());
  108.     }

  110.     /** Constructor from different field instance.
  111.      * @param <V> type of the old field elements
  112.      * @param original regular non-field instance
  113.      * @param converter for field elements
  114.      */
  115.     protected <V extends CalculusFieldElement<V>> FieldCivilianNavigationMessage(final Function<V, T> converter,
  116.                                                                                  final FieldCivilianNavigationMessage<V, O> original) {
  117.         super(converter, original);
  118.         this.cnv2 = original.isCnv2();
  119.         setADot(converter.apply(original.getADot()));
  120.         setDeltaN0Dot(converter.apply(original.getDeltaN0Dot()));
  121.         setSvAccuracy(converter.apply(original.getSvAccuracy()));
  122.         setSvHealth(original.getSvHealth());
  123.         setIscL1CA(converter.apply(original.getIscL1CA()));
  124.         setIscL1CD(converter.apply(original.getIscL1CD()));
  125.         setIscL1CP(converter.apply(original.getIscL1CP()));
  126.         setIscL2C(converter.apply(original.getIscL2C()));
  127.         setIscL5I5(converter.apply(original.getIscL5I5()));
  128.         setIscL5Q5(converter.apply(original.getIscL5Q5()));
  129.         setUraiEd(original.getUraiEd());
  130.         setUraiNed0(original.getUraiNed0());
  131.         setUraiNed1(original.getUraiNed1());
  132.         setUraiNed2(original.getUraiNed2());
  133.         setFlags(original.getFlags());
  134.     }

  136.     /** Check it message is a CNV2 message.
  137.      * @return true if message is a CNV2 message
  138.      */
  139.     public boolean isCnv2() {
  140.         return cnv2;
  141.     }

  143.     /** {@inheritDoc} */
  144.     @Override
  145.     public T getADot() {
  146.         return aDot;
  147.     }

  149.     /**
  150.      * Setter for the change rate in semi-major axis.
  151.      * @param value the change rate in semi-major axis
  152.      */
  153.     public void setADot(final T value) {
  154.         this.aDot = value;
  155.     }

  157.     /** {@inheritDoc} */
  158.     @Override
  159.     public T getDeltaN0Dot() {
  160.         return deltaN0Dot;
  161.     }

  163.     /**
  164.      * Setter for change rate in Δn₀.
  165.      * @param deltaN0Dot change rate in Δn₀
  166.      */
  167.     public void setDeltaN0Dot(final T deltaN0Dot) {
  168.         this.deltaN0Dot = deltaN0Dot;
  169.     }

  171.     /**
  172.      * Getter for the user SV accuray (meters).
  173.      * @return the user SV accuracy
  174.      */
  175.     public T getSvAccuracy() {
  176.         return svAccuracy;
  177.     }

  179.     /**
  180.      * Setter for the user SV accuracy.
  181.      * @param svAccuracy the value to set
  182.      */
  183.     public void setSvAccuracy(final T svAccuracy) {
  184.         this.svAccuracy = svAccuracy;
  185.     }

  187.     /**
  188.      * Getter for the satellite health status.
  189.      * @return the satellite health status
  190.      */
  191.     public int getSvHealth() {
  192.         return svHealth;
  193.     }

  195.     /**
  196.      * Setter for the satellite health status.
  197.      * @param svHealth the value to set
  198.      */
  199.     public void setSvHealth(final int svHealth) {
  200.         this.svHealth = svHealth;
  201.     }

  203.     /**
  204.      * Getter for inter Signal Delay for L1 C/A.
  205.      * @return inter signal delay
  206.      */
  207.     public T getIscL1CA() {
  208.         return iscL1CA;
  209.     }

  211.     /**
  212.      * Setter for inter Signal Delay for L1 C/A.
  213.      * @param delay delay to set
  214.      */
  215.     public void setIscL1CA(final T delay) {
  216.         this.iscL1CA = delay;
  217.     }

  219.     /**
  220.      * Getter for inter Signal Delay for L1 CD.
  221.      * @return inter signal delay
  222.      */
  223.     public T getIscL1CD() {
  224.         return iscL1CD;
  225.     }

  227.     /**
  228.      * Setter for inter Signal Delay for L1 CD.
  229.      * @param delay delay to set
  230.      */
  231.     public void setIscL1CD(final T delay) {
  232.         this.iscL1CD = delay;
  233.     }

  235.     /**
  236.      * Getter for inter Signal Delay for L1 CP.
  237.      * @return inter signal delay
  238.      */
  239.     public T getIscL1CP() {
  240.         return iscL1CP;
  241.     }

  243.     /**
  244.      * Setter for inter Signal Delay for L1 CP.
  245.      * @param delay delay to set
  246.      */
  247.     public void setIscL1CP(final T delay) {
  248.         this.iscL1CP = delay;
  249.     }

  251.     /**
  252.      * Getter for inter Signal Delay for L2 C.
  253.      * @return inter signal delay
  254.      */
  255.     public T getIscL2C() {
  256.         return iscL2C;
  257.     }

  259.     /**
  260.      * Setter for inter Signal Delay for L2 C.
  261.      * @param delay delay to set
  262.      */
  263.     public void setIscL2C(final T delay) {
  264.         this.iscL2C = delay;
  265.     }

  267.     /**
  268.      * Getter for inter Signal Delay for L5I.
  269.      * @return inter signal delay
  270.      */
  271.     public T getIscL5I5() {
  272.         return iscL5I5;
  273.     }

  275.     /**
  276.      * Setter for inter Signal Delay for L5I.
  277.      * @param delay delay to set
  278.      */
  279.     public void setIscL5I5(final T delay) {
  280.         this.iscL5I5 = delay;
  281.     }

  283.     /**
  284.      * Getter for inter Signal Delay for L5Q.
  285.      * @return inter signal delay
  286.      */
  287.     public T getIscL5Q5() {
  288.         return iscL5Q5;
  289.     }

  291.     /**
  292.      * Setter for inter Signal Delay for L5Q.
  293.      * @param delay delay to set
  294.      */
  295.     public void setIscL5Q5(final T delay) {
  296.         this.iscL5Q5 = delay;
  297.     }

  299.     /**
  300.      * Getter for Elevation-Dependent User Range Accuracy.
  301.      * @return Elevation-Dependent User Range Accuracy
  302.      */
  303.     public int getUraiEd() {
  304.         return uraiEd;
  305.     }

  307.     /**
  308.      * Setter for Elevation-Dependent User Range Accuracy.
  309.      * @param uraiEd Elevation-Dependent User Range Accuracy
  310.      */
  311.     public void setUraiEd(final int uraiEd) {
  312.         this.uraiEd = uraiEd;
  313.     }

  315.     /**
  316.      * Getter for term 0 of Non-Elevation-Dependent User Range Accuracy.
  317.      * @return term 0 of Non-Elevation-Dependent User Range Accuracy
  318.      */
  319.     public int getUraiNed0() {
  320.         return uraiNed0;
  321.     }

  323.     /**
  324.      * Setter for term 0 of Non-Elevation-Dependent User Range Accuracy.
  325.      * @param uraiNed0 term 0 of Non-Elevation-Dependent User Range Accuracy
  326.      */
  327.     public void setUraiNed0(final int uraiNed0) {
  328.         this.uraiNed0 = uraiNed0;
  329.     }

  331.     /**
  332.      * Getter for term 1 of Non-Elevation-Dependent User Range Accuracy.
  333.      * @return term 1 of Non-Elevation-Dependent User Range Accuracy
  334.      */
  335.     public int getUraiNed1() {
  336.         return uraiNed1;
  337.     }

  339.     /**
  340.      * Setter for term 1 of Non-Elevation-Dependent User Range Accuracy.
  341.      * @param uraiNed1 term 1 of Non-Elevation-Dependent User Range Accuracy
  342.      */
  343.     public void setUraiNed1(final int uraiNed1) {
  344.         this.uraiNed1 = uraiNed1;
  345.     }

  347.     /**
  348.      * Getter for term 2 of Non-Elevation-Dependent User Range Accuracy.
  349.      * @return term 2 of Non-Elevation-Dependent User Range Accuracy
  350.      */
  351.     public int getUraiNed2() {
  352.         return uraiNed2;
  353.     }

  355.     /**
  356.      * Setter for term 2 of Non-Elevation-Dependent User Range Accuracy.
  357.      * @param uraiNed2 term 2 of Non-Elevation-Dependent User Range Accuracy
  358.      */
  359.     public void setUraiNed2(final int uraiNed2) {
  360.         this.uraiNed2 = uraiNed2;
  361.     }

  363.     /** Get the flags.
  364.      * @return flags
  365.      * @since 14.0
  366.      */
  367.     public int getFlags() {
  368.         return flags;
  369.     }

  371.     /** Set the flags.
  372.      * @param flags flags
  373.      * @since 14.0
  374.      */
  375.     public void setFlags(final int flags) {
  376.         this.flags = flags;
  377.     }

  379. }
Created with JaCoCo 0.8.12.202403310830