OGMFile.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.  */

  18. package org.orekit.files.ccsds;

  20. import java.util.ArrayList;
  21. import java.util.Collections;
  22. import java.util.HashMap;
  23. import java.util.List;
  24. import java.util.Map;

  26. import org.hipparchus.linear.MatrixUtils;
  27. import org.hipparchus.linear.RealMatrix;
  28. import org.orekit.errors.OrekitException;
  29. import org.orekit.errors.OrekitMessages;
  30. import org.orekit.frames.Frame;
  31. import org.orekit.frames.LOFType;
  32. import org.orekit.orbits.PositionAngle;
  33. import org.orekit.time.AbsoluteDate;

  35. /** This class gathers the general state data present in both OPM and OMM files.
  36.  * <p>
  37.  * This class does not appear in the CCSDS standard, it is only a design
  38.  * feature of Orekit to reduce code duplication.
  39.  * </p>
  40.  * @author sports
  41.  * @since 6.1
  42.  */
  43. public abstract class OGMFile extends ODMFile {

  45.     /** Epoch of state vector and optional Keplerian elements. */
  46.     private AbsoluteDate epoch;

  48.     /** Orbit semi-major axis (m). */
  49.     private double a;

  51.     /** Orbit eccentricity. */
  52.     private double e;

  54.     /** Orbit inclination (rad). */
  55.     private double i;

  57.     /** Orbit right ascension of ascending node (rad). */
  58.     private double raan;

  60.     /** Orbit argument of pericenter (rad). */
  61.     private double pa;

  63.     /** Orbit anomaly (rad). */
  64.     private double anomaly;

  66.     /** Orbit anomaly type (mean or true). */
  67.     private PositionAngle anomalyType;

  69.     /** Spacecraft mass. */
  70.     private double mass;

  72.     /** Solar radiation pressure area (m^2). */
  73.     private double solarRadArea;

  75.     /** Solar radiation pressure coefficient. */
  76.     private double solarRadCoeff;

  78.     /** Drag area (m^2). */
  79.     private double dragArea;

  81.     /** Drag coefficient. */
  82.     private double dragCoeff;

  84.     /** Coordinate system for covariance matrix, for Local Orbital Frames. */
  85.     private LOFType covRefLofType;

  87.     /** Coordinate system for covariance matrix, for absolute frames.
  88.      * If not given it is set equal to refFrame. */
  89.     private Frame covRefFrame;

  91.     /** Position/Velocity covariance matrix. */
  92.     private RealMatrix covarianceMatrix;

  94.     /** Map of user defined parameter keywords and corresponding values. */
  95.     private Map<String, String> userDefinedParameters;

  97.     /** Tests whether the OPM contains Keplerian elements data. */
  98.     private boolean hasKeplerianElements;

  100.     /** Epoch comments. The list contains a string for each line of comment. */
  101.     private List<String> epochComment;

  103.     /** Keplerian elements comments. The list contains a string for each line of comment. */
  104.     private List<String> keplerianElementsComment;

  106.     /** Spacecraft data comments. The list contains a string for each line of comment. */
  107.     private List<String> spacecraftComment;

  109.     /** Covariance matrix data comments. The list contains a string for each line of comment. */
  110.     private List<String> covarianceComment;

  112.     /** Create a new OPM file object. */
  113.     OGMFile() {
  114.         mass                     = Double.NaN;
  115.         userDefinedParameters    = new HashMap<String, String>();
  116.         epochComment             = Collections.emptyList();
  117.         keplerianElementsComment = Collections.emptyList();
  118.         spacecraftComment        = Collections.emptyList();
  119.         covarianceComment        = Collections.emptyList();
  120.     }

  122.     /** Get epoch of state vector, Keplerian elements and covariance matrix data.
  123.      * @return epoch the epoch
  124.      */
  125.     public AbsoluteDate getEpoch() {
  126.         return epoch;
  127.     }

  129.     /** Set epoch of state vector, Keplerian elements and covariance matrix data.
  130.      * @param epoch the epoch to be set
  131.      */
  132.     void setEpoch(final AbsoluteDate epoch) {
  133.         this.epoch = epoch;
  134.     }

  136.     /** Get the orbit semi-major axis.
  137.      * @return the orbit semi-major axis
  138.      */
  139.     public double getA() {
  140.         return a;
  141.     }

  143.     /** Set the orbit semi-major axis.
  144.      * @param a the semi-major axis to be set
  145.      */
  146.     void setA(final double a) {
  147.         this.a = a;
  148.     }

  150.     /** Get the orbit eccentricity.
  151.      * @return the orbit eccentricity
  152.      */
  153.     public double getE() {
  154.         return e;
  155.     }

  157.     /** Set the orbit eccentricity.
  158.      * @param e the eccentricity to be set
  159.      */
  160.     void setE(final double e) {
  161.         this.e = e;
  162.     }

  164.     /** Get the orbit inclination.
  165.      * @return the orbit inclination
  166.      */
  167.     public double getI() {
  168.         return i;
  169.     }

  171.     /**Set the orbit inclination.
  172.      * @param i the inclination to be set
  173.      */
  174.     void setI(final double i) {
  175.         this.i = i;
  176.     }

  178.     /** Get the orbit right ascension of ascending node.
  179.      * @return the orbit right ascension of ascending node
  180.      */
  181.     public double getRaan() {
  182.         return raan;
  183.     }

  185.     /** Set the orbit right ascension of ascending node.
  186.      * @param raan the right ascension of ascending node to be set
  187.      */
  188.     void setRaan(final double raan) {
  189.         this.raan = raan;
  190.     }

  192.     /** Get the orbit argument of pericenter.
  193.      * @return the orbit argument of pericenter
  194.      */
  195.     public double getPa() {
  196.         return pa;
  197.     }

  199.     /** Set the orbit argument of pericenter.
  200.      * @param pa the argument of pericenter to be set
  201.      */
  202.     void setPa(final double pa) {
  203.         this.pa = pa;
  204.     }

  206.     /** Get the orbit anomaly.
  207.      * @return the orbit anomaly
  208.      */
  209.     public double getAnomaly() {
  210.         return anomaly;
  211.     }

  213.     /** Set the orbit anomaly.
  214.      * @param anomaly the anomaly to be set
  215.      */
  216.     void setAnomaly(final double anomaly) {
  217.         this.anomaly = anomaly;
  218.     }

  220.     /** Get the type of anomaly (true or mean).
  221.      * @return the type of anomaly
  222.      */
  223.     public PositionAngle getAnomalyType() {
  224.         return anomalyType;
  225.     }

  227.     /** Set the type of anomaly (true or mean).
  228.      * @param anomalyType the type of anomaly to be set
  229.      */
  230.     void setAnomalyType(final String anomalyType) {
  231.         this.anomalyType = PositionAngle.valueOf(anomalyType);
  232.     }

  234.     /** Get the spacecraft mass.
  235.      * @return the spacecraft mass
  236.      */
  237.     public double getMass() {
  238.         if (Double.isNaN(mass)) {
  239.             throw new OrekitException(OrekitMessages.CCSDS_UNKNOWN_SPACECRAFT_MASS);
  240.         }
  241.         return mass;
  242.     }

  244.     /** Set the spacecraft mass.
  245.      * @param mass the spacecraft mass to be set
  246.      */
  247.     void setMass(final double mass) {
  248.         this.mass = mass;
  249.     }

  251.     /** Get the solar radiation pressure area.
  252.      * @return the solar radiation pressure area
  253.      */
  254.     public double getSolarRadArea() {
  255.         return solarRadArea;
  256.     }

  258.     /** Set the solar radiation pressure area.
  259.      * @param solarRadArea the area to be set
  260.      */
  261.     void setSolarRadArea(final double solarRadArea) {
  262.         this.solarRadArea = solarRadArea;
  263.     }

  265.     /** Get the solar radiation pressure coefficient.
  266.      * @return the solar radiation pressure coefficient
  267.      */
  268.     public double getSolarRadCoeff() {
  269.         return solarRadCoeff;
  270.     }

  272.     /** Get the solar radiation pressure coefficient.
  273.      * @param solarRadCoeff the coefficient to be set
  274.      */
  275.     void setSolarRadCoeff(final double solarRadCoeff) {
  276.         this.solarRadCoeff = solarRadCoeff;
  277.     }

  279.     /** Get the drag area.
  280.      * @return the drag area
  281.      */
  282.     public double getDragArea() {
  283.         return dragArea;
  284.     }

  286.     /** Set the drag area.
  287.      * @param dragArea the area to be set
  288.      */
  289.     void setDragArea(final double dragArea) {
  290.         this.dragArea = dragArea;
  291.     }

  293.     /** Get the drag coefficient.
  294.      * @return the drag coefficient
  295.      */
  296.     public double getDragCoeff() {
  297.         return dragCoeff;
  298.     }

  300.     /** Set the drag coefficient.
  301.      * @param dragCoeff the coefficient to be set
  302.      */
  303.     void setDragCoeff(final double dragCoeff) {
  304.         this.dragCoeff = dragCoeff;
  305.     }

  307.     /** Get coordinate system for covariance matrix, for Local Orbital Frames.
  308.      * <p>
  309.      * The value returned is null if the covariance matrix is given in an
  310.      * absolute frame rather than a Local Orbital Frame. In this case, the
  311.      * method {@link #getCovRefFrame()} must be used instead.
  312.      * </p>
  313.      * @return the coordinate system for covariance matrix, or null if the
  314.      * covariance matrix is given in an absolute frame rather than a Local
  315.      * Orbital Frame
  316.      */
  317.     public LOFType getCovRefLofType() {
  318.         return covRefLofType;
  319.     }

  321.     /** Set coordinate system for covariance matrix, for Local Orbital Frames.
  322.      * @param covRefLofType the coordinate system to be set
  323.      */
  324.     void setCovRefLofType(final LOFType covRefLofType) {
  325.         this.covRefLofType = covRefLofType;
  326.         this.covRefFrame   = null;
  327.     }

  329.     /** Get coordinate system for covariance matrix, for absolute frames.
  330.      * <p>
  331.      * The value returned is null if the covariance matrix is given in a
  332.      * Local Orbital Frame rather than an absolute frame. In this case, the
  333.      * method {@link #getCovRefLofType()} must be used instead.
  334.      * </p>
  335.      * @return the coordinate system for covariance matrix
  336.      */
  337.     public Frame getCovRefFrame() {
  338.         return covRefFrame;
  339.     }

  341.     /** Set coordinate system for covariance matrix.
  342.      * @param covRefFrame the coordinate system to be set
  343.      */
  344.     void setCovRefFrame(final Frame covRefFrame) {
  345.         this.covRefLofType = null;
  346.         this.covRefFrame   = covRefFrame;
  347.     }

  349.     /** Get the Position/Velocity covariance matrix.
  350.      * @return the Position/Velocity covariance matrix
  351.      */
  352.     public RealMatrix getCovarianceMatrix() {
  353.         return covarianceMatrix;
  354.     }

  356.     /** Set an entry in the Position/Velocity covariance matrix.
  357.      * <p>
  358.      * Both m(j, k) and m(k, j) are set.
  359.      * </p>
  360.      * @param j row index (must be between 0 and 5 (inclusive)
  361.      * @param k column index (must be between 0 and 5 (inclusive)
  362.      * @param entry value of the matrix entry
  363.      */
  364.     void setCovarianceMatrixEntry(final int j, final int k, final double entry) {
  365.         covarianceMatrix.setEntry(j, k, entry);
  366.         covarianceMatrix.setEntry(k, j, entry);
  367.     }

  369.     /** Get the map of user defined parameter keywords and their corresponding values.
  370.      * @return the map of user defined parameter keywords and their corresponding values.
  371.      */
  372.     public Map<String, String> getUserDefinedParameters() {
  373.         return userDefinedParameters;
  374.     }

  376.     /** Add a pair keyword-value in the map of user defined parameter keywords and their corresponding values.
  377.      * @param keyword the user defined parameter keyword to be set. Starts with USER_DEFINED_
  378.      * @param value the user defined parameter value to be set
  379.      */
  380.     void setUserDefinedParameters(final String keyword,
  381.                                          final String value) {
  382.         userDefinedParameters.put(keyword, value);
  383.     }

  385.     /** Check whether the OPM contains Keplerian elements data.
  386.      * @return true if OPM contains Keplerian elements data.
  387.      */
  388.     public boolean hasKeplerianElements() {
  389.         return hasKeplerianElements;
  390.     }

  392.     /** Set boolean testing whether the OPM contains Keplerian elements data.
  393.      * @param hasKeplerianElements the boolean to be set.
  394.      */
  395.     void setHasKeplerianElements(final boolean hasKeplerianElements) {
  396.         this.hasKeplerianElements = hasKeplerianElements;
  397.     }

  399.     /** Check whether the OPM contains covariance matrix data.
  400.      * @return true if OPM contains covariance matrix data.
  401.      */
  402.     public boolean hasCovarianceMatrix() {
  403.         return covarianceMatrix != null;
  404.     }

  406.     /** Create a covariance matrix, initialized to zero.
  407.      */
  408.     void createCovarianceMatrix() {
  409.         covarianceMatrix = MatrixUtils.createRealMatrix(6, 6);
  410.     }

  412.     /** Get the comment for epoch.
  413.      * @return comment for epoch
  414.      */
  415.     public List<String> getEpochComment() {
  416.         return Collections.unmodifiableList(epochComment);
  417.     }

  419.     /** Set the comment for epoch.
  420.      * @param comment comment to set
  421.      */
  422.     void setEpochComment(final List<String> comment) {
  423.         epochComment = new ArrayList<String>(comment);
  424.     }

  426.     /** Get the comment for Keplerian elements.
  427.      * @return comment for Keplerian elements
  428.      */
  429.     public List<String> getKeplerianElementsComment() {
  430.         return Collections.unmodifiableList(keplerianElementsComment);
  431.     }

  433.     /** Set the comment for Keplerian elements.
  434.      * @param comment comment to set
  435.      */
  436.     void setKeplerianElementsComment(final List<String> comment) {
  437.         keplerianElementsComment = new ArrayList<String>(comment);
  438.     }

  440.     /** Get the comment for spacecraft.
  441.      * @return comment for spacecraft
  442.      */
  443.     public List<String> getSpacecraftComment() {
  444.         return Collections.unmodifiableList(spacecraftComment);
  445.     }

  447.     /** Set the comment for spacecraft.
  448.      * @param comment comment to set
  449.      */
  450.     void setSpacecraftComment(final List<String> comment) {
  451.         spacecraftComment = new ArrayList<String>(comment);
  452.     }

  454.     /** Get the comment for covariance.
  455.      * @return comment for covariance
  456.      */
  457.     public List<String> getCovarianceComment() {
  458.         return Collections.unmodifiableList(covarianceComment);
  459.     }

  461.     /** Set the comment for covariance.
  462.      * @param comment comment to set
  463.      */
  464.     void setCovarianceComment(final List<String> comment) {
  465.         covarianceComment = new ArrayList<String>(comment);
  466.     }

  468.     /** Get the meta data.
  469.      * @return meta data
  470.      */
  471.     public abstract ODMMetaData getMetaData();

  473. }
Created with JaCoCo 0.8.5.201910111838