OGMFile.java

  1. /* Copyright 2002-2018 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.  */

  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.      * @exception OrekitException if mass is unknown
  237.      */
  238.     public double getMass() throws OrekitException {
  239.         if (Double.isNaN(mass)) {
  240.             throw new OrekitException(OrekitMessages.CCSDS_UNKNOWN_SPACECRAFT_MASS);
  241.         }
  242.         return mass;
  243.     }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  474. }
Created with JaCoCo 0.7.9.201702052155