AttitudeEphemerisFile.java

  1. /* Contributed in the public domain.
  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.general;

  19. import java.util.ArrayList;
  20. import java.util.List;
  21. import java.util.Map;

  23. import org.hipparchus.geometry.euclidean.threed.RotationOrder;
  24. import org.orekit.attitudes.AggregateBoundedAttitudeProvider;
  25. import org.orekit.attitudes.BoundedAttitudeProvider;
  26. import org.orekit.frames.Frame;
  27. import org.orekit.time.AbsoluteDate;
  28. import org.orekit.time.TimeScale;
  29. import org.orekit.utils.AngularDerivativesFilter;
  30. import org.orekit.utils.TimeStampedAngularCoordinates;

  32. /**
  33.  * An interface for accessing the data stored in an attitude ephemeris file.
  34.  *
  35.  * <p> An {@link AttitudeEphemerisFile} consists of one or more satellites each with a unique ID
  36.  * within the file. The ephemeris for each satellite consists of one or more segments.
  37.  *
  38.  * <p> Some attitude ephemeris file formats may supply additional information that is not available
  39.  * via this interface. In those cases it is recommended that the parser return a subclass
  40.  * of this interface to provide access to the additional information.
  41.  *
  42.  * @author Raphaël Fermé
  43.  * @see SatelliteAttitudeEphemeris
  44.  * @see AttitudeEphemerisSegment
  45.  * @since 10.3
  46.  */
  47. public interface AttitudeEphemerisFile {

  49.     /**
  50.      * Get the loaded ephemeris for each satellite in the file.
  51.      *
  52.      * @return a map from the satellite's ID to the information about that satellite
  53.      * contained in the file.
  54.      */
  55.     Map<String, ? extends SatelliteAttitudeEphemeris> getSatellites();

  57.     /**
  58.      * Contains the information about a single satellite from an {@link AttitudeEphemerisFile}.
  59.      *
  60.      * <p> A satellite ephemeris consists of one or more {@link AttitudeEphemerisSegment}.
  61.      * Segments are typically used to split up an ephemeris at discontinuous events.
  62.      *
  63.      * @author Raphaël Fermé
  64.      * @see AttitudeEphemerisFile
  65.      * @see AttitudeEphemerisSegment
  66.      * @since 10.3
  67.      */
  68.     interface SatelliteAttitudeEphemeris {

  70.         /**
  71.          * Get the satellite ID. The satellite ID is unique only within the same ephemeris
  72.          * file.
  73.          *
  74.          * @return the satellite's ID, never {@code null}.
  75.          */
  76.         String getId();

  78.         /**
  79.          * Get the segments of the attitude ephemeris.
  80.          *
  81.          * <p> Attitude ephemeris segments are typically used to split an ephemeris around
  82.          * discontinuous events.
  83.          *
  84.          * @return the segments contained in the attitude ephemeris file for this satellite.
  85.          */
  86.         List<? extends AttitudeEphemerisSegment> getSegments();

  88.         /**
  89.          * Get the start date of the ephemeris.
  90.          *
  91.          * @return ephemeris start date.
  92.          */
  93.         AbsoluteDate getStart();

  95.         /**
  96.          * Get the end date of the ephemeris.
  97.          *
  98.          * @return ephemeris end date.
  99.          */
  100.         AbsoluteDate getStop();

  102.         /**
  103.          * Get the attitude provider corresponding to this ephemeris, combining data from all {@link
  104.          * #getSegments() segments}.
  105.          *
  106.          * @return an attitude provider for all the data in this attitude ephemeris file.
  107.          */
  108.         default BoundedAttitudeProvider getAttitudeProvider() {
  109.             final List<BoundedAttitudeProvider> providers = new ArrayList<>();
  110.             for (final AttitudeEphemerisSegment attitudeSegment : this.getSegments()) {
  111.                 providers.add(attitudeSegment.getAttitudeProvider());
  112.             }
  113.             return new AggregateBoundedAttitudeProvider(providers);
  114.         }

  116.     }

  118.     /**
  119.      * A segment of an attitude ephemeris for a satellite.
  120.      *
  121.      * <p> Segments are typically used to split an ephemeris around discontinuous events
  122.      * such as maneuvers.
  123.      *
  124.      * @author Raphaël Fermé
  125.      * @see AttitudeEphemerisFile
  126.      * @see SatelliteAttitudeEphemeris
  127.      * @since 10.3
  128.      */
  129.     interface AttitudeEphemerisSegment {

  131.         /**
  132.          * Get an unmodifiable list of attitude data lines.
  133.          *
  134.          * @return a list of attitude data
  135.          */
  136.         List<? extends TimeStampedAngularCoordinates> getAngularCoordinates();

  138.         /**
  139.          * Get the name of the center of the coordinate system the ephemeris is provided
  140.          * in. This may be a natural origin, such as the center of the Earth, another
  141.          * satellite, etc.
  142.          *
  143.          * @return the name of the frame center
  144.          */
  145.         String getFrameCenterString();

  147.         /**
  148.          * Get the reference frame A specifier as it appeared in the file.
  149.          *
  150.          * @return the frame name as it appeared in the file (A).
  151.          */
  152.         String getRefFrameAString();

  154.         /**
  155.          * Get the reference frame B specifier as it appeared in the file.
  156.          *
  157.          * @return the frame name as it appeared in the file (B).
  158.          */
  159.         String getRefFrameBString();

  161.         /**
  162.          * Get the reference frame from which attitude is defined.
  163.          *
  164.          * @return the reference frame from which attitude is defined
  165.          */
  166.         Frame getReferenceFrame();

  168.         /**
  169.          * Get the rotation direction of the attitude.
  170.          *
  171.          * @return the rotation direction of the attitude
  172.          */
  173.         String getAttitudeDirection();

  175.         /**
  176.          * Get the format of the data lines in the message.
  177.          *
  178.          * @return the format of the data lines in the message
  179.          */
  180.         String getAttitudeType();

  182.         /**
  183.          * Get the flag for the placement of the quaternion QC in the attitude data.
  184.          *
  185.          * @return true if QC is the first element in the attitude data
  186.          */
  187.         boolean isFirst();

  189.         /**
  190.          * Get the rotation order for Euler angles.
  191.          *
  192.          * @return rotation order
  193.          */
  194.         RotationOrder getRotationOrder();

  196.         /**
  197.          * Get the time scale for this ephemeris segment.
  198.          *
  199.          * @return the time scale identifier, as specified in the ephemeris file, or
  200.          * {@code null} if the ephemeris file does not specify a time scale.
  201.          */
  202.         String getTimeScaleString();

  204.         /**
  205.          * Get the time scale for this ephemeris segment.
  206.          *
  207.          * @return the time scale for this segment. Never {@code null}.
  208.          */
  209.         TimeScale getTimeScale();

  211.         /**
  212.          * Get the start date of this ephemeris segment.
  213.          *
  214.          * @return ephemeris segment start date.
  215.          */
  216.         AbsoluteDate getStart();

  218.         /**
  219.          * Get the end date of this ephemeris segment.
  220.          *
  221.          * @return ephemeris segment end date.
  222.          */
  223.         AbsoluteDate getStop();

  225.         /**
  226.          * Get the interpolation method to be used.
  227.          *
  228.          * @return the interpolation method
  229.          */
  230.         String getInterpolationMethod();

  232.         /**
  233.          * Get the number of samples to use in interpolation.
  234.          *
  235.          * @return the number of points to use for interpolation.
  236.          */
  237.         int getInterpolationSamples();

  239.         /**
  240.          * Get which derivatives of angular data are available in this attitude ephemeris segment.
  241.          *
  242.          * @return a value indicating if the file contains rotation and/or rotation rate
  243.          *         and/or acceleration data.
  244.          */
  245.         AngularDerivativesFilter getAvailableDerivatives();

  247.         /**
  248.          * Get the attitude provider for this attitude ephemeris segment.
  249.          *
  250.          * @return the attitude provider for this attitude ephemeris segment.
  251.          */
  252.         default BoundedAttitudeProvider getAttitudeProvider() {
  253.             return new EphemerisSegmentAttitudeProvider(this);
  254.         }

  256.     }

  258. }
Created with JaCoCo 0.8.6.202009150832