AEMFile.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.  */
  17. package org.orekit.files.ccsds;

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

  26. import org.hipparchus.geometry.euclidean.threed.RotationOrder;
  27. import org.orekit.errors.OrekitException;
  28. import org.orekit.errors.OrekitMessages;
  29. import org.orekit.files.general.AttitudeEphemerisFile;
  30. import org.orekit.frames.Frame;
  31. import org.orekit.time.AbsoluteDate;
  32. import org.orekit.time.TimeScale;
  33. import org.orekit.utils.AngularDerivativesFilter;
  34. import org.orekit.utils.TimeStampedAngularCoordinates;

  36. /**
  37.  * This class stocks all the information of the Attitude Ephemeris Message (AEM) File parsed
  38.  * by AEMParser. It contains the header and a list of Attitude Ephemerides Blocks each
  39.  * containing metadata and a list of attitude ephemerides data lines.
  40.  * @author Bryan Cazabonne
  41.  * @since 10.2
  42.  */
  43. public class AEMFile extends ADMFile implements AttitudeEphemerisFile {

  45.     /** List of ephemeris blocks. */
  46.     private List<AttitudeEphemeridesBlock> attitudeBlocks;

  48.     /**
  49.      * AEMFile constructor.
  50.      */
  51.     public AEMFile() {
  52.         attitudeBlocks = new ArrayList<AttitudeEphemeridesBlock>();
  53.     }

  55.     /**
  56.      * Add a block to the list of ephemeris blocks.
  57.      */
  58.     public void addAttitudeBlock() {
  59.         attitudeBlocks.add(new AttitudeEphemeridesBlock());
  60.     }

  62.     /**
  63.      * Get the list of attitude ephemerides blocks as an unmodifiable list.
  64.      * @return the list of attitude ephemerides blocks
  65.      */
  66.     public List<AttitudeEphemeridesBlock> getAttitudeBlocks() {
  67.         return Collections.unmodifiableList(attitudeBlocks);
  68.     }

  70.     /**
  71.      * Check that, according to the CCSDS standard, every AEMBlock has the same time system.
  72.      */
  73.     public void checkTimeSystems() {
  74.         final CcsdsTimeScale timeSystem = getAttitudeBlocks().get(0).getMetaData().getTimeSystem();
  75.         for (final AttitudeEphemeridesBlock block : attitudeBlocks) {
  76.             if (!timeSystem.equals(block.getMetaData().getTimeSystem())) {
  77.                 throw new OrekitException(OrekitMessages.CCSDS_AEM_INCONSISTENT_TIME_SYSTEMS,
  78.                                           timeSystem, block.getMetaData().getTimeSystem());
  79.             }
  80.         }
  81.     }

  83.     /** {@inheritDoc} */
  84.     @Override
  85.     public Map<String, AemSatelliteEphemeris> getSatellites() {
  86.         final Map<String, List<AttitudeEphemeridesBlock>> satellites = new HashMap<>();
  87.         for (final AttitudeEphemeridesBlock ephemeridesBlock : attitudeBlocks) {
  88.             final String id = ephemeridesBlock.getMetaData().getObjectID();
  89.             satellites.putIfAbsent(id, new ArrayList<>());
  90.             satellites.get(id).add(ephemeridesBlock);
  91.         }
  92.         final Map<String, AemSatelliteEphemeris> ret = new HashMap<>();
  93.         for (final Entry<String, List<AttitudeEphemeridesBlock>> entry : satellites.entrySet()) {
  94.             final String id = entry.getKey();
  95.             ret.put(id, new AemSatelliteEphemeris(id, entry.getValue()));
  96.         }
  97.         return ret;
  98.     }


  101.     /** AEM ephemeris blocks for a single satellite. */
  102.     public static class AemSatelliteEphemeris implements SatelliteAttitudeEphemeris {

  104.         /** ID of the satellite. */
  105.         private final String id;

  107.         /** The attitude ephemeris data for the satellite. */
  108.         private final List<AttitudeEphemeridesBlock> blocks;

  110.         /**
  111.          * Create a container for the set of ephemeris blocks in the file that pertain to
  112.          * a single satellite. The satellite's ID is set to ""
  113.          * @param blocks containing ephemeris data for the satellite.
  114.          * @deprecated in 10.3, replaced by AemSatelliteEphemeris(String, List)
  115.          */
  116.         @Deprecated
  117.         public AemSatelliteEphemeris(final List<AttitudeEphemeridesBlock> blocks) {
  118.             this("", blocks);
  119.         }

  121.         /**
  122.          * Create a container for the set of ephemeris blocks in the file that pertain to
  123.          * a single satellite.
  124.          * @param id     of the satellite.
  125.          * @param blocks containing ephemeris data for the satellite.
  126.          * @since 10.3
  127.          */
  128.         public AemSatelliteEphemeris(final String id, final List<AttitudeEphemeridesBlock> blocks) {
  129.             this.id = id;
  130.             this.blocks = blocks;
  131.         }

  133.         /** {@inheritDoc} */
  134.         @Override
  135.         public String getId() {
  136.             return this.id;
  137.         }

  139.         /** {@inheritDoc} */
  140.         @Override
  141.         public List<AttitudeEphemeridesBlock> getSegments() {
  142.             return Collections.unmodifiableList(blocks);
  143.         }

  145.         /** {@inheritDoc} */
  146.         @Override
  147.         public AbsoluteDate getStart() {
  148.             return blocks.get(0).getStart();
  149.         }

  151.         /** {@inheritDoc} */
  152.         @Override
  153.         public AbsoluteDate getStop() {
  154.             return blocks.get(blocks.size() - 1).getStop();
  155.         }

  157.     }

  159.     /**
  160.      * The Attitude Ephemerides Blocks class contain metadata
  161.      * and the list of attitude data lines.
  162.      */
  163.     public class AttitudeEphemeridesBlock implements AttitudeEphemerisSegment {

  165.         /** Meta-data for the block. */
  166.         private ADMMetaData metaData;

  168.         /** The reference frame A specifier, as it appeared in the file. */
  169.         private String refFrameAString;

  171.         /** The reference frame B specifier, as it appeared in the file. */
  172.         private String refFrameBString;

  174.         /** The reference frame from which attitude is defined. */
  175.         private Frame refFrame;

  177.         /** Rotation direction of the attitude. */
  178.         private String attitudeDir;

  180.         /** Start of total time span covered by attitude data. */
  181.         private AbsoluteDate startTime;

  183.         /** End of total time span covered by attitude data. */
  184.         private AbsoluteDate stopTime;

  186.         /** Start of useable time span covered by attitude data. */
  187.         private AbsoluteDate useableStartTime;

  189.         /** End of useable time span covered by attitude data. */
  190.         private AbsoluteDate useableStopTime;

  192.         /** The format of the data lines in the message. */
  193.         private String attitudeType;

  195.         /** The placement of the scalar portion of the quaternion (QC) in the attitude data. */
  196.         private boolean isFirst;

  198.         /**
  199.          * The rotation sequence of the Euler angles.
  200.          * (e.g., 312, where X=1, Y=2, Z=3)
  201.          */
  202.         private String eulerRotSeq;

  204.         /** The rate frame specifier, as it appeared in the file. */
  205.         private String rateFrameString;

  207.         /** The interpolation method to be used. */
  208.         private String interpolationMethod;

  210.         /** The interpolation degree. */
  211.         private int interpolationDegree;

  213.         /** The rotation order. */
  214.         private RotationOrder rotationOrder;

  216.         /** List of data lines. */
  217.         private List<TimeStampedAngularCoordinates> attitudeDataLines;

  219.         /** Data Lines comments. The list contains a string for each line of comment. */
  220.         private List<String> attitudeDataLinesComment;

  222.         /** Enumerate for selecting which derivatives to use in {@link #attitudeDataLines}. */
  223.         private AngularDerivativesFilter angularDerivativesFilter;

  225.         /**
  226.          * Constructor.
  227.          */
  228.         public AttitudeEphemeridesBlock() {
  229.             attitudeDataLines = new ArrayList<>();
  230.             metaData          = new ADMMetaData(AEMFile.this);
  231.         }

  233.         /**
  234.          * Get the list of attitude data lines.
  235.          * @return a list of data
  236.          */
  237.         public List<TimeStampedAngularCoordinates> getAttitudeDataLines() {
  238.             return attitudeDataLines;
  239.         }

  241.         /** {@inheritDoc} */
  242.         @Override
  243.         public List<TimeStampedAngularCoordinates> getAngularCoordinates() {
  244.             return Collections.unmodifiableList(this.attitudeDataLines);
  245.         }

  247.         /** {@inheritDoc} */
  248.         @Override
  249.         public AngularDerivativesFilter getAvailableDerivatives() {
  250.             return angularDerivativesFilter;
  251.         }

  253.         /**
  254.          * Update the value of {@link #angularDerivativesFilter}.
  255.          *
  256.          * @param pointAngularDerivativesFilter enumerate for selecting which derivatives to use in
  257.          *                                      attitude data.
  258.          */
  259.         void updateAngularDerivativesFilter(final AngularDerivativesFilter pointAngularDerivativesFilter) {
  260.             this.angularDerivativesFilter = pointAngularDerivativesFilter;
  261.         }

  263.         /**
  264.          * Get the meta-data for the block.
  265.          * @return meta-data for the block
  266.          */
  267.         public ADMMetaData getMetaData() {
  268.             return metaData;
  269.         }

  271.         /** {@inheritDoc} */
  272.         @Override
  273.         public String getFrameCenterString() {
  274.             return this.getMetaData().getCenterName();
  275.         }

  277.         /** {@inheritDoc} */
  278.         @Override
  279.         public String getRefFrameAString() {
  280.             return refFrameAString;
  281.         }

  283.         /**
  284.          * Set the reference frame A name.
  285.          * @param frame specifier as it appeared in the file.
  286.          */
  287.         public void setRefFrameAString(final String frame) {
  288.             this.refFrameAString = frame;
  289.         }

  291.         /** {@inheritDoc} */
  292.         @Override
  293.         public String getRefFrameBString() {
  294.             return this.refFrameBString;
  295.         }

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

  305.         /**
  306.          * Get the reference frame from which attitude is defined.
  307.          * @param frame reference frame
  308.          */
  309.         public void setReferenceFrame(final Frame frame) {
  310.             this.refFrame = frame;

  312.         }

  314.         /** {@inheritDoc} */
  315.         @Override
  316.         public Frame getReferenceFrame() {
  317.             return refFrame;
  318.         }

  320.         /**
  321.          * Get the rate frame specifier as it appeared in the file.
  322.          * @return the rate frame name.
  323.          */
  324.         public String getRateFrameString() {
  325.             return rateFrameString;
  326.         }

  328.         /**
  329.          * Set the rate frame name.
  330.          * @param frame specifier as it appeared in the file.
  331.          */
  332.         public void setRateFrameString(final String frame) {
  333.             this.rateFrameString = frame;
  334.         }

  336.         /** {@inheritDoc} */
  337.         @Override
  338.         public String getAttitudeDirection() {
  339.             return attitudeDir;
  340.         }

  342.         /**
  343.          * Set the rotation direction of the attitude.
  344.          * @param direction rotation direction to be set
  345.          */
  346.         public void setAttitudeDirection(final String direction) {
  347.             this.attitudeDir = direction;
  348.         }

  350.         /** {@inheritDoc} */
  351.         @Override
  352.         public String getAttitudeType() {
  353.             return attitudeType;
  354.         }

  356.         /**
  357.          * Set the format of the data lines in the message.
  358.          * @param type format to be set
  359.          */
  360.         public void setAttitudeType(final String type) {
  361.             this.attitudeType = type;
  362.         }

  364.         /** {@inheritDoc} */
  365.         @Override
  366.         public boolean isFirst() {
  367.             return isFirst;
  368.         }

  370.         /**
  371.          * Set the flag for the placement of the quaternion QC in the attitude data.
  372.          * @param isFirst true if QC is the first element in the attitude data
  373.          */
  374.         public void setIsFirst(final boolean isFirst) {
  375.             this.isFirst = isFirst;
  376.         }

  378.         /**
  379.          * Get the rotation sequence of the Euler angles (e.g., 312, where X=1, Y=2, Z=3).
  380.          * @return the rotation sequence of the Euler angles
  381.          */
  382.         public String getEulerRotSeq() {
  383.             return eulerRotSeq;
  384.         }

  386.         /**
  387.          * Set the rotation sequence of the Euler angles (e.g., 312, where X=1, Y=2, Z=3).
  388.          * @param eulerRotSeq rotation sequence to be set
  389.          */
  390.         public void setEulerRotSeq(final String eulerRotSeq) {
  391.             this.eulerRotSeq = eulerRotSeq;
  392.         }

  394.         /** {@inheritDoc} */
  395.         @Override
  396.         public String getTimeScaleString() {
  397.             return metaData.getTimeSystem().toString();
  398.         }

  400.         /** {@inheritDoc} */
  401.         @Override
  402.         public TimeScale getTimeScale() {
  403.             return metaData.getTimeScale();
  404.         }

  406.         /**
  407.          * Get start of total time span covered by attitude data.
  408.          * @return the start time
  409.          */
  410.         public AbsoluteDate getStartTime() {
  411.             return startTime;
  412.         }

  414.         /**
  415.          * Set start of total time span covered by attitude data.
  416.          * @param startTime the time to be set
  417.          */
  418.         public void setStartTime(final AbsoluteDate startTime) {
  419.             this.startTime = startTime;
  420.         }

  422.         /**
  423.          * Get end of total time span covered by attitude data.
  424.          * @return the stop time
  425.          */
  426.         public AbsoluteDate getStopTime() {
  427.             return stopTime;
  428.         }

  430.         /**
  431.          * Set end of total time span covered by attitude data.
  432.          * @param stopTime the time to be set
  433.          */
  434.         public void setStopTime(final AbsoluteDate stopTime) {
  435.             this.stopTime = stopTime;
  436.         }

  438.         /**
  439.          * Get start of useable time span covered by attitude data.
  440.          * @return the useable start time
  441.          */
  442.         public AbsoluteDate getUseableStartTime() {
  443.             return useableStartTime;
  444.         }

  446.         /**
  447.          * Set start of useable time span covered by attitude data.
  448.          * @param useableStartTime the time to be set
  449.          */
  450.         public void setUseableStartTime(final AbsoluteDate useableStartTime) {
  451.             this.useableStartTime = useableStartTime;
  452.         }

  454.         /**
  455.          * Get end of useable time span covered by ephemerides data.
  456.          * @return the useable stop time
  457.          */
  458.         public AbsoluteDate getUseableStopTime() {
  459.             return useableStopTime;
  460.         }

  462.         /**
  463.          * Set end of useable time span covered by ephemerides data.
  464.          * @param useableStopTime the time to be set
  465.          */
  466.         public void setUseableStopTime(final AbsoluteDate useableStopTime) {
  467.             this.useableStopTime = useableStopTime;
  468.         }

  470.         /** {@inheritDoc} */
  471.         @Override
  472.         public AbsoluteDate getStart() {
  473.             // usable start time overrides start time if it is set
  474.             final AbsoluteDate start = this.getUseableStartTime();
  475.             if (start != null) {
  476.                 return start;
  477.             } else {
  478.                 return this.getStartTime();
  479.             }
  480.         }

  482.         /** {@inheritDoc} */
  483.         @Override
  484.         public AbsoluteDate getStop() {
  485.             // useable stop time overrides stop time if it is set
  486.             final AbsoluteDate stop = this.getUseableStopTime();
  487.             if (stop != null) {
  488.                 return stop;
  489.             } else {
  490.                 return this.getStopTime();
  491.             }
  492.         }

  494.         /** {@inheritDoc} */
  495.         @Override
  496.         public String getInterpolationMethod() {
  497.             return interpolationMethod;
  498.         }

  500.         /**
  501.          * Set the interpolation method to be used.
  502.          * @param interpolationMethod the interpolation method to be set
  503.          */
  504.         public void setInterpolationMethod(final String interpolationMethod) {
  505.             this.interpolationMethod = interpolationMethod;
  506.         }

  508.         /**
  509.          * Get the interpolation degree.
  510.          * @return the interpolation degree
  511.          */
  512.         public int getInterpolationDegree() {
  513.             return interpolationDegree;
  514.         }

  516.         /**
  517.          * Set the interpolation degree.
  518.          * @param interpolationDegree the interpolation degree to be set
  519.          */
  520.         public void setInterpolationDegree(final int interpolationDegree) {
  521.             this.interpolationDegree = interpolationDegree;
  522.         }

  524.         /** {@inheritDoc} */
  525.         @Override
  526.         public int getInterpolationSamples() {
  527.             // From the standard it is not entirely clear how to interpret the degree.
  528.             return getInterpolationDegree() + 1;
  529.         }

  531.         /** Get the attitude data lines comment.
  532.          * @return the comment
  533.          */
  534.         public List<String> getAttitudeDataLinesComment() {
  535.             return attitudeDataLinesComment;
  536.         }

  538.         /** Set the attitude data lines comment.
  539.          * @param ephemeridesDataLinesComment the comment to be set
  540.          */
  541.         public void setAttitudeDataLinesComment(final List<String> ephemeridesDataLinesComment) {
  542.             this.attitudeDataLinesComment = new ArrayList<String>(ephemeridesDataLinesComment);
  543.         }

  545.         /** {@inheritDoc} */
  546.         @Override
  547.         public RotationOrder getRotationOrder() {
  548.             return rotationOrder;
  549.         }

  551.         /**
  552.          * Set the rotation order for Euler angles.
  553.          * @param order the rotation order to be set
  554.          */
  555.         public void setRotationOrder(final RotationOrder order) {
  556.             this.rotationOrder = order;
  557.         }

  559.     }


  562. }
Created with JaCoCo 0.8.6.202009150832