SP3File.java

  1. /* Copyright 2002-2012 Space Applications Services
  2.  * Licensed to CS Systèmes d'Information (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.files.sp3;

  19. import java.io.Serializable;
  20. import java.util.ArrayList;
  21. import java.util.Collection;
  22. import java.util.Collections;
  23. import java.util.HashMap;
  24. import java.util.LinkedList;
  25. import java.util.List;
  26. import java.util.Map;

  28. import org.orekit.files.general.OrbitFile;
  29. import org.orekit.files.general.SatelliteInformation;
  30. import org.orekit.files.general.SatelliteTimeCoordinate;
  31. import org.orekit.time.AbsoluteDate;

  33. /** Represents a parsed SP3 orbit file.
  34.  * @author Thomas Neidhart
  35.  */
  36. public class SP3File implements OrbitFile, Serializable {

  38.     /** Serializable UID. */
  39.     private static final long serialVersionUID = 3333652174843017654L;

  41.     /** File type indicator. */
  42.     public enum SP3FileType {
  43.         /** GPS only file. */
  44.         GPS,
  45.         /** Mixed file. */
  46.         MIXED,
  47.         /** GLONASS only file. */
  48.         GLONASS,
  49.         /** LEO only file. */
  50.         LEO,
  51.         /** Galileo only file. */
  52.         GALILEO,
  53.         /** COMPASS only file. */
  54.         COMPASS,
  55.         /** QZSS only file. */
  56.         QZSS,
  57.         /** undefined file format. */
  58.         UNDEFINED
  59.     }

  61.     /** Orbit type indicator. */
  62.     public enum SP3OrbitType {
  63.         /** fitted. */
  64.         FIT,
  65.         /** extrapolated or predicted. */
  66.         EXT,
  67.         /** broadcast. */
  68.         BCT,
  69.         /** fitted after applying a Helmert transformation. */
  70.         HLM
  71.     }

  73.     /** File type. */
  74.     private SP3FileType type;

  76.     /** Time system. */
  77.     private TimeSystem timeSystem;

  79.     /** Epoch of the file. */
  80.     private AbsoluteDate epoch;

  82.     /** GPS week. */
  83.     private int gpsWeek;

  85.     /** Seconds of the current GPS week. */
  86.     private double secondsOfWeek;

  88.     /** Julian day. */
  89.     private int julianDay;

  91.     /** Day fraction. */
  92.     private double dayFraction;

  94.     /** Time-interval between epochs. */
  95.     private double epochInterval;

  97.     /** Number of epochs. */
  98.     private int numberOfEpochs;

  100.     /** Coordinate system. */
  101.     private String coordinateSystem;

  103.     /** Data used indicator. */
  104.     private String dataUsed;

  106.     /** Orbit type. */
  107.     private SP3OrbitType orbitType;

  109.     /** Agency providing the file. */
  110.     private String agency;

  112.     /** A list containing additional satellite information. */
  113.     private List<SatelliteInformation> satellites;

  115.     /** A mapping of satellite id to its corresponding {@link SatelliteInformation} object. */
  116.     private Map<String, SatelliteInformation> satelliteInfo;

  118.     /** A map containing all satellite coordinates. */
  119.     private Map<String, List<SatelliteTimeCoordinate>> satelliteCoords;

  121.     /** Create a new SP3 file object. */
  122.     public SP3File() {
  123.         satellites = new ArrayList<SatelliteInformation>();
  124.         satelliteInfo = new HashMap<String, SatelliteInformation>();
  125.         satelliteCoords = new HashMap<String, List<SatelliteTimeCoordinate>>();
  126.     }

  128.     /** Returns the {@link SP3FileType} associated with this SP3 file.
  129.      * @return the file type for this SP3 file
  130.      */
  131.     public SP3FileType getType() {
  132.         return type;
  133.     }

  135.     /** Set the file type for this SP3 file.
  136.      * @param fileType the file type to be set
  137.      */
  138.     public void setType(final SP3FileType fileType) {
  139.         this.type = fileType;
  140.     }

  142.     /** {@inheritDoc} */
  143.     public TimeSystem getTimeSystem() {
  144.         return timeSystem;
  145.     }

  147.     /** Set the time system used in this SP3 file.
  148.      * @param system the time system to be set
  149.      */
  150.     public void setTimeSystem(final TimeSystem system) {
  151.         this.timeSystem = system;
  152.     }

  154.     /** Returns the data used indicator from the SP3 file.
  155.      * @return the data used indicator (unparsed)
  156.      */
  157.     public String getDataUsed() {
  158.         return dataUsed;
  159.     }

  161.     /** Set the data used indicator for this SP3 file.
  162.      * @param data the data used indicator to be set
  163.      */
  164.     public void setDataUsed(final String data) {
  165.         this.dataUsed = data;
  166.     }

  168.     /** {@inheritDoc} */
  169.     public AbsoluteDate getEpoch() {
  170.         return epoch;
  171.     }

  173.     /** Set the epoch of the SP3 file.
  174.      * @param time the epoch to be set
  175.      */
  176.     public void setEpoch(final AbsoluteDate time) {
  177.         this.epoch = time;
  178.     }

  180.     /** Returns the GPS week as contained in the SP3 file.
  181.      * @return the GPS week of the SP3 file
  182.      */
  183.     public int getGpsWeek() {
  184.         return gpsWeek;
  185.     }

  187.     /** Set the GPS week of the SP3 file.
  188.      * @param week the GPS week to be set
  189.      */
  190.     public void setGpsWeek(final int week) {
  191.         this.gpsWeek = week;
  192.     }

  194.     /** Returns the seconds of the GPS week as contained in the SP3 file.
  195.      * @return the seconds of the GPS week
  196.      */
  197.     public double getSecondsOfWeek() {
  198.         return secondsOfWeek;
  199.     }

  201.     /** Set the seconds of the GPS week for this SP3 file.
  202.      * @param seconds the seconds to be set
  203.      */
  204.     public void setSecondsOfWeek(final double seconds) {
  205.         this.secondsOfWeek = seconds;
  206.     }

  208.     /** Returns the julian day for this SP3 file.
  209.      * @return the julian day
  210.      */
  211.     public int getJulianDay() {
  212.         return julianDay;
  213.     }

  215.     /** Set the julian day for this SP3 file.
  216.      * @param day the julian day to be set
  217.      */
  218.     public void setJulianDay(final int day) {
  219.         this.julianDay = day;
  220.     }

  222.     /** Returns the day fraction for this SP3 file.
  223.      * @return the day fraction
  224.      */
  225.     public double getDayFraction() {
  226.         return dayFraction;
  227.     }

  229.     /** Set the day fraction for this SP3 file.
  230.      * @param fraction the day fraction to be set
  231.      */
  232.     public void setDayFraction(final double fraction) {
  233.         this.dayFraction = fraction;
  234.     }

  236.     /** {@inheritDoc} */
  237.     public double getEpochInterval() {
  238.         return epochInterval;
  239.     }

  241.     /** Set the epoch interval for this SP3 file.
  242.      * @param interval the interval between orbit entries
  243.      */
  244.     public void setEpochInterval(final double interval) {
  245.         this.epochInterval = interval;
  246.     }

  248.     /** {@inheritDoc} */
  249.     public int getNumberOfEpochs() {
  250.         return numberOfEpochs;
  251.     }

  253.     /** Set the number of epochs as contained in the SP3 file.
  254.      * @param epochCount the number of epochs to be set
  255.      */
  256.     public void setNumberOfEpochs(final int epochCount) {
  257.         this.numberOfEpochs = epochCount;
  258.     }

  260.     /** {@inheritDoc} */
  261.     public String getCoordinateSystem() {
  262.         return coordinateSystem;
  263.     }

  265.     /** Set the coordinate system used for the orbit entries.
  266.      * @param system the coordinate system to be set
  267.      */
  268.     public void setCoordinateSystem(final String system) {
  269.         this.coordinateSystem = system;
  270.     }

  272.     /** Returns the {@link SP3OrbitType} for this SP3 file.
  273.      * @return the orbit type
  274.      */
  275.     public SP3OrbitType getOrbitType() {
  276.         return orbitType;
  277.     }

  279.     /** Set the {@link SP3OrbitType} for this SP3 file.
  280.      * @param oType the orbit type to be set
  281.      */
  282.     public void setOrbitType(final SP3OrbitType oType) {
  283.         this.orbitType = oType;
  284.     }

  286.     /** Returns the agency that prepared this SP3 file.
  287.      * @return the agency
  288.      */
  289.     public String getAgency() {
  290.         return agency;
  291.     }

  293.     /** Set the agency string for this SP3 file.
  294.      * @param agencyStr the agency string to be set
  295.      */
  296.     public void setAgency(final String agencyStr) {
  297.         this.agency = agencyStr;
  298.     }

  300.     /** Add a new satellite with a given identifier to the list of
  301.      * stored satellites.
  302.      * @param satId the satellite identifier
  303.      */
  304.     public void addSatellite(final String satId) {
  305.         // only add satellites which have not been added before
  306.         if (getSatellite(satId) == null) {
  307.             final SatelliteInformation info = new SatelliteInformation(satId);
  308.             satellites.add(info);
  309.             satelliteInfo.put(satId, info);
  310.             satelliteCoords.put(satId, new LinkedList<SatelliteTimeCoordinate>());
  311.         }
  312.     }

  314.     /** {@inheritDoc} */
  315.     public Collection<SatelliteInformation> getSatellites() {
  316.         return Collections.unmodifiableCollection(satellites);
  317.     }

  319.     /** {@inheritDoc} */
  320.     public int getSatelliteCount() {
  321.         return satellites.size();
  322.     }

  324.     /** {@inheritDoc} */
  325.     public SatelliteInformation getSatellite(final String satId) {
  326.         if (satId == null) {
  327.             return null;
  328.         }

  330.         return satelliteInfo.get(satId);
  331.     }

  333.     /** Returns the nth satellite as contained in the SP3 file.
  334.      * @param n the index of the satellite
  335.      * @return a {@link SatelliteInformation} object for the nth satellite
  336.      */
  337.     public SatelliteInformation getSatellite(final int n) {
  338.         return satellites.get(n);
  339.     }

  341.     /** {@inheritDoc} */
  342.     public boolean containsSatellite(final String satId) {
  343.         return satelliteCoords.containsKey(satId);
  344.     }

  346.     /** {@inheritDoc} */
  347.     public List<SatelliteTimeCoordinate> getSatelliteCoordinates(final String satId) {
  348.         return satelliteCoords.get(satId);
  349.     }

  351.     /** Adds a new P/V coordinate for a given satellite.
  352.      * @param satId the satellite identifier
  353.      * @param coord the P/V coordinate of the satellite
  354.      */
  355.     public void addSatelliteCoordinate(final String satId, final SatelliteTimeCoordinate coord) {
  356.         final List<SatelliteTimeCoordinate> coords = satelliteCoords.get(satId);
  357.         if (coords != null) {
  358.             coords.add(coord);
  359.         }
  360.     }
  361. }
Created with JaCoCo 0.6.3.201306030806