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

  18. package org.orekit.files.ccsds;

  20. import java.util.ArrayList;
  21. import java.util.Collections;
  22. import java.util.List;

  24. import org.orekit.bodies.CelestialBody;
  25. import org.orekit.bodies.CelestialBodyFactory;
  26. import org.orekit.errors.OrekitException;
  27. import org.orekit.errors.OrekitMessages;
  28. import org.orekit.frames.Frame;
  29. import org.orekit.time.AbsoluteDate;

  31. /** This class gathers the meta-data present in the Orbital Data Message (ODM).
  32.  * @author sports
  33.  * @since 6.1
  34.  */
  35. public class ODMMetaData {

  37.     /** ODM file to which these meta-data belong. */
  38.     private final ODMFile odmFile;

  40.     /** Time System: used for metadata, orbit state and covariance data. */
  41.     private CcsdsTimeScale timeSystem;

  43.     /** Spacecraft name for which the orbit state is provided. */
  44.     private String objectName;

  46.     /** Object identifier of the object for which the orbit state is provided. */
  47.     private String objectID;

  49.     /** Launch Year. */
  50.     private int launchYear;

  52.     /** Launch number. */
  53.     private int launchNumber;

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

  58.     /** Origin of reference frame. */
  59.     private String centerName;

  61.     /** Celestial body corresponding to the center name. */
  62.     private CelestialBody centerBody;

  64.     /** Tests whether the body corresponding to the center name can be
  65.      * created through the {@link org.orekit.bodies.CelestialBodyFactory} in order to obtain the
  66.      * corresponding gravitational coefficient. */
  67.     private boolean hasCreatableBody;

  69.     /** Reference frame in which data are given: used for state vector
  70.      * and Keplerian elements data (and for the covariance reference frame if none is given). */
  71.     private Frame refFrame;

  73.     /** The reference frame specifier, as it appeared in the file. */
  74.     private String refFrameString;

  76.     /** Epoch of reference frame, if not intrinsic to the definition of the
  77.      * reference frame. */
  78.     private String frameEpochString;

  80.     /** Epoch of reference frame, if not intrinsic to the definition of the
  81.      * reference frame. */
  82.     private AbsoluteDate frameEpoch;

  84.     /** Metadata comments. The list contains a string for each line of comment. */
  85.     private List<String> comment;

  87.     /** Create a new meta-data.
  88.      * @param odmFile ODM file to which these meta-data belong
  89.      */
  90.     ODMMetaData(final ODMFile odmFile) {
  91.         this.odmFile = odmFile;
  92.         comment = new ArrayList<String>();
  93.     }

  95.     /** Get the ODM file to which these meta-data belong.
  96.      * @return ODM file to which these meta-data belong
  97.      */
  98.     public ODMFile getODMFile() {
  99.         return odmFile;
  100.     }

  102.     /** Get the Time System that: for OPM, is used for metadata, state vector,
  103.      * maneuver and covariance data, for OMM, is used for metadata, orbit state
  104.      * and covariance data, for OEM, is used for metadata, ephemeris and
  105.      * covariance data.
  106.      * @return the time system
  107.      */
  108.     public CcsdsTimeScale getTimeSystem() {
  109.         return timeSystem;
  110.     }

  112.     /** Set the Time System that: for OPM, is used for metadata, state vector,
  113.      * maneuver and covariance data, for OMM, is used for metadata, orbit state
  114.      * and covariance data, for OEM, is used for metadata, ephemeris and
  115.      * covariance data.
  116.      * @param timeSystem the time system to be set
  117.      */
  118.     void setTimeSystem(final CcsdsTimeScale timeSystem) {
  119.         this.timeSystem = timeSystem;
  120.     }

  122.     /** Get the spacecraft name for which the orbit state is provided.
  123.      * @return the spacecraft name
  124.      */
  125.     public String getObjectName() {
  126.         return objectName;
  127.     }

  129.     /** Set the spacecraft name for which the orbit state is provided.
  130.      * @param objectName the spacecraft name to be set
  131.      */
  132.     void setObjectName(final String objectName) {
  133.         this.objectName = objectName;
  134.     }

  136.     /** Get the spacecraft ID for which the orbit state is provided.
  137.      * @return the spacecraft ID
  138.      */
  139.     public String getObjectID() {
  140.         return objectID;
  141.     }

  143.     /** Set the spacecraft ID for which the orbit state is provided.
  144.      * @param objectID the spacecraft ID to be set
  145.      */
  146.     void setObjectID(final String objectID) {
  147.         this.objectID = objectID;
  148.     }

  150.     /** Set the launch year.
  151.      * @param launchYear launch year
  152.      */
  153.     void setLaunchYear(final int launchYear) {
  154.         this.launchYear = launchYear;
  155.     }

  157.     /** Get the launch year.
  158.      * @return launch year
  159.      */
  160.     public int getLaunchYear() {
  161.         return launchYear;
  162.     }

  164.     /** Set the launch number.
  165.      * @param launchNumber launch number
  166.      */
  167.     void setLaunchNumber(final int launchNumber) {
  168.         this.launchNumber = launchNumber;
  169.     }

  171.     /** Get the launch number.
  172.      * @return launch number
  173.      */
  174.     public int getLaunchNumber() {
  175.         return launchNumber;
  176.     }

  178.     /** Set the piece of launch.
  179.      * @param launchPiece piece of launch
  180.      */
  181.     void setLaunchPiece(final String launchPiece) {
  182.         this.launchPiece = launchPiece;
  183.     }

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

  192.     /** Get the origin of reference frame.
  193.      * @return the origin of reference frame.
  194.      */
  195.     public String getCenterName() {
  196.         return centerName;
  197.     }

  199.     /** Set the origin of reference frame.
  200.      * @param centerName the origin of reference frame to be set
  201.      */
  202.     void setCenterName(final String centerName) {
  203.         this.centerName = centerName;
  204.     }

  206.     /** Get the {@link CelestialBody} corresponding to the center name.
  207.      * @return the center body
  208.      */
  209.     public CelestialBody getCenterBody() {
  210.         return centerBody;
  211.     }

  213.     /** Set the {@link CelestialBody} corresponding to the center name.
  214.      * @param centerBody the {@link CelestialBody} to be set
  215.      */
  216.     void setCenterBody(final CelestialBody centerBody) {
  217.         this.centerBody = centerBody;
  218.     }

  220.     /** Get boolean testing whether the body corresponding to the centerName
  221.      * attribute can be created through the {@link org.orekit.bodies.CelestialBodyFactory}.
  222.      * @return true if {@link CelestialBody} can be created from centerName
  223.      *         false otherwise
  224.      */
  225.     public boolean getHasCreatableBody() {
  226.         return hasCreatableBody;
  227.     }

  229.     /** Set boolean testing whether the body corresponding to the centerName
  230.      * attribute can be created through the {@link org.orekit.bodies.CelestialBodyFactory}.
  231.      * @param hasCreatableBody the boolean to be set.
  232.      */
  233.     void setHasCreatableBody(final boolean hasCreatableBody) {
  234.         this.hasCreatableBody = hasCreatableBody;
  235.     }

  237.     /**
  238.      * Get the reference frame in which data are given: used for state vector and
  239.      * Keplerian elements data (and for the covariance reference frame if none is given).
  240.      *
  241.      * @return the reference frame
  242.      */
  243.     public Frame getFrame() {
  244.         final Frame frame = this.getRefFrame();
  245.         final CelestialBody body = this.getCenterBody();
  246.         if (body == null) {
  247.             throw new OrekitException(OrekitMessages.NO_DATA_LOADED_FOR_CELESTIAL_BODY,
  248.                     this.getCenterName());
  249.         }
  250.         // Just return frame if we don't need to shift the center based on CENTER_NAME
  251.         // MCI and ICRF are the only non-earth centered frames specified in Annex A.
  252.         final String frameString = this.getFrameString();
  253.         final boolean isMci = "MCI".equals(frameString);
  254.         final boolean isIcrf = "ICRF".equals(frameString);
  255.         final boolean isSolarSystemBarycenter =
  256.                 CelestialBodyFactory.SOLAR_SYSTEM_BARYCENTER.equals(body.getName());
  257.         if ((!(isMci || isIcrf) && CelestialBodyFactory.EARTH.equals(body.getName())) ||
  258.                 (isMci && CelestialBodyFactory.MARS.equals(body.getName())) ||
  259.                 (isIcrf && isSolarSystemBarycenter)) {
  260.             return frame;
  261.         }
  262.         // else, translate frame to specified center.
  263.         return new CcsdsModifiedFrame(frame, frameString, body, this.getCenterName());
  264.     }

  266.     /**
  267.      * Get the the value of {@code REF_FRAME} as an Orekit {@link Frame}. The {@code
  268.      * CENTER_NAME} key word has not been applied yet, so the returned frame may not
  269.      * correspond to the reference frame of the data in the file.
  270.      *
  271.      * @return The reference frame specified by the {@code REF_FRAME} keyword.
  272.      * @see #getFrame()
  273.      */
  274.     public Frame getRefFrame() {
  275.         return refFrame;
  276.     }

  278.     /** Set the reference frame in which data are given: used for state vector
  279.      * and Keplerian elements data (and for the covariance reference frame if none is given).
  280.      * @param refFrame the reference frame to be set
  281.      */
  282.     void setRefFrame(final Frame refFrame) {
  283.         this.refFrame = refFrame;
  284.     }

  286.     /**
  287.      * Get the reference frame specifier as it appeared in the file.
  288.      *
  289.      * @return the frame name as it appeared in the file.
  290.      * @see #getFrame()
  291.      */
  292.     public String getFrameString() {
  293.         return this.refFrameString;
  294.     }

  296.     /**
  297.      * Set the reference frame name.
  298.      *
  299.      * @param frame specifier as it appeared in the file.
  300.      */
  301.     void setFrameString(final String frame) {
  302.         this.refFrameString = frame;
  303.     }

  305.     /** Get epoch of reference frame, if not intrinsic to the definition of the
  306.      * reference frame.
  307.      * @return epoch of reference frame
  308.      */
  309.     public String getFrameEpochString() {
  310.         return frameEpochString;
  311.     }

  313.     /** Set epoch of reference frame, if not intrinsic to the definition of the
  314.      * reference frame.
  315.      * @param frameEpochString the epoch of reference frame to be set
  316.      */
  317.     void setFrameEpochString(final String frameEpochString) {
  318.         this.frameEpochString = frameEpochString;
  319.     }

  321.     /** Get epoch of reference frame, if not intrinsic to the definition of the
  322.      * reference frame.
  323.      * @return epoch of reference frame
  324.      */
  325.     public AbsoluteDate getFrameEpoch() {
  326.         return frameEpoch;
  327.     }

  329.     /** Set epoch of reference frame, if not intrinsic to the definition of the
  330.      * reference frame.
  331.      * @param frameEpoch the epoch of reference frame to be set
  332.      */
  333.     void setFrameEpoch(final AbsoluteDate frameEpoch) {
  334.         this.frameEpoch = frameEpoch;
  335.     }

  337.     /** Get the meta-data comment.
  338.      * @return meta-data comment
  339.      */
  340.     public List<String> getComment() {
  341.         return Collections.unmodifiableList(comment);
  342.     }

  344.     /** Set the meta-data comment.
  345.      * @param comment comment to set
  346.      */
  347.     void setComment(final List<String> comment) {
  348.         this.comment = new ArrayList<String>(comment);
  349.     }

  351. }


Created with JaCoCo 0.8.2.201808211720