SatelliteAntenna.java

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

  18. import java.util.Map;

  19. import org.orekit.gnss.Frequency;
  20. import org.orekit.gnss.SatelliteSystem;
  21. import org.orekit.time.AbsoluteDate;

  22. /**
  23.  * GNSS satellite antenna model.
  24.  *
  25.  * @author Luc Maisonobe
  26.  * @since 9.2
  27.  * @see <a href="ftp://www.igs.org/pub/station/general/antex14.txt">ANTEX: The Antenna Exchange Format, Version 1.4</a>
  28.  *
  29.  */
  30. public class SatelliteAntenna extends Antenna {

  31.     /** Satellite system. */
  32.     private final SatelliteSystem satelliteSystem;

  33.     /** PRN number. */
  34.     private final int prnNumber;

  35.     /** Satellite type.
  36.      * @since 9.3
  37.      */
  38.     private final SatelliteType satelliteType;

  39.     /** Satellite code. */
  40.     private final int satelliteCode;

  41.     /** COSPAR ID. */
  42.     private final String cosparID;

  43.     /** Start of validity. */
  44.     private final AbsoluteDate validFrom;

  45.     /** End of validity. */
  46.     private final AbsoluteDate validUntil;

  47.     /** Simple constructor.
  48.      * @param type antenna type
  49.      * @param sinexCode sinex code
  50.      * @param patterns frequencies patterns
  51.      * @param satelliteSystem satellite system
  52.      * @param prnNumber PRN number
  53.      * @param satelliteType satellite type
  54.      * @param satelliteCode satellite code
  55.      * @param cosparID COSPAR ID
  56.      * @param validFrom start of validity
  57.      * @param validUntil end of validity
  58.      */
  59.     public SatelliteAntenna(final String type, final String sinexCode,
  60.                             final Map<Frequency, FrequencyPattern> patterns,
  61.                             final SatelliteSystem satelliteSystem, final int prnNumber,
  62.                             final SatelliteType satelliteType, final int satelliteCode,
  63.                             final String cosparID,
  64.                             final AbsoluteDate validFrom, final AbsoluteDate validUntil) {
  65.         super(type, sinexCode, patterns);
  66.         this.satelliteSystem = satelliteSystem;
  67.         this.prnNumber       = prnNumber;
  68.         this.satelliteType   = satelliteType;
  69.         this.satelliteCode   = satelliteCode;
  70.         this.cosparID        = cosparID;
  71.         this.validFrom       = validFrom;
  72.         this.validUntil      = validUntil;
  73.     }

  74.     /** Get satellite system.
  75.      * @return satellite system
  76.      */
  77.     public SatelliteSystem getSatelliteSystem() {
  78.         return satelliteSystem;
  79.     }

  80.     /** Get PRN number.
  81.      * @return PRN number
  82.      */
  83.     public int getPrnNumber() {
  84.         return prnNumber;
  85.     }

  86.     /** Get satellite type.
  87.      * @return satellite type
  88.      * @since 9.3
  89.      */
  90.     public SatelliteType getSatelliteType() {
  91.         return satelliteType;
  92.     }

  93.     /** Get satellite code.
  94.      * @return satellite code
  95.      */
  96.     public int getSatelliteCode() {
  97.         return satelliteCode;
  98.     }

  99.     /** Get COSPAR ID.
  100.      * @return COSPAR ID
  101.      */
  102.     public String getCosparID() {
  103.         return cosparID;
  104.     }

  105.     /** Get start of validity.
  106.      * @return start of validity
  107.      */
  108.     public AbsoluteDate getValidFrom() {
  109.         return validFrom;
  110.     }

  111.     /** Get end of validity.
  112.      * @return end of validity
  113.      */
  114.     public AbsoluteDate getValidUntil() {
  115.         return validUntil;
  116.     }

  117. }