TrajectoryStateHistoryMetadata.java

  1. /* Copyright 2002-2022 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.ndm.odm.ocm;

  20. import java.util.List;

  22. import org.orekit.data.DataContext;
  23. import org.orekit.errors.OrekitException;
  24. import org.orekit.errors.OrekitMessages;
  25. import org.orekit.files.ccsds.definitions.BodyFacade;
  26. import org.orekit.files.ccsds.definitions.CelestialBodyFrame;
  27. import org.orekit.files.ccsds.definitions.ElementsType;
  28. import org.orekit.files.ccsds.definitions.FrameFacade;
  29. import org.orekit.files.ccsds.ndm.odm.oem.InterpolationMethod;
  30. import org.orekit.files.ccsds.section.CommentsContainer;
  31. import org.orekit.time.AbsoluteDate;
  32. import org.orekit.utils.units.Unit;

  34. /** Metadata for trajectory state history.
  35.  * @author Luc Maisonobe
  36.  * @since 11.0
  37.  */
  38. public class TrajectoryStateHistoryMetadata extends CommentsContainer {

  40.     /** Trajectory identification number. */
  41.     private String trajID;

  43.     /** Identification number of previous trajectory. */
  44.     private String trajPrevID;

  46.     /** Identification number of next trajectory. */
  47.     private String trajNextID;

  49.     /** Basis of this trajectory state time history data. */
  50.     private String trajBasis;

  52.     /** Identification number of the orbit determination or simulation upon which this trajectory is based. */
  53.     private String trajBasisID;

  55.     /** Interpolation method. */
  56.     private InterpolationMethod interpolationMethod;

  58.     /** Interpolation degree. */
  59.     private int interpolationDegree;

  61.     /** Type of averaging (Osculating, mean Brouwer, other...). */
  62.     private String orbAveraging;

  64.     /** Origin of reference frame. */
  65.     private BodyFacade center;

  67.     /** Reference frame of the trajectory. */
  68.     private FrameFacade trajReferenceFrame;

  70.     /** Epoch of the trajectory reference frame. */
  71.     private AbsoluteDate trajFrameEpoch;

  73.     /** Start of useable time span covered by ephemerides data, it may be
  74.      * necessary to allow for proper interpolation. */
  75.     private AbsoluteDate useableStartTime;

  77.     /** End of useable time span covered by ephemerides data, it may be
  78.      * necessary to allow for proper interpolation. */
  79.     private AbsoluteDate useableStopTime;

  81.     /** Integer orbit revolution number. */
  82.     private int orbRevNum;

  84.     /** Basis for orbit revolution counter (i.e is first launch/deployment on orbit 0 or 1). */
  85.     private int orbRevNumBasis;

  87.     /** Trajectory element set type. */
  88.     private ElementsType trajType;

  90.     /** Units of trajectory element set. */
  91.     private List<Unit> trajUnits;

  93.     /** Simple constructor.
  94.      * @param epochT0 T0 epoch from file metadata
  95.      * @param dataContext data context
  96.      */
  97.     TrajectoryStateHistoryMetadata(final AbsoluteDate epochT0, final DataContext dataContext) {
  98.         // we don't call the setXxx() methods in order to avoid
  99.         // calling refuseFurtherComments as a side effect
  100.         trajBasis           = "PREDICTED";
  101.         interpolationMethod = InterpolationMethod.HERMITE;
  102.         interpolationDegree = 3;
  103.         orbAveraging        = "OSCULATING";
  104.         center              = new BodyFacade("EARTH",
  105.                                              dataContext.getCelestialBodies().getEarth());
  106.         trajReferenceFrame  = new FrameFacade(dataContext.getFrames().getICRF(),
  107.                                               CelestialBodyFrame.ICRF, null, null,
  108.                                               CelestialBodyFrame.ICRF.name());
  109.         trajFrameEpoch      = epochT0;
  110.         trajType            = ElementsType.CARTPV;
  111.         orbRevNum           = -1;
  112.         orbRevNumBasis      = -1;
  113.     }

  115.     /** {@inheritDoc} */
  116.     @Override
  117.     public void validate(final double version) {
  118.         super.validate(version);
  119.         if (trajUnits != null) {
  120.             trajType.checkUnits(trajUnits);
  121.         }
  122.         if (orbRevNum >= 0 && orbRevNumBasis < 0) {
  123.             throw new OrekitException(OrekitMessages.UNINITIALIZED_VALUE_FOR_KEY,
  124.                                       TrajectoryStateHistoryMetadataKey.ORB_REVNUM_BASIS.name());
  125.         }
  126.     }

  128.     /** Get trajectory identification number.
  129.      * @return trajectory identification number
  130.      */
  131.     public String getTrajID() {
  132.         return trajID;
  133.     }

  135.     /** Set trajectory identification number.
  136.      * @param trajID trajectory identification number
  137.      */
  138.     public void setTrajID(final String trajID) {
  139.         refuseFurtherComments();
  140.         this.trajID = trajID;
  141.     }

  143.     /** Get identification number of previous trajectory.
  144.      * @return identification number of previous trajectory
  145.      */
  146.     public String getTrajPrevID() {
  147.         return trajPrevID;
  148.     }

  150.     /** Set identification number of previous trajectory.
  151.      * @param trajPrevID identification number of previous trajectory
  152.      */
  153.     public void setTrajPrevID(final String trajPrevID) {
  154.         refuseFurtherComments();
  155.         this.trajPrevID = trajPrevID;
  156.     }

  158.     /** Get identification number of next trajectory.
  159.      * @return identification number of next trajectory
  160.      */
  161.     public String getTrajNextID() {
  162.         return trajNextID;
  163.     }

  165.     /** Set identification number of next trajectory.
  166.      * @param trajNextID identification number of next trajectory
  167.      */
  168.     public void setTrajNextID(final String trajNextID) {
  169.         refuseFurtherComments();
  170.         this.trajNextID = trajNextID;
  171.     }

  173.     /** Get basis of this trajectory state time history data.
  174.      * @return basis of this trajectory state time history data
  175.      */
  176.     public String getTrajBasis() {
  177.         return trajBasis;
  178.     }

  180.     /** Set basis of this trajectory state time history data.
  181.      * @param trajBasis basis of this trajectory state time history data
  182.      */
  183.     public void setTrajBasis(final String trajBasis) {
  184.         refuseFurtherComments();
  185.         this.trajBasis = trajBasis;
  186.     }

  188.     /** Get identification number of the orbit determination or simulation upon which this trajectory is based.
  189.      * @return identification number of the orbit determination or simulation upon which this trajectory is based
  190.      */
  191.     public String getTrajBasisID() {
  192.         return trajBasisID;
  193.     }

  195.     /** Set identification number of the orbit determination or simulation upon which this trajectory is based.
  196.      * @param trajBasisID identification number of the orbit determination or simulation upon which this trajectory is based
  197.      */
  198.     public void setTrajBasisID(final String trajBasisID) {
  199.         refuseFurtherComments();
  200.         this.trajBasisID = trajBasisID;
  201.     }

  203.     /** Get the interpolation method to be used.
  204.      * @return the interpolation method
  205.      */
  206.     public InterpolationMethod getInterpolationMethod() {
  207.         return interpolationMethod;
  208.     }

  210.     /** Set the interpolation method to be used.
  211.      * @param interpolationMethod the interpolation method to be set
  212.      */
  213.     public void setInterpolationMethod(final InterpolationMethod interpolationMethod) {
  214.         refuseFurtherComments();
  215.         this.interpolationMethod = interpolationMethod;
  216.     }

  218.     /** Get the interpolation degree.
  219.      * @return the interpolation degree
  220.      */
  221.     public int getInterpolationDegree() {
  222.         return interpolationDegree;
  223.     }

  225.     /** Set the interpolation degree.
  226.      * @param interpolationDegree the interpolation degree to be set
  227.      */
  228.     public void setInterpolationDegree(final int interpolationDegree) {
  229.         refuseFurtherComments();
  230.         this.interpolationDegree = interpolationDegree;
  231.     }

  233.     /** Get type of averaging (Osculating, mean Brouwer, other.
  234.      * @return type of averaging (Osculating, mean Brouwer, other
  235.      .). */
  236.     public String getOrbAveraging() {
  237.         return orbAveraging;
  238.     }

  240.     /** Set type of averaging (Osculating, mean Brouwer, other.
  241.      * @param orbAveraging type of averaging (Osculating, mean Brouwer, other
  242.      .). */
  243.     public void setOrbAveraging(final String orbAveraging) {
  244.         refuseFurtherComments();
  245.         this.orbAveraging = orbAveraging;
  246.     }

  248.     /** Get the origin of reference frame.
  249.      * @return the origin of reference frame.
  250.      */
  251.     public BodyFacade getCenter() {
  252.         return center;
  253.     }

  255.     /** Set the origin of reference frame.
  256.      * @param center origin of reference frame to be set
  257.      */
  258.     public void setCenter(final BodyFacade center) {
  259.         refuseFurtherComments();
  260.         this.center = center;
  261.     }

  263.     /** Get reference frame of the trajectory.
  264.      * @return reference frame of the trajectory
  265.      */
  266.     public FrameFacade getTrajReferenceFrame() {
  267.         return trajReferenceFrame;
  268.     }

  270.     /** Set reference frame of the trajectory.
  271.      * @param trajReferenceFrame the reference frame to be set
  272.      */
  273.     public void setTrajReferenceFrame(final FrameFacade trajReferenceFrame) {
  274.         refuseFurtherComments();
  275.         this.trajReferenceFrame = trajReferenceFrame;
  276.     }

  278.     /** Get epoch of the {@link #getTrajReferenceFrame() trajectory reference frame}.
  279.      * @return epoch of the {@link #getTrajReferenceFrame() trajectory reference frame}
  280.      */
  281.     public AbsoluteDate getTrajFrameEpoch() {
  282.         return trajFrameEpoch;
  283.     }

  285.     /** Set epoch of the {@link #getTrajReferenceFrame() trajectory reference frame}.
  286.      * @param trajFrameEpoch epoch of the {@link #getTrajReferenceFrame() trajectory reference frame}
  287.      */
  288.     public void setTrajFrameEpoch(final AbsoluteDate trajFrameEpoch) {
  289.         refuseFurtherComments();
  290.         this.trajFrameEpoch = trajFrameEpoch;
  291.     }

  293.     /** Get start of useable time span covered by ephemerides data, it may be
  294.      * necessary to allow for proper interpolation.
  295.      * @return the useable start time
  296.      */
  297.     public AbsoluteDate getUseableStartTime() {
  298.         return useableStartTime;
  299.     }

  301.     /** Set start of useable time span covered by ephemerides data, it may be
  302.      * necessary to allow for proper interpolation.
  303.      * @param useableStartTime the time to be set
  304.      */
  305.     public void setUseableStartTime(final AbsoluteDate useableStartTime) {
  306.         refuseFurtherComments();
  307.         this.useableStartTime = useableStartTime;
  308.     }

  310.     /** Get end of useable time span covered by ephemerides data, it may be
  311.      * necessary to allow for proper interpolation.
  312.      * @return the useable stop time
  313.      */
  314.     public AbsoluteDate getUseableStopTime() {
  315.         return useableStopTime;
  316.     }

  318.     /** Set end of useable time span covered by ephemerides data, it may be
  319.      * necessary to allow for proper interpolation.
  320.      * @param useableStopTime the time to be set
  321.      */
  322.     public void setUseableStopTime(final AbsoluteDate useableStopTime) {
  323.         refuseFurtherComments();
  324.         this.useableStopTime = useableStopTime;
  325.     }

  327.     /** Get the integer orbit revolution number.
  328.      * @return integer orbit revolution number (-1 if not set)
  329.      */
  330.     public int getOrbRevNum() {
  331.         return orbRevNum;
  332.     }

  334.     /** Set the integer orbit revolution number.
  335.      * @param orbRevNum integer orbit revolution number
  336.      */
  337.     public void setOrbRevNum(final int orbRevNum) {
  338.         this.orbRevNum = orbRevNum;
  339.     }

  341.     /** Get the basis for orbit revolution number.
  342.      * <p>
  343.      * This specifies if first launch/deployment is on orbit 0 or 1.
  344.      * </p>
  345.      * @return basis for orbit revolution number (-1 if not set)
  346.      */
  347.     public int getOrbRevNumBasis() {
  348.         return orbRevNumBasis;
  349.     }

  351.     /** Set the basis for orbit revolution number.
  352.      * <p>
  353.      * This specifies if first launch/deployment is on orbit 0 or 1.
  354.      * </p>
  355.      * @param orbRevNumBasis basis for orbit revolution number
  356.      */
  357.     public void setOrbRevNumBasis(final int orbRevNumBasis) {
  358.         this.orbRevNumBasis = orbRevNumBasis;
  359.     }

  361.     /** Get trajectory element set type.
  362.      * @return trajectory element set type
  363.      */
  364.     public ElementsType getTrajType() {
  365.         return trajType;
  366.     }

  368.     /** Set trajectory element set type.
  369.      * @param trajType trajectory element set type
  370.      */
  371.     public void setTrajType(final ElementsType trajType) {
  372.         refuseFurtherComments();
  373.         this.trajType = trajType;
  374.     }

  376.     /** Get trajectory element set units.
  377.      * @return trajectory element set units
  378.      */
  379.     public List<Unit> getTrajUnits() {
  380.         return trajUnits;
  381.     }

  383.     /** Set trajectory element set units.
  384.      * @param trajUnits trajectory element set units
  385.      */
  386.     public void setTrajUnits(final List<Unit> trajUnits) {
  387.         refuseFurtherComments();
  388.         this.trajUnits = trajUnits;
  389.     }

  391. }
Created with JaCoCo 0.8.7.202105040129