ODMParser.java

  1. /* Copyright 2002-2019 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.files.ccsds;

  19. import java.io.FileInputStream;
  20. import java.io.IOException;
  21. import java.io.InputStream;
  22. import java.util.List;
  23. import java.util.regex.Matcher;
  24. import java.util.regex.Pattern;

  26. import org.hipparchus.util.FastMath;
  27. import org.orekit.errors.OrekitException;
  28. import org.orekit.errors.OrekitMessages;
  29. import org.orekit.time.AbsoluteDate;
  30. import org.orekit.time.TimeScalesFactory;
  31. import org.orekit.utils.IERSConventions;

  33. /**
  34.  * Base class for all CCSDS Orbit Data Message parsers.
  35.  *
  36.  * <p> This base class is immutable, and hence thread safe. When parts must be
  37.  * changed, such as reference date for Mission Elapsed Time or Mission Relative
  38.  * Time time systems, or the gravitational coefficient or the IERS conventions,
  39.  * the various {@code withXxx} methods must be called, which create a new
  40.  * immutable instance with the new parameters. This is a combination of the <a
  41.  * href="https://en.wikipedia.org/wiki/Builder_pattern">builder design
  42.  * pattern</a> and a <a href="http://en.wikipedia.org/wiki/Fluent_interface">fluent
  43.  * interface</a>.
  44.  *
  45.  * @author Luc Maisonobe
  46.  * @since 6.1
  47.  */
  48. public abstract class ODMParser {

  50.     /** Pattern for international designator. */
  51.     private static final Pattern INTERNATIONAL_DESIGNATOR = Pattern.compile("(\\p{Digit}{4})-(\\p{Digit}{3})(\\p{Upper}{1,3})");

  53.     /** Reference date for Mission Elapsed Time or Mission Relative Time time systems. */
  54.     private final AbsoluteDate missionReferenceDate;

  56.     /** Gravitational coefficient. */
  57.     private final  double mu;

  59.     /** IERS Conventions. */
  60.     private final  IERSConventions conventions;

  62.     /** Indicator for simple or accurate EOP interpolation. */
  63.     private final  boolean simpleEOP;

  65.     /** Launch Year. */
  66.     private int launchYear;

  68.     /** Launch number. */
  69.     private int launchNumber;

  71.     /** Piece of launch (from "A" to "ZZZ"). */
  72.     private String launchPiece;

  74.     /** Complete constructor.
  75.      * @param missionReferenceDate reference date for Mission Elapsed Time or Mission Relative Time time systems
  76.      * @param mu gravitational coefficient
  77.      * @param conventions IERS Conventions
  78.      * @param simpleEOP if true, tidal effects are ignored when interpolating EOP
  79.      * @param launchYear launch year for TLEs
  80.      * @param launchNumber launch number for TLEs
  81.      * @param launchPiece piece of launch (from "A" to "ZZZ") for TLEs
  82.      */
  83.     protected ODMParser(final AbsoluteDate missionReferenceDate, final double mu,
  84.                         final IERSConventions conventions, final boolean simpleEOP,
  85.                         final int launchYear, final int launchNumber, final String launchPiece) {
  86.         this.missionReferenceDate = missionReferenceDate;
  87.         this.mu                   = mu;
  88.         this.conventions          = conventions;
  89.         this.simpleEOP            = simpleEOP;
  90.         this.launchYear           = launchYear;
  91.         this.launchNumber         = launchNumber;
  92.         this.launchPiece          = launchPiece;
  93.     }

  95.     /** Set initial date.
  96.      * @param newMissionReferenceDate mission reference date to use while parsing
  97.      * @return a new instance, with mission reference date replaced
  98.      * @see #getMissionReferenceDate()
  99.      */
  100.     public abstract ODMParser withMissionReferenceDate(AbsoluteDate newMissionReferenceDate);

  102.     /** Get initial date.
  103.      * @return mission reference date to use while parsing
  104.      * @see #withMissionReferenceDate(AbsoluteDate)
  105.      */
  106.     public AbsoluteDate getMissionReferenceDate() {
  107.         return missionReferenceDate;
  108.     }

  110.     /** Set gravitational coefficient.
  111.      * @param newMu gravitational coefficient to use while parsing
  112.      * @return a new instance, with gravitational coefficient date replaced
  113.      * @see #getMu()
  114.      */
  115.     public abstract ODMParser withMu(double newMu);

  117.     /** Get gravitational coefficient.
  118.      * @return gravitational coefficient to use while parsing
  119.      * @see #withMu(double)
  120.      */
  121.     public double getMu() {
  122.         return mu;
  123.     }

  125.     /** Set IERS conventions.
  126.      * @param newConventions IERS conventions to use while parsing
  127.      * @return a new instance, with IERS conventions replaced
  128.      * @see #getConventions()
  129.      */
  130.     public abstract ODMParser withConventions(IERSConventions newConventions);

  132.     /** Get IERS conventions.
  133.      * @return IERS conventions to use while parsing
  134.      * @see #withConventions(IERSConventions)
  135.      */
  136.     public IERSConventions getConventions() {
  137.         return conventions;
  138.     }

  140.     /** Set EOP interpolation method.
  141.      * @param newSimpleEOP if true, tidal effects are ignored when interpolating EOP
  142.      * @return a new instance, with EOP interpolation method replaced
  143.      * @see #isSimpleEOP()
  144.      */
  145.     public abstract ODMParser withSimpleEOP(boolean newSimpleEOP);

  147.     /** Get EOP interpolation method.
  148.      * @return true if tidal effects are ignored when interpolating EOP
  149.      * @see #withSimpleEOP(boolean)
  150.      */
  151.     public boolean isSimpleEOP() {
  152.         return simpleEOP;
  153.     }

  155.     /** Set international designator.
  156.      * <p>
  157.      * This method may be used to ensure the launch year number and pieces are
  158.      * correctly set if they are not present in the CCSDS file header in the
  159.      * OBJECT_ID in the form YYYY-NNN-P{PP}. If they are already in the header,
  160.      * they will be parsed automatically regardless of this method being called
  161.      * or not (i.e. header information override information set here).
  162.      * </p>
  163.      * @param newLaunchYear launch year
  164.      * @param newLaunchNumber launch number
  165.      * @param newLaunchPiece piece of launch (from "A" to "ZZZ")
  166.      * @return a new instance, with TLE settings replaced
  167.      */
  168.     public abstract ODMParser withInternationalDesignator(int newLaunchYear,
  169.                                                           int newLaunchNumber,
  170.                                                           String newLaunchPiece);

  172.     /** Get the launch year.
  173.      * @return launch year
  174.      */
  175.     public int getLaunchYear() {
  176.         return launchYear;
  177.     }

  179.     /** Get the launch number.
  180.      * @return launch number
  181.      */
  182.     public int getLaunchNumber() {
  183.         return launchNumber;
  184.     }

  186.     /** Get the piece of launch.
  187.      * @return piece of launch
  188.      */
  189.     public String getLaunchPiece() {
  190.         return launchPiece;
  191.     }

  193.     /** Parse a CCSDS Orbit Data Message.
  194.      * @param fileName name of the file containing the message
  195.      * @return parsed orbit
  196.      */
  197.     public ODMFile parse(final String fileName) {
  198.         try (InputStream stream = new FileInputStream(fileName)) {
  199.             return parse(stream, fileName);
  200.         } catch (IOException e) {
  201.             throw new OrekitException(OrekitMessages.UNABLE_TO_FIND_FILE, fileName);
  202.         }
  203.     }

  205.     /** Parse a CCSDS Orbit Data Message.
  206.      * @param stream stream containing message
  207.      * @return parsed orbit
  208.      */
  209.     public ODMFile parse(final InputStream stream) {
  210.         return parse(stream, "<unknown>");
  211.     }

  213.     /** Parse a CCSDS Orbit Data Message.
  214.      * @param stream stream containing message
  215.      * @param fileName name of the file containing the message (for error messages)
  216.      * @return parsed orbit
  217.      */
  218.     public abstract ODMFile parse(InputStream stream, String fileName);

  220.     /** Parse a comment line.
  221.      * @param keyValue key=value pair containing the comment
  222.      * @param comment placeholder where the current comment line should be added
  223.      * @return true if the line was a comment line and was parsed
  224.      */
  225.     protected boolean parseComment(final KeyValue keyValue, final List<String> comment) {
  226.         if (keyValue.getKeyword() == Keyword.COMMENT) {
  227.             comment.add(keyValue.getValue());
  228.             return true;
  229.         } else {
  230.             return false;
  231.         }
  232.     }

  234.     /** Parse an entry from the header.
  235.      * @param keyValue key = value pair
  236.      * @param odmFile instance to update with parsed entry
  237.      * @param comment previous comment lines, will be emptied if used by the keyword
  238.      * @return true if the keyword was a header keyword and has been parsed
  239.      */
  240.     protected boolean parseHeaderEntry(final KeyValue keyValue,
  241.                                        final ODMFile odmFile, final List<String> comment) {
  242.         switch (keyValue.getKeyword()) {

  244.             case CREATION_DATE:
  245.                 if (!comment.isEmpty()) {
  246.                     odmFile.setHeaderComment(comment);
  247.                     comment.clear();
  248.                 }
  249.                 odmFile.setCreationDate(new AbsoluteDate(keyValue.getValue(), TimeScalesFactory.getUTC()));
  250.                 return true;

  252.             case ORIGINATOR:
  253.                 odmFile.setOriginator(keyValue.getValue());
  254.                 return true;

  256.             default:
  257.                 return false;

  259.         }

  261.     }

  263.     /** Parse a meta-data key = value entry.
  264.      * @param keyValue key = value pair
  265.      * @param metaData instance to update with parsed entry
  266.      * @param comment previous comment lines, will be emptied if used by the keyword
  267.      * @return true if the keyword was a meta-data keyword and has been parsed
  268.      */
  269.     protected boolean parseMetaDataEntry(final KeyValue keyValue,
  270.                                          final ODMMetaData metaData, final List<String> comment) {
  271.         switch (keyValue.getKeyword()) {
  272.             case OBJECT_NAME:
  273.                 if (!comment.isEmpty()) {
  274.                     metaData.setComment(comment);
  275.                     comment.clear();
  276.                 }
  277.                 metaData.setObjectName(keyValue.getValue());
  278.                 return true;

  280.             case OBJECT_ID: {
  281.                 metaData.setObjectID(keyValue.getValue());
  282.                 final Matcher matcher = INTERNATIONAL_DESIGNATOR.matcher(keyValue.getValue());
  283.                 if (matcher.matches()) {
  284.                     metaData.setLaunchYear(Integer.parseInt(matcher.group(1)));
  285.                     metaData.setLaunchNumber(Integer.parseInt(matcher.group(2)));
  286.                     metaData.setLaunchPiece(matcher.group(3));
  287.                 }
  288.                 return true;
  289.             }

  291.             case CENTER_NAME:
  292.                 metaData.setCenterName(keyValue.getValue());
  293.                 final String canonicalValue;
  294.                 if (keyValue.getValue().equals("SOLAR SYSTEM BARYCENTER") || keyValue.getValue().equals("SSB")) {
  295.                     canonicalValue = "SOLAR_SYSTEM_BARYCENTER";
  296.                 } else if (keyValue.getValue().equals("EARTH MOON BARYCENTER") || keyValue.getValue().equals("EARTH-MOON BARYCENTER") ||
  297.                         keyValue.getValue().equals("EARTH BARYCENTER") || keyValue.getValue().equals("EMB")) {
  298.                     canonicalValue = "EARTH_MOON";
  299.                 } else {
  300.                     canonicalValue = keyValue.getValue();
  301.                 }
  302.                 for (final CenterName c : CenterName.values()) {
  303.                     if (c.name().equals(canonicalValue)) {
  304.                         metaData.setHasCreatableBody(true);
  305.                         metaData.setCenterBody(c.getCelestialBody());
  306.                         metaData.getODMFile().setMuCreated(c.getCelestialBody().getGM());
  307.                     }
  308.                 }
  309.                 return true;

  311.             case REF_FRAME:
  312.                 metaData.setFrameString(keyValue.getValue());
  313.                 metaData.setRefFrame(parseCCSDSFrame(keyValue.getValue()).getFrame(getConventions(), isSimpleEOP()));
  314.                 return true;

  316.             case REF_FRAME_EPOCH:
  317.                 metaData.setFrameEpochString(keyValue.getValue());
  318.                 return true;

  320.             case TIME_SYSTEM:
  321.                 if (!CcsdsTimeScale.contains(keyValue.getValue())) {
  322.                     throw new OrekitException(
  323.                             OrekitMessages.CCSDS_TIME_SYSTEM_NOT_IMPLEMENTED,
  324.                             keyValue.getValue());
  325.                 }
  326.                 final CcsdsTimeScale timeSystem =
  327.                         CcsdsTimeScale.valueOf(keyValue.getValue());
  328.                 metaData.setTimeSystem(timeSystem);
  329.                 if (metaData.getFrameEpochString() != null) {
  330.                     metaData.setFrameEpoch(parseDate(metaData.getFrameEpochString(), timeSystem));
  331.                 }
  332.                 return true;

  334.             default:
  335.                 return false;
  336.         }
  337.     }

  339.     /** Parse a general state data key = value entry.
  340.      * @param keyValue key = value pair
  341.      * @param general instance to update with parsed entry
  342.      * @param comment previous comment lines, will be emptied if used by the keyword
  343.      * @return true if the keyword was a meta-data keyword and has been parsed
  344.      */
  345.     protected boolean parseGeneralStateDataEntry(final KeyValue keyValue,
  346.                                                  final OGMFile general, final List<String> comment) {
  347.         switch (keyValue.getKeyword()) {

  349.             case EPOCH:
  350.                 general.setEpochComment(comment);
  351.                 comment.clear();
  352.                 general.setEpoch(parseDate(keyValue.getValue(), general.getMetaData().getTimeSystem()));
  353.                 return true;

  355.             case SEMI_MAJOR_AXIS:
  356.                 general.setKeplerianElementsComment(comment);
  357.                 comment.clear();
  358.                 general.setA(keyValue.getDoubleValue() * 1000);
  359.                 general.setHasKeplerianElements(true);
  360.                 return true;

  362.             case ECCENTRICITY:
  363.                 general.setE(keyValue.getDoubleValue());
  364.                 return true;

  366.             case INCLINATION:
  367.                 general.setI(FastMath.toRadians(keyValue.getDoubleValue()));
  368.                 return true;

  370.             case RA_OF_ASC_NODE:
  371.                 general.setRaan(FastMath.toRadians(keyValue.getDoubleValue()));
  372.                 return true;

  374.             case ARG_OF_PERICENTER:
  375.                 general.setPa(FastMath.toRadians(keyValue.getDoubleValue()));
  376.                 return true;

  378.             case TRUE_ANOMALY:
  379.                 general.setAnomalyType("TRUE");
  380.                 general.setAnomaly(FastMath.toRadians(keyValue.getDoubleValue()));
  381.                 return true;

  383.             case MEAN_ANOMALY:
  384.                 general.setAnomalyType("MEAN");
  385.                 general.setAnomaly(FastMath.toRadians(keyValue.getDoubleValue()));
  386.                 return true;

  388.             case GM:
  389.                 general.setMuParsed(keyValue.getDoubleValue() * 1e9);
  390.                 return true;

  392.             case MASS:
  393.                 comment.addAll(0, general.getSpacecraftComment());
  394.                 general.setSpacecraftComment(comment);
  395.                 comment.clear();
  396.                 general.setMass(keyValue.getDoubleValue());
  397.                 return true;

  399.             case SOLAR_RAD_AREA:
  400.                 comment.addAll(0, general.getSpacecraftComment());
  401.                 general.setSpacecraftComment(comment);
  402.                 comment.clear();
  403.                 general.setSolarRadArea(keyValue.getDoubleValue());
  404.                 return true;

  406.             case SOLAR_RAD_COEFF:
  407.                 comment.addAll(0, general.getSpacecraftComment());
  408.                 general.setSpacecraftComment(comment);
  409.                 comment.clear();
  410.                 general.setSolarRadCoeff(keyValue.getDoubleValue());
  411.                 return true;

  413.             case DRAG_AREA:
  414.                 comment.addAll(0, general.getSpacecraftComment());
  415.                 general.setSpacecraftComment(comment);
  416.                 comment.clear();
  417.                 general.setDragArea(keyValue.getDoubleValue());
  418.                 return true;

  420.             case DRAG_COEFF:
  421.                 comment.addAll(0, general.getSpacecraftComment());
  422.                 general.setSpacecraftComment(comment);
  423.                 comment.clear();
  424.                 general.setDragCoeff(keyValue.getDoubleValue());
  425.                 return true;

  427.             case COV_REF_FRAME:
  428.                 general.setCovarianceComment(comment);
  429.                 comment.clear();
  430.                 final CCSDSFrame covFrame = parseCCSDSFrame(keyValue.getValue());
  431.                 if (covFrame.isLof()) {
  432.                     general.setCovRefLofType(covFrame.getLofType());
  433.                 } else {
  434.                     general.setCovRefFrame(covFrame.getFrame(getConventions(), isSimpleEOP()));
  435.                 }
  436.                 return true;

  438.             case CX_X:
  439.                 general.createCovarianceMatrix();
  440.                 general.setCovarianceMatrixEntry(0, 0, keyValue.getDoubleValue() * 1.0e6);
  441.                 return true;

  443.             case CY_X:
  444.                 general.setCovarianceMatrixEntry(0, 1, keyValue.getDoubleValue() * 1.0e6);
  445.                 return true;

  447.             case CY_Y:
  448.                 general.setCovarianceMatrixEntry(1, 1, keyValue.getDoubleValue() * 1.0e6);
  449.                 return true;

  451.             case CZ_X:
  452.                 general.setCovarianceMatrixEntry(0, 2, keyValue.getDoubleValue() * 1.0e6);
  453.                 return true;

  455.             case CZ_Y:
  456.                 general.setCovarianceMatrixEntry(1, 2, keyValue.getDoubleValue() * 1.0e6);
  457.                 return true;

  459.             case CZ_Z:
  460.                 general.setCovarianceMatrixEntry(2, 2, keyValue.getDoubleValue() * 1.0e6);
  461.                 return true;

  463.             case CX_DOT_X:
  464.                 general.setCovarianceMatrixEntry(0, 3, keyValue.getDoubleValue() * 1.0e6);
  465.                 return true;

  467.             case CX_DOT_Y:
  468.                 general.setCovarianceMatrixEntry(1, 3, keyValue.getDoubleValue() * 1.0e6);
  469.                 return true;

  471.             case CX_DOT_Z:
  472.                 general.setCovarianceMatrixEntry(2, 3, keyValue.getDoubleValue() * 1.0e6);
  473.                 return true;

  475.             case CX_DOT_X_DOT:
  476.                 general.setCovarianceMatrixEntry(3, 3, keyValue.getDoubleValue() * 1.0e6);
  477.                 return true;

  479.             case CY_DOT_X:
  480.                 general.setCovarianceMatrixEntry(0, 4, keyValue.getDoubleValue() * 1.0e6);
  481.                 return true;

  483.             case CY_DOT_Y:
  484.                 general.setCovarianceMatrixEntry(1, 4, keyValue.getDoubleValue() * 1.0e6);
  485.                 return true;

  487.             case CY_DOT_Z:
  488.                 general.setCovarianceMatrixEntry(2, 4, keyValue.getDoubleValue() * 1.0e6);
  489.                 return true;

  491.             case CY_DOT_X_DOT:
  492.                 general.setCovarianceMatrixEntry(3, 4, keyValue.getDoubleValue() * 1.0e6);
  493.                 return true;

  495.             case CY_DOT_Y_DOT:
  496.                 general.setCovarianceMatrixEntry(4, 4, keyValue.getDoubleValue() * 1.0e6);
  497.                 return true;

  499.             case CZ_DOT_X:
  500.                 general.setCovarianceMatrixEntry(0, 5, keyValue.getDoubleValue() * 1.0e6);
  501.                 return true;

  503.             case CZ_DOT_Y:
  504.                 general.setCovarianceMatrixEntry(1, 5, keyValue.getDoubleValue() * 1.0e6);
  505.                 return true;

  507.             case CZ_DOT_Z:
  508.                 general.setCovarianceMatrixEntry(2, 5, keyValue.getDoubleValue() * 1.0e6);
  509.                 return true;

  511.             case CZ_DOT_X_DOT:
  512.                 general.setCovarianceMatrixEntry(3, 5, keyValue.getDoubleValue() * 1.0e6);
  513.                 return true;

  515.             case CZ_DOT_Y_DOT:
  516.                 general.setCovarianceMatrixEntry(4, 5, keyValue.getDoubleValue() * 1.0e6);
  517.                 return true;

  519.             case CZ_DOT_Z_DOT:
  520.                 general.setCovarianceMatrixEntry(5, 5, keyValue.getDoubleValue() * 1.0e6);
  521.                 return true;

  523.             case USER_DEFINED_X:
  524.                 general.setUserDefinedParameters(keyValue.getKey(), keyValue.getValue());
  525.                 return true;

  527.             default:
  528.                 return false;
  529.         }
  530.     }

  532.     /** Parse a CCSDS frame.
  533.      * @param frameName name of the frame, as the value of a CCSDS key=value line
  534.      * @return CCSDS frame corresponding to the name
  535.      */
  536.     protected CCSDSFrame parseCCSDSFrame(final String frameName) {
  537.         return CCSDSFrame.valueOf(frameName.replaceAll("-", ""));
  538.     }

  540.     /** Parse a date.
  541.      * @param date date to parse, as the value of a CCSDS key=value line
  542.      * @param timeSystem time system to use
  543.      * @return parsed date
  544.      */
  545.     protected AbsoluteDate parseDate(final String date, final CcsdsTimeScale timeSystem) {
  546.         return timeSystem.parseDate(date, conventions, missionReferenceDate);
  547.     }

  549. }
Created with JaCoCo 0.8.2.201808211720