CombinedObservationDataSet.java

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

  18. import java.util.Collections;
  19. import java.util.List;

  20. import org.orekit.time.AbsoluteDate;
  21. import org.orekit.time.TimeStamped;

  22. /**
  23.  * Combined observation data set.
  24.  * @author Bryan Cazabonne
  25.  * @since 10.1
  26.  */
  27. public class CombinedObservationDataSet implements TimeStamped {

  28.     /** Rinex header associated with this data set. */
  29.     private final RinexHeader header;

  30.     /** Satellite System. */
  31.     private final SatelliteSystem satelliteSystem;

  32.     /** PRN Number of the satellite observed. */
  33.     private final int prnNumber;

  34.     /** Date of the observation. */
  35.     private final AbsoluteDate tObs;

  36.     /** List of Observation data. */
  37.     private final List<CombinedObservationData> observationData;

  38.     /** Receiver clock offset (seconds). */
  39.     private final double rcvrClkOffset;

  40.     /**
  41.      * Simple constructor.
  42.      * @param header Rinex header associated with this data set
  43.      * @param satelliteSystem Satellite system
  44.      * @param prnNumber PRN number
  45.      * @param tObs Observation date
  46.      * @param rcvrClkOffset Receiver clock offset (optional, 0 by default)
  47.      * @param observationData List of combined observation data
  48.      */
  49.     public CombinedObservationDataSet(final RinexHeader header, final SatelliteSystem satelliteSystem,
  50.                                       final int prnNumber, final AbsoluteDate tObs,
  51.                                       final double rcvrClkOffset, final List<CombinedObservationData> observationData) {
  52.         this.header          = header;
  53.         this.satelliteSystem = satelliteSystem;
  54.         this.prnNumber       = prnNumber;
  55.         this.tObs            = tObs;
  56.         this.observationData = observationData;
  57.         this.rcvrClkOffset   = rcvrClkOffset;
  58.     }

  59.     /** Get the Rinex header associated with this data set.
  60.      * @return Rinex header associated with this data set
  61.      * @since 9.3
  62.      */
  63.     public RinexHeader getHeader() {
  64.         return header;
  65.     }

  66.     /** Get Satellite System.
  67.      * @return satellite system of observed satellite
  68.      */
  69.     public SatelliteSystem getSatelliteSystem() {
  70.         return satelliteSystem;
  71.     }

  72.     /** Get PRN number.
  73.      * @return PRN number of the observed satellite
  74.      */
  75.     public int getPrnNumber() {
  76.         return prnNumber;
  77.     }

  78.     /** {@inheritDoc} */
  79.     @Override
  80.     public AbsoluteDate getDate() {
  81.         return tObs;
  82.     }

  83.     /** Get list of observation data.
  84.      * @return unmodifiable view of of observation data for the observed satellite
  85.      */
  86.     public List<CombinedObservationData> getObservationData() {
  87.         return Collections.unmodifiableList(observationData);
  88.     }

  89.     /** Get receiver clock offset.
  90.      * @return receiver clock offset (it is optional, may be 0)
  91.      */
  92.     public double getRcvrClkOffset() {
  93.         return rcvrClkOffset;
  94.     }

  95. }