TLESeries.java

  1. /* Copyright 2002-2017 CS Systèmes d'Information
  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.propagation.analytical.tle;

  19. import java.io.BufferedReader;
  20. import java.io.IOException;
  21. import java.io.InputStream;
  22. import java.io.InputStreamReader;
  23. import java.util.Set;
  24. import java.util.SortedSet;
  25. import java.util.TreeSet;

  27. import org.orekit.data.DataLoader;
  28. import org.orekit.data.DataProvidersManager;
  29. import org.orekit.errors.OrekitException;
  30. import org.orekit.errors.OrekitMessages;
  31. import org.orekit.time.AbsoluteDate;
  32. import org.orekit.time.ChronologicalComparator;
  33. import org.orekit.time.TimeStamped;
  34. import org.orekit.utils.PVCoordinates;

  36. /** This class reads and handles series of TLEs for one space object.
  37.  *  <p>
  38.  *  TLE data is read using the standard Orekit mechanism based on a configured
  39.  *  {@link DataProvidersManager DataProvidersManager}. This means TLE data may
  40.  *  be retrieved from many different storage media (local disk files, remote servers,
  41.  *  database ...).
  42.  *  </p>
  43.  *  <p>
  44.  *  This class provides bounded ephemerides by finding the best initial TLE to
  45.  *  propagate and then handling the propagation.
  46.  *  </p>
  47.  *
  48.  * @see TLE
  49.  * @see DataProvidersManager
  50.  * @author Fabien Maussion
  51.  * @author Luc Maisonobe
  52.  * @deprecated as of 9.0, this class is deprecated without replacement. The file format
  53.  * used was considered to be too specific and the API not really well designed. Users are
  54.  * encouraged to use their own parser for series of TLE
  55.  */
  56. @Deprecated
  57. public class TLESeries implements DataLoader {

  59.     /** Default supported files name pattern. */
  60.     private static final String DEFAULT_SUPPORTED_NAMES = ".*\\.tle$";

  62.     /** Regular expression for supported files names. */
  63.     private final String supportedNames;

  65.     /** Available satellite numbers. */
  66.     private final Set<Integer> availableSatNums;

  68.     /** Set containing all TLE entries. */
  69.     private final SortedSet<TimeStamped> tles;

  71.     /** Satellite number used for filtering. */
  72.     private int filterSatelliteNumber;

  74.     /** Launch year used for filtering (all digits). */
  75.     private int filterLaunchYear;

  77.     /** Launch number used for filtering. */
  78.     private int filterLaunchNumber;

  80.     /** Launch piece used for filtering. */
  81.     private String filterLaunchPiece;

  83.     /** Previous TLE in the cached selection. */
  84.     private TLE previous;

  86.     /** Next TLE in the cached selection. */
  87.     private TLE next;

  89.     /** Last used TLE. */
  90.     private TLE lastTLE;

  92.     /** Associated propagator. */
  93.     private TLEPropagator lastPropagator;

  95.     /** Date of the first TLE. */
  96.     private AbsoluteDate firstDate;

  98.     /** Date of the last TLE. */
  99.     private AbsoluteDate lastDate;

  101.     /** Indicator for non-TLE extra lines. */
  102.     private final boolean ignoreNonTLELines;

  104.     /** Simple constructor with a TLE file.
  105.      * <p>This constructor does not load any data by itself. Data must be
  106.      * loaded later on by calling one of the {@link #loadTLEData()
  107.      * loadTLEData()} method, the {@link #loadTLEData(int)
  108.      * loadTLEData(filterSatelliteNumber)} method or the {@link #loadTLEData(int,
  109.      * int, String) loadTLEData(filterLaunchYear, filterLaunchNumber, filterLaunchPiece)} method.<p>
  110.      * @param supportedNames regular expression for supported files names
  111.      * (if null, a default pattern matching files with a ".tle" extension will be used)
  112.      * @param ignoreNonTLELines if true, extra non-TLE lines are silently ignored,
  113.      * if false an exception will be generated when such lines are encountered
  114.      * @see #loadTLEData()
  115.      * @see #loadTLEData(int)
  116.      * @see #loadTLEData(int, int, String)
  117.      */
  118.     public TLESeries(final String supportedNames, final boolean ignoreNonTLELines) {

  120.         this.supportedNames    = (supportedNames == null) ? DEFAULT_SUPPORTED_NAMES : supportedNames;
  121.         availableSatNums       = new TreeSet<Integer>();
  122.         this.ignoreNonTLELines = ignoreNonTLELines;
  123.         filterSatelliteNumber  = -1;
  124.         filterLaunchYear       = -1;
  125.         filterLaunchNumber     = -1;
  126.         filterLaunchPiece      = null;

  128.         tles     = new TreeSet<TimeStamped>(new ChronologicalComparator());
  129.         previous = null;
  130.         next     = null;

  132.     }

  134.     /** Load TLE data for a specified object.
  135.      * <p>The TLE data already loaded in the instance will be discarded
  136.      * and replaced by the newly loaded data.</p>
  137.      * <p>The filtering values will be automatically set to the first loaded
  138.      * satellite. This feature is useful when the satellite selection is
  139.      * already set up by either the instance configuration (supported file
  140.      * names) or by the {@link DataProvidersManager data providers manager}
  141.      * configuration and the local filtering feature provided here can be ignored.</p>
  142.      * @exception OrekitException if some data can't be read, some
  143.      * file content is corrupted or no TLE data is available
  144.      * @see #loadTLEData(int)
  145.      * @see #loadTLEData(int, int, String)
  146.      */
  147.     public void loadTLEData() throws OrekitException {

  149.         availableSatNums.clear();

  151.         // set the filtering parameters
  152.         filterSatelliteNumber = -1;
  153.         filterLaunchYear      = -1;
  154.         filterLaunchNumber    = -1;
  155.         filterLaunchPiece     = null;

  157.         // load the data from the configured data providers
  158.         tles.clear();
  159.         previous = null;
  160.         next     = null;
  161.         DataProvidersManager.getInstance().feed(supportedNames, this);
  162.         if (tles.isEmpty()) {
  163.             throw new OrekitException(OrekitMessages.NO_TLE_DATA_AVAILABLE);
  164.         }

  166.     }

  168.     /** Get the available satellite numbers.
  169.      * @return available satellite numbers
  170.      * @throws OrekitException if some data can't be read, some
  171.      * file content is corrupted or no TLE data is available
  172.      */
  173.     public Set<Integer> getAvailableSatelliteNumbers() throws OrekitException {
  174.         if (availableSatNums.isEmpty()) {
  175.             loadTLEData();
  176.         }
  177.         return availableSatNums;
  178.     }

  180.     /** Load TLE data for a specified object.
  181.      * <p>The TLE data already loaded in the instance will be discarded
  182.      * and replaced by the newly loaded data.</p>
  183.      * <p>Calling this method with the satellite number set to a negative value,
  184.      * is equivalent to call {@link #loadTLEData()}.</p>
  185.      * @param satelliteNumber satellite number
  186.      * @exception OrekitException if some data can't be read, some
  187.      * file content is corrupted or no TLE data is available for the selected object
  188.      * @see #loadTLEData()
  189.      * @see #loadTLEData(int, int, String)
  190.      */
  191.     public void loadTLEData(final int satelliteNumber) throws OrekitException {

  193.         if (satelliteNumber < 0) {
  194.             // no filtering at all
  195.             loadTLEData();
  196.         } else {
  197.             // set the filtering parameters
  198.             filterSatelliteNumber = satelliteNumber;
  199.             filterLaunchYear      = -1;
  200.             filterLaunchNumber    = -1;
  201.             filterLaunchPiece     = null;

  203.             // load the data from the configured data providers
  204.             tles.clear();
  205.             previous = null;
  206.             next     = null;
  207.             DataProvidersManager.getInstance().feed(supportedNames, this);
  208.             if (tles.isEmpty()) {
  209.                 throw new OrekitException(OrekitMessages.NO_TLE_FOR_OBJECT, satelliteNumber);
  210.             }
  211.         }

  213.     }

  215.     /** Load TLE data for a specified object.
  216.      * <p>The TLE data already loaded in the instance will be discarded
  217.      * and replaced by the newly loaded data.</p>
  218.      * <p>Calling this method with either the launch year or the launch number
  219.      * set to a negative value, or the launch piece set to null or an empty
  220.      * string are all equivalent to call {@link #loadTLEData()}.</p>
  221.      * @param launchYear launch year (all digits)
  222.      * @param launchNumber launch number
  223.      * @param launchPiece launch piece
  224.      * @exception OrekitException if some data can't be read, some
  225.      * file content is corrupted or no TLE data is available for the selected object
  226.      * @see #loadTLEData()
  227.      * @see #loadTLEData(int)
  228.      */
  229.     public void loadTLEData(final int launchYear, final int launchNumber,
  230.                             final String launchPiece) throws OrekitException {

  232.         if ((launchYear < 0) || (launchNumber < 0) ||
  233.             (launchPiece == null) || (launchPiece.length() == 0)) {
  234.             // no filtering at all
  235.             loadTLEData();
  236.         } else {
  237.             // set the filtering parameters
  238.             filterSatelliteNumber = -1;
  239.             filterLaunchYear      = launchYear;
  240.             filterLaunchNumber    = launchNumber;
  241.             filterLaunchPiece     = launchPiece;

  243.             // load the data from the configured data providers
  244.             tles.clear();
  245.             previous = null;
  246.             next     = null;
  247.             DataProvidersManager.getInstance().feed(supportedNames, this);
  248.             if (tles.isEmpty()) {
  249.                 throw new OrekitException(OrekitMessages.NO_TLE_FOR_LAUNCH_YEAR_NUMBER_PIECE,
  250.                                           launchYear, launchNumber, launchPiece);
  251.             }
  252.         }

  254.     }

  256.     /** {@inheritDoc} */
  257.     public boolean stillAcceptsData() {
  258.         return tles.isEmpty();
  259.     }

  261.     /** {@inheritDoc} */
  262.     public void loadData(final InputStream input, final String name)
  263.         throws IOException, OrekitException {

  265.         final BufferedReader r = new BufferedReader(new InputStreamReader(input, "UTF-8"));
  266.         try {

  268.             int lineNumber     = 0;
  269.             String pendingLine = null;
  270.             for (String line = r.readLine(); line != null; line = r.readLine()) {

  272.                 ++lineNumber;

  274.                 if (pendingLine == null) {

  276.                     // we must wait for the second line
  277.                     pendingLine = line;

  279.                 } else {

  281.                     // safety checks
  282.                     if (!TLE.isFormatOK(pendingLine, line)) {
  283.                         if (ignoreNonTLELines) {
  284.                             // just shift one line
  285.                             pendingLine = line;
  286.                             continue;
  287.                         } else {
  288.                             throw new OrekitException(OrekitMessages.NOT_TLE_LINES,
  289.                                                       lineNumber - 1, lineNumber, pendingLine, line);
  290.                         }
  291.                     }

  293.                     final TLE tle = new TLE(pendingLine, line);

  295.                     if (filterSatelliteNumber < 0) {
  296.                         if ((filterLaunchYear < 0) ||
  297.                             ((tle.getLaunchYear()   == filterLaunchYear) &&
  298.                              (tle.getLaunchNumber() == filterLaunchNumber) &&
  299.                              tle.getLaunchPiece().equals(filterLaunchPiece))) {
  300.                             // we now know the number of the object to load
  301.                             filterSatelliteNumber = tle.getSatelliteNumber();
  302.                         }
  303.                     }

  305.                     availableSatNums.add(tle.getSatelliteNumber());

  307.                     if (tle.getSatelliteNumber() == filterSatelliteNumber) {
  308.                         // accept this TLE
  309.                         tles.add(tle);
  310.                     }

  312.                     // we need to wait for two new lines
  313.                     pendingLine = null;

  315.                 }

  317.             }

  319.             if ((pendingLine != null) && !ignoreNonTLELines) {
  320.                 // there is an unexpected last line
  321.                 throw new OrekitException(OrekitMessages.MISSING_SECOND_TLE_LINE,
  322.                                           lineNumber, pendingLine);
  323.             }

  325.         } finally {
  326.             r.close();
  327.         }

  329.     }

  331.     /** Get the extrapolated position and velocity from an initial date.
  332.      * For a good precision, this date should not be too far from the range :
  333.      * [{@link #getFirstDate() first date} ; {@link #getLastDate() last date}].
  334.      * @param date the final date
  335.      * @return the final PVCoordinates
  336.      * @exception OrekitException if the underlying propagator cannot be initialized
  337.      */
  338.     public PVCoordinates getPVCoordinates(final AbsoluteDate date)
  339.         throws OrekitException {
  340.         final TLE toExtrapolate = getClosestTLE(date);
  341.         if (toExtrapolate != lastTLE) {
  342.             lastTLE = toExtrapolate;
  343.             lastPropagator = TLEPropagator.selectExtrapolator(lastTLE);
  344.         }
  345.         return lastPropagator.getPVCoordinates(date);
  346.     }

  348.     /** Get the closest TLE to the selected date.
  349.      * @param date the date
  350.      * @return the TLE that will suit the most for propagation.
  351.      */
  352.     public TLE getClosestTLE(final AbsoluteDate date) {

  354.         //  don't search if the cached selection is fine
  355.         if ((previous != null) && (date.durationFrom(previous.getDate()) >= 0) &&
  356.             (next     != null) && (date.durationFrom(next.getDate())     <= 0)) {
  357.             // the current selection is already good
  358.             if (next.getDate().durationFrom(date) > date.durationFrom(previous.getDate())) {
  359.                 return previous;
  360.             } else {
  361.                 return next;
  362.             }
  363.         }
  364.         // reset the selection before the search phase
  365.         previous  = null;
  366.         next      = null;
  367.         final SortedSet<TimeStamped> headSet = tles.headSet(date);
  368.         final SortedSet<TimeStamped> tailSet = tles.tailSet(date);


  371.         if (headSet.isEmpty()) {
  372.             return (TLE) tailSet.first();
  373.         }
  374.         if (tailSet.isEmpty()) {
  375.             return (TLE) headSet.last();
  376.         }
  377.         previous = (TLE) headSet.last();
  378.         next = (TLE) tailSet.first();

  380.         if (next.getDate().durationFrom(date) > date.durationFrom(previous.getDate())) {
  381.             return previous;
  382.         } else {
  383.             return next;
  384.         }
  385.     }

  387.     /** Get the start date of the series.
  388.      * @return the first date
  389.      */
  390.     public AbsoluteDate getFirstDate() {
  391.         if (firstDate == null) {
  392.             firstDate = tles.first().getDate();
  393.         }
  394.         return firstDate;
  395.     }

  397.     /** Get the last date of the series.
  398.      * @return the end date
  399.      */
  400.     public AbsoluteDate getLastDate() {
  401.         if (lastDate == null) {
  402.             lastDate = tles.last().getDate();
  403.         }
  404.         return lastDate;
  405.     }

  407.     /** Get the first TLE.
  408.      * @return first TLE
  409.      */
  410.     public TLE getFirst() {
  411.         return (TLE) tles.first();
  412.     }

  414.     /** Get the last TLE.
  415.      * @return last TLE
  416.      */
  417.     public TLE getLast() {
  418.         return (TLE) tles.last();
  419.     }

  421. }
Created with JaCoCo 0.7.9.201702052155