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.     /** Orbit propagator used to generate this trajectory.
  62.      * @since 11.2
  63.      */
  64.     private String propagator;

  66.     /** Origin of reference frame. */
  67.     private BodyFacade center;

  69.     /** Reference frame of the trajectory. */
  70.     private FrameFacade trajReferenceFrame;

  72.     /** Epoch of the trajectory reference frame. */
  73.     private AbsoluteDate trajFrameEpoch;

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

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

  83.     /** Integer orbit revolution number. */
  84.     private int orbRevNum;

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

  89.     /** Trajectory element set type. */
  90.     private ElementsType trajType;

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

  95.     /** Units of trajectory element set. */
  96.     private List<Unit> trajUnits;

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

  120.     /** {@inheritDoc} */
  121.     @Override
  122.     public void validate(final double version) {
  123.         super.validate(version);
  124.         if (trajType != ElementsType.CARTP   &&
  125.             trajType != ElementsType.CARTPV  &&
  126.             trajType != ElementsType.CARTPVA) {
  127.             checkNotNull(orbAveraging, TrajectoryStateHistoryMetadataKey.ORB_AVERAGING);
  128.         }
  129.         if (trajUnits != null) {
  130.             trajType.checkUnits(trajUnits);
  131.         }
  132.         if (orbRevNum >= 0 && orbRevNumBasis < 0) {
  133.             throw new OrekitException(OrekitMessages.UNINITIALIZED_VALUE_FOR_KEY,
  134.                                       TrajectoryStateHistoryMetadataKey.ORB_REVNUM_BASIS.name());
  135.         }
  136.     }

  138.     /** Get trajectory identification number.
  139.      * @return trajectory identification number
  140.      */
  141.     public String getTrajID() {
  142.         return trajID;
  143.     }

  145.     /** Set trajectory identification number.
  146.      * @param trajID trajectory identification number
  147.      */
  148.     public void setTrajID(final String trajID) {
  149.         refuseFurtherComments();
  150.         this.trajID = trajID;
  151.     }

  153.     /** Get identification number of previous trajectory.
  154.      * @return identification number of previous trajectory
  155.      */
  156.     public String getTrajPrevID() {
  157.         return trajPrevID;
  158.     }

  160.     /** Set identification number of previous trajectory.
  161.      * @param trajPrevID identification number of previous trajectory
  162.      */
  163.     public void setTrajPrevID(final String trajPrevID) {
  164.         refuseFurtherComments();
  165.         this.trajPrevID = trajPrevID;
  166.     }

  168.     /** Get identification number of next trajectory.
  169.      * @return identification number of next trajectory
  170.      */
  171.     public String getTrajNextID() {
  172.         return trajNextID;
  173.     }

  175.     /** Set identification number of next trajectory.
  176.      * @param trajNextID identification number of next trajectory
  177.      */
  178.     public void setTrajNextID(final String trajNextID) {
  179.         refuseFurtherComments();
  180.         this.trajNextID = trajNextID;
  181.     }

  183.     /** Get basis of this trajectory state time history data.
  184.      * @return basis of this trajectory state time history data
  185.      */
  186.     public String getTrajBasis() {
  187.         return trajBasis;
  188.     }

  190.     /** Set basis of this trajectory state time history data.
  191.      * @param trajBasis basis of this trajectory state time history data
  192.      */
  193.     public void setTrajBasis(final String trajBasis) {
  194.         refuseFurtherComments();
  195.         this.trajBasis = trajBasis;
  196.     }

  198.     /** Get identification number of the orbit determination or simulation upon which this trajectory is based.
  199.      * @return identification number of the orbit determination or simulation upon which this trajectory is based
  200.      */
  201.     public String getTrajBasisID() {
  202.         return trajBasisID;
  203.     }

  205.     /** Set identification number of the orbit determination or simulation upon which this trajectory is based.
  206.      * @param trajBasisID identification number of the orbit determination or simulation upon which this trajectory is based
  207.      */
  208.     public void setTrajBasisID(final String trajBasisID) {
  209.         refuseFurtherComments();
  210.         this.trajBasisID = trajBasisID;
  211.     }

  213.     /** Get the interpolation method to be used.
  214.      * @return the interpolation method
  215.      */
  216.     public InterpolationMethod getInterpolationMethod() {
  217.         return interpolationMethod;
  218.     }

  220.     /** Set the interpolation method to be used.
  221.      * @param interpolationMethod the interpolation method to be set
  222.      */
  223.     public void setInterpolationMethod(final InterpolationMethod interpolationMethod) {
  224.         refuseFurtherComments();
  225.         this.interpolationMethod = interpolationMethod;
  226.     }

  228.     /** Get the interpolation degree.
  229.      * @return the interpolation degree
  230.      */
  231.     public int getInterpolationDegree() {
  232.         return interpolationDegree;
  233.     }

  235.     /** Set the interpolation degree.
  236.      * @param interpolationDegree the interpolation degree to be set
  237.      */
  238.     public void setInterpolationDegree(final int interpolationDegree) {
  239.         refuseFurtherComments();
  240.         this.interpolationDegree = interpolationDegree;
  241.     }

  243.     /** Get the orbit propagator used to generate this trajectory.
  244.      * @return orbit propagator used to generate this trajectory
  245.      * @since 11.2
  246.      */
  247.     public String getPropagator() {
  248.         return propagator;
  249.     }

  251.     /** Set the orbit propagator used to generate this trajectory.
  252.      * @param propagator orbit propagator used to generate this trajectory
  253.      * @since 11.2
  254.      */
  255.     public void setPropagator(final String propagator) {
  256.         refuseFurtherComments();
  257.         this.propagator = propagator;
  258.     }

  260.     /** Get the origin of reference frame.
  261.      * @return the origin of reference frame.
  262.      */
  263.     public BodyFacade getCenter() {
  264.         return center;
  265.     }

  267.     /** Set the origin of reference frame.
  268.      * @param center origin of reference frame to be set
  269.      */
  270.     public void setCenter(final BodyFacade center) {
  271.         refuseFurtherComments();
  272.         this.center = center;
  273.     }

  275.     /** Get reference frame of the trajectory.
  276.      * @return reference frame of the trajectory
  277.      */
  278.     public FrameFacade getTrajReferenceFrame() {
  279.         return trajReferenceFrame;
  280.     }

  282.     /** Set reference frame of the trajectory.
  283.      * @param trajReferenceFrame the reference frame to be set
  284.      */
  285.     public void setTrajReferenceFrame(final FrameFacade trajReferenceFrame) {
  286.         refuseFurtherComments();
  287.         this.trajReferenceFrame = trajReferenceFrame;
  288.     }

  290.     /** Get epoch of the {@link #getTrajReferenceFrame() trajectory reference frame}.
  291.      * @return epoch of the {@link #getTrajReferenceFrame() trajectory reference frame}
  292.      */
  293.     public AbsoluteDate getTrajFrameEpoch() {
  294.         return trajFrameEpoch;
  295.     }

  297.     /** Set epoch of the {@link #getTrajReferenceFrame() trajectory reference frame}.
  298.      * @param trajFrameEpoch epoch of the {@link #getTrajReferenceFrame() trajectory reference frame}
  299.      */
  300.     public void setTrajFrameEpoch(final AbsoluteDate trajFrameEpoch) {
  301.         refuseFurtherComments();
  302.         this.trajFrameEpoch = trajFrameEpoch;
  303.     }

  305.     /** Get start of useable time span covered by ephemerides data, it may be
  306.      * necessary to allow for proper interpolation.
  307.      * @return the useable start time
  308.      */
  309.     public AbsoluteDate getUseableStartTime() {
  310.         return useableStartTime;
  311.     }

  313.     /** Set start of useable time span covered by ephemerides data, it may be
  314.      * necessary to allow for proper interpolation.
  315.      * @param useableStartTime the time to be set
  316.      */
  317.     public void setUseableStartTime(final AbsoluteDate useableStartTime) {
  318.         refuseFurtherComments();
  319.         this.useableStartTime = useableStartTime;
  320.     }

  322.     /** Get end of useable time span covered by ephemerides data, it may be
  323.      * necessary to allow for proper interpolation.
  324.      * @return the useable stop time
  325.      */
  326.     public AbsoluteDate getUseableStopTime() {
  327.         return useableStopTime;
  328.     }

  330.     /** Set end of useable time span covered by ephemerides data, it may be
  331.      * necessary to allow for proper interpolation.
  332.      * @param useableStopTime the time to be set
  333.      */
  334.     public void setUseableStopTime(final AbsoluteDate useableStopTime) {
  335.         refuseFurtherComments();
  336.         this.useableStopTime = useableStopTime;
  337.     }

  339.     /** Get the integer orbit revolution number.
  340.      * @return integer orbit revolution number (-1 if not set)
  341.      */
  342.     public int getOrbRevNum() {
  343.         return orbRevNum;
  344.     }

  346.     /** Set the integer orbit revolution number.
  347.      * @param orbRevNum integer orbit revolution number
  348.      */
  349.     public void setOrbRevNum(final int orbRevNum) {
  350.         this.orbRevNum = orbRevNum;
  351.     }

  353.     /** Get the basis for orbit revolution number.
  354.      * <p>
  355.      * This specifies if first launch/deployment is on orbit 0 or 1.
  356.      * </p>
  357.      * @return basis for orbit revolution number (-1 if not set)
  358.      */
  359.     public int getOrbRevNumBasis() {
  360.         return orbRevNumBasis;
  361.     }

  363.     /** Set the basis for orbit revolution number.
  364.      * <p>
  365.      * This specifies if first launch/deployment is on orbit 0 or 1.
  366.      * </p>
  367.      * @param orbRevNumBasis basis for orbit revolution number
  368.      */
  369.     public void setOrbRevNumBasis(final int orbRevNumBasis) {
  370.         this.orbRevNumBasis = orbRevNumBasis;
  371.     }

  373.     /** Get trajectory element set type.
  374.      * @return trajectory element set type
  375.      */
  376.     public ElementsType getTrajType() {
  377.         return trajType;
  378.     }

  380.     /** Set trajectory element set type.
  381.      * @param trajType trajectory element set type
  382.      */
  383.     public void setTrajType(final ElementsType trajType) {
  384.         refuseFurtherComments();
  385.         this.trajType = trajType;
  386.     }

  388.     /** Get type of averaging (Osculating, mean Brouwer, other.
  389.      * @return type of averaging (Osculating, mean Brouwer, other
  390.      .). */
  391.     public String getOrbAveraging() {
  392.         return orbAveraging;
  393.     }

  395.     /** Set type of averaging (Osculating, mean Brouwer, other.
  396.      * @param orbAveraging type of averaging (Osculating, mean Brouwer, other
  397.      .). */
  398.     public void setOrbAveraging(final String orbAveraging) {
  399.         refuseFurtherComments();
  400.         this.orbAveraging = orbAveraging;
  401.     }

  403.     /** Get trajectory element set units.
  404.      * @return trajectory element set units
  405.      */
  406.     public List<Unit> getTrajUnits() {
  407.         return trajUnits;
  408.     }

  410.     /** Set trajectory element set units.
  411.      * @param trajUnits trajectory element set units
  412.      */
  413.     public void setTrajUnits(final List<Unit> trajUnits) {
  414.         refuseFurtherComments();
  415.         this.trajUnits = trajUnits;
  416.     }

  418. }
Created with JaCoCo 0.8.8.202204050719