APMParser.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.files.ccsds;

  19. import java.io.BufferedReader;
  20. import java.io.IOException;
  21. import java.io.InputStream;
  22. import java.io.InputStreamReader;
  23. import java.nio.charset.StandardCharsets;
  24. import java.util.ArrayList;
  25. import java.util.List;

  27. import org.hipparchus.complex.Quaternion;
  28. import org.hipparchus.exception.DummyLocalizable;
  29. import org.hipparchus.geometry.euclidean.threed.Vector3D;
  30. import org.orekit.annotation.DefaultDataContext;
  31. import org.orekit.data.DataContext;
  32. import org.orekit.errors.OrekitException;
  33. import org.orekit.errors.OrekitMessages;
  34. import org.orekit.time.AbsoluteDate;
  35. import org.orekit.utils.IERSConventions;

  37. /**
  38.  * A parser for the CCSDS APM (Attitude Parameter Message).
  39.  * @author Bryan Cazabonne
  40.  * @since 10.2
  41.  */
  42. public class APMParser extends ADMParser {

  44.     /** Simple constructor.
  45.      * <p>
  46.      * This class is immutable, and hence thread safe. When parts
  47.      * must be changed, such as reference date for Mission Elapsed Time or
  48.      * Mission Relative Time time systems, or the gravitational coefficient or
  49.      * the IERS conventions, the various {@code withXxx} methods must be called,
  50.      * which create a new immutable instance with the new parameters. This
  51.      * is a combination of the
  52.      * <a href="https://en.wikipedia.org/wiki/Builder_pattern">builder design
  53.      * pattern</a> and a
  54.      * <a href="http://en.wikipedia.org/wiki/Fluent_interface">fluent
  55.      * interface</a>.
  56.      * </p>
  57.      * <p>
  58.      * The initial date for Mission Elapsed Time and Mission Relative Time time systems is not set here.
  59.      * If such time systems are used, it must be initialized before parsing by calling {@link
  60.      * #withMissionReferenceDate(AbsoluteDate)}.
  61.      * </p>
  62.      *
  63.      * <p>This method uses the {@link DataContext#getDefault() default data context}. See
  64.      * {@link #withDataContext(DataContext)}.
  65.      */
  66.     @DefaultDataContext
  67.     public APMParser() {
  68.         this(DataContext.getDefault());
  69.     }

  71.     /** Constructor with data context.
  72.      * <p>
  73.      * This class is immutable, and hence thread safe. When parts
  74.      * must be changed, such as reference date for Mission Elapsed Time or
  75.      * Mission Relative Time time systems, or the gravitational coefficient or
  76.      * the IERS conventions, the various {@code withXxx} methods must be called,
  77.      * which create a new immutable instance with the new parameters. This
  78.      * is a combination of the
  79.      * <a href="https://en.wikipedia.org/wiki/Builder_pattern">builder design
  80.      * pattern</a> and a
  81.      * <a href="http://en.wikipedia.org/wiki/Fluent_interface">fluent
  82.      * interface</a>.
  83.      * </p>
  84.      * <p>
  85.      * The initial date for Mission Elapsed Time and Mission Relative Time time systems is not set here.
  86.      * If such time systems are used, it must be initialized before parsing by calling {@link
  87.      * #withMissionReferenceDate(AbsoluteDate)}.
  88.      * </p>
  89.      *
  90.      * @param dataContext used by the parser.
  91.      *
  92.      * @see #APMParser()
  93.      * @see #withDataContext(DataContext)
  94.      */
  95.     public APMParser(final DataContext dataContext) {
  96.         this(AbsoluteDate.FUTURE_INFINITY, Double.NaN, null, true, 0, 0, "", dataContext);
  97.     }

  99.     /** Complete constructor.
  100.      * @param missionReferenceDate reference date for Mission Elapsed Time or Mission Relative Time time systems
  101.      * @param mu gravitational coefficient
  102.      * @param conventions IERS Conventions
  103.      * @param simpleEOP if true, tidal effects are ignored when interpolating EOP
  104.      * @param launchYear launch year for TLEs
  105.      * @param launchNumber launch number for TLEs
  106.      * @param launchPiece piece of launch (from "A" to "ZZZ") for TLEs
  107.      * @param dataContext used to retrieve frames, time scales, etc.
  108.      */
  109.     private APMParser(final AbsoluteDate missionReferenceDate, final double mu,
  110.                       final IERSConventions conventions, final boolean simpleEOP,
  111.                       final int launchYear, final int launchNumber,
  112.                       final String launchPiece, final DataContext dataContext) {
  113.         super(missionReferenceDate, mu, conventions, simpleEOP, launchYear, launchNumber,
  114.                 launchPiece, dataContext);
  115.     }

  117.     /** {@inheritDoc} */
  118.     @Override
  119.     public APMParser withMissionReferenceDate(final AbsoluteDate newMissionReferenceDate) {
  120.         return new APMParser(newMissionReferenceDate, getMu(), getConventions(), isSimpleEOP(),
  121.                              getLaunchYear(), getLaunchNumber(), getLaunchPiece(),
  122.                              getDataContext());
  123.     }

  125.     /** {@inheritDoc} */
  126.     @Override
  127.     public APMParser withMu(final double newMu) {
  128.         return new APMParser(getMissionReferenceDate(), newMu, getConventions(), isSimpleEOP(),
  129.                              getLaunchYear(), getLaunchNumber(), getLaunchPiece(),
  130.                              getDataContext());
  131.     }

  133.     /** {@inheritDoc} */
  134.     @Override
  135.     public APMParser withConventions(final IERSConventions newConventions) {
  136.         return new APMParser(getMissionReferenceDate(), getMu(), newConventions, isSimpleEOP(),
  137.                              getLaunchYear(), getLaunchNumber(), getLaunchPiece(),
  138.                              getDataContext());
  139.     }

  141.     /** {@inheritDoc} */
  142.     @Override
  143.     public APMParser withSimpleEOP(final boolean newSimpleEOP) {
  144.         return new APMParser(getMissionReferenceDate(), getMu(), getConventions(), newSimpleEOP,
  145.                              getLaunchYear(), getLaunchNumber(), getLaunchPiece(),
  146.                              getDataContext());
  147.     }

  149.     /** {@inheritDoc} */
  150.     @Override
  151.     public APMParser withInternationalDesignator(final int newLaunchYear,
  152.                                                  final int newLaunchNumber,
  153.                                                  final String newLaunchPiece) {
  154.         return new APMParser(getMissionReferenceDate(), getMu(), getConventions(), isSimpleEOP(),
  155.                              newLaunchYear, newLaunchNumber, newLaunchPiece,
  156.                              getDataContext());
  157.     }

  159.     /** {@inheritDoc} */
  160.     @Override
  161.     public APMParser withDataContext(final DataContext dataContext) {
  162.         return new APMParser(getMissionReferenceDate(), getMu(), getConventions(), isSimpleEOP(),
  163.                 getLaunchYear(), getLaunchNumber(), getLaunchPiece(),
  164.                 dataContext);
  165.     }

  167.     /** {@inheritDoc} */
  168.     @Override
  169.     public APMFile parse(final String fileName) {
  170.         return (APMFile) super.parse(fileName);
  171.     }

  173.     /** {@inheritDoc} */
  174.     @Override
  175.     public APMFile parse(final InputStream stream) {
  176.         return (APMFile) super.parse(stream);
  177.     }

  179.     /** {@inheritDoc} */
  180.     @Override
  181.     public APMFile parse(final InputStream stream, final String fileName) {
  182.         try (BufferedReader reader = new BufferedReader(new InputStreamReader(stream, StandardCharsets.UTF_8))) {

  184.             // initialize internal data structures
  185.             final ParseInfo pi = new ParseInfo();
  186.             pi.fileName = fileName;
  187.             final APMFile file = pi.file;

  189.             // set the additional data that has been configured prior the parsing by the user.
  190.             pi.file.setMissionReferenceDate(getMissionReferenceDate());
  191.             pi.file.setMu(getMu());
  192.             pi.file.setConventions(getConventions());
  193.             pi.file.setDataContext(getDataContext());
  194.             pi.file.getMetaData().setLaunchYear(getLaunchYear());
  195.             pi.file.getMetaData().setLaunchNumber(getLaunchNumber());
  196.             pi.file.getMetaData().setLaunchPiece(getLaunchPiece());

  198.             for (String line = reader.readLine(); line != null; line = reader.readLine()) {
  199.                 ++pi.lineNumber;
  200.                 if (line.trim().length() == 0) {
  201.                     // Blank line
  202.                     continue;
  203.                 }
  204.                 pi.keyValue = new KeyValue(line, pi.lineNumber, pi.fileName);
  205.                 if (pi.keyValue.getKeyword() == null) {
  206.                     // Unexpected keyword. An exception is thrown.
  207.                     throw new OrekitException(OrekitMessages.CCSDS_UNEXPECTED_KEYWORD, pi.lineNumber, pi.fileName, line);
  208.                 }

  210.                 switch (pi.keyValue.getKeyword()) {

  212.                     case CCSDS_APM_VERS:
  213.                         file.setFormatVersion(pi.keyValue.getDoubleValue());
  214.                         break;

  216.                     case Q_FRAME_A:
  217.                         file.setQuaternionFrameAString(pi.keyValue.getValue());
  218.                         break;

  220.                     case Q_FRAME_B:
  221.                         file.setQuaternionFrameBString(pi.keyValue.getValue());
  222.                         break;

  224.                     case Q_DIR:
  225.                         file.setAttitudeQuaternionDirection(pi.keyValue.getValue());
  226.                         break;

  228.                     case QC:
  229.                         pi.q0 = pi.keyValue.getDoubleValue();
  230.                         break;

  232.                     case Q1:
  233.                         pi.q1 = pi.keyValue.getDoubleValue();
  234.                         break;

  236.                     case Q2:
  237.                         pi.q2 = pi.keyValue.getDoubleValue();
  238.                         break;

  240.                     case Q3:
  241.                         pi.q3 = pi.keyValue.getDoubleValue();
  242.                         break;

  244.                     case MAN_EPOCH_START:
  245.                         if (pi.maneuver != null) {
  246.                             file.addManeuver(pi.maneuver);
  247.                         }
  248.                         pi.maneuver = new APMFile.APMManeuver();
  249.                         pi.maneuver.setEpochStart(parseDate(pi.keyValue.getValue(), file.getMetaData().getTimeSystem()));
  250.                         if (!pi.commentTmp.isEmpty()) {
  251.                             pi.maneuver.setComment(pi.commentTmp);
  252.                             pi.commentTmp.clear();
  253.                         }
  254.                         break;

  256.                     case MAN_DURATION:
  257.                         pi.maneuver.setDuration(pi.keyValue.getDoubleValue());
  258.                         break;

  260.                     case MAN_REF_FRAME:
  261.                         pi.maneuver.setRefFrameString(pi.keyValue.getValue());
  262.                         break;

  264.                     case MAN_TOR_1:
  265.                         pi.maneuver.setTorque(new Vector3D(pi.keyValue.getDoubleValue(),
  266.                                                            pi.maneuver.getTorque().getY(),
  267.                                                            pi.maneuver.getTorque().getZ()));
  268.                         break;

  270.                     case MAN_TOR_2:
  271.                         pi.maneuver.setTorque(new Vector3D(pi.maneuver.getTorque().getX(),
  272.                                                            pi.keyValue.getDoubleValue(),
  273.                                                            pi.maneuver.getTorque().getZ()));
  274.                         break;

  276.                     case MAN_TOR_3:
  277.                         pi.maneuver.setTorque(new Vector3D(pi.maneuver.getTorque().getX(),
  278.                                                            pi.maneuver.getTorque().getY(),
  279.                                                            pi.keyValue.getDoubleValue()));
  280.                         break;

  282.                     default:
  283.                         boolean parsed = false;
  284.                         parsed = parsed || parseComment(pi.keyValue, pi.commentTmp);
  285.                         parsed = parsed || parseHeaderEntry(pi.keyValue, file, pi.commentTmp);
  286.                         parsed = parsed || parseMetaDataEntry(pi.keyValue, file.getMetaData(), pi.commentTmp);
  287.                         parsed = parsed || parseGeneralStateDataEntry(pi.keyValue, file, pi.commentTmp);
  288.                         if (!parsed) {
  289.                             throw new OrekitException(OrekitMessages.CCSDS_UNEXPECTED_KEYWORD, pi.lineNumber, pi.fileName, line);
  290.                         }

  292.                 }

  294.             }

  296.             file.setQuaternion(new Quaternion(pi.q0, pi.q1, pi.q2, pi.q3));
  297.             if (pi.maneuver != null) {
  298.                 file.addManeuver(pi.maneuver);
  299.             }
  300.             return file;

  302.         } catch (IOException ioe) {
  303.             throw new OrekitException(ioe, new DummyLocalizable(ioe.getMessage()));
  304.         }
  305.     }

  307.     /** Private class used to stock APM parsing info. */
  308.     private static class ParseInfo {

  310.         /** APM file being read. */
  311.         private APMFile file;

  313.         /** Name of the file. */
  314.         private String fileName;

  316.         /** Current line number. */
  317.         private int lineNumber;

  319.         /** Key value of the line being read. */
  320.         private KeyValue keyValue;

  322.         /** Stored comments. */
  323.         private List<String> commentTmp;

  325.         /** Scalar coordinate of the quaternion. */
  326.         private double q0;

  328.         /** First component of the quaternion vector. */
  329.         private double q1;

  331.         /** Second component of the quaternion vector.. */
  332.         private double q2;

  334.         /** Third component of the quaternion vector.. */
  335.         private double q3;

  337.         /** Current maneuver. */
  338.         private APMFile.APMManeuver maneuver;

  340.         /** Create a new {@link ParseInfo} object. */
  341.         protected ParseInfo() {
  342.             file       = new APMFile();
  343.             lineNumber = 0;
  344.             commentTmp = new ArrayList<String>();
  345.             maneuver   = null;
  346.         }
  347.     }

  349. }
Created with JaCoCo 0.8.6.202009150832