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

  19. import java.util.List;
  20. import java.util.stream.Collectors;
  21. import java.util.stream.Stream;

  23. import org.hipparchus.geometry.euclidean.threed.Vector3D;
  24. import org.hipparchus.util.Precision;
  25. import org.orekit.annotation.DefaultDataContext;
  26. import org.orekit.errors.OrekitException;
  27. import org.orekit.errors.OrekitMessages;
  28. import org.orekit.files.ccsds.ndm.odm.ocm.Ocm;
  29. import org.orekit.frames.FramesFactory;
  30. import org.orekit.orbits.EquinoctialOrbit;
  31. import org.orekit.orbits.KeplerianOrbit;
  32. import org.orekit.orbits.PositionAngle;
  33. import org.orekit.time.AbsoluteDate;
  34. import org.orekit.utils.TimeStampedPVCoordinates;
  35. import org.orekit.utils.units.Unit;

  37. /** Orbit element set type used in CCSDS {@link Ocm Orbit Comprehensive Messages}.
  38.  * @see <a href="https://sanaregistry.org/r/orbital_elements">SANA registry for orbital elements</a>
  39.  * @author Luc Maisonobe
  40.  * @since 11.0
  41.  */
  42. public enum ElementsType {

  44.     // CHECKSTYLE: stop MultipleStringLiterals check

  46.     /** Spherical 6-element set (α,δ,β,A,r,v). */
  47.     ADBARV("Spherical 6-element set (α,δ,β,A,r,v)",
  48.            "°", "°", "°", "°", "km", "km"),

  50.     /** Cartesian 3-element position (X, Y, Z). */
  51.     CARTP("Cartesian 3-element position (X, Y, Z)",
  52.           "km", "km", "km") {
  53.         /** {@inheritDoc} */
  54.         @Override
  55.         public TimeStampedPVCoordinates toCartesian(final AbsoluteDate date, final double[] elements, final double mu) {
  56.             return new TimeStampedPVCoordinates(date,
  57.                                                 new Vector3D(elements[0], elements[1], elements[2]),
  58.                                                 Vector3D.ZERO,
  59.                                                 Vector3D.ZERO);
  60.         }
  61.     },

  63.     /** Cartesian 6-element position and velocity (X, Y, Z, XD, YD, ZD). */
  64.     CARTPV("Cartesian 6-element position and velocity (X, Y, Z, XD, YD, ZD)",
  65.            "km", "km", "km", "km/s", "km/s", "km/s") {
  66.         /** {@inheritDoc} */
  67.         @Override
  68.         public TimeStampedPVCoordinates toCartesian(final AbsoluteDate date, final double[] elements, final double mu) {
  69.             return new TimeStampedPVCoordinates(date,
  70.                                                 new Vector3D(elements[0], elements[1], elements[2]),
  71.                                                 new Vector3D(elements[3], elements[4], elements[5]),
  72.                                                 Vector3D.ZERO);
  73.         }
  74.     },

  76.     /** Cartesian 9-element position, velocity and acceleration (X, Y, Z, XD, YD, ZD, XDD, YDD, ZDD). */
  77.     CARTPVA("Cartesian 9-element position, velocity and acceleration (X, Y, Z, XD, YD, ZD, XDD, YDD, ZDD)",
  78.             "km", "km", "km", "km/s", "km/s", "km/s", "km/s²", "km/s²", "km/s²") {
  79.         /** {@inheritDoc} */
  80.         @Override
  81.         public TimeStampedPVCoordinates toCartesian(final AbsoluteDate date, final double[] elements, final double mu) {
  82.             return new TimeStampedPVCoordinates(date,
  83.                                                 new Vector3D(elements[0], elements[1], elements[2]),
  84.                                                 new Vector3D(elements[3], elements[4], elements[5]),
  85.                                                 new Vector3D(elements[6], elements[7], elements[8]));
  86.         }
  87.     },

  89.     /** Delaunay elements (L, G, H, l, g, h). */
  90.     DELAUNAY("Delaunay elements (L, G, H, l, g, h)",
  91.              "km²/s", "km²/s", "km²/s", "°", "°", "°"),

  93.     /** Modified Delaunay elements (Lm, Gm, Hm, lm, gm, hm). */
  94.     DELAUNAYMOD("Delaunay elements (Lm, Gm, Hm, lm, gm, hm)",
  95.                 "√km", "√km", "√km", "°", "°", "°"),

  97.     /** 12 elements eigenvalue/eigenvectors (EigMaj, EigMed, EigMin, EigVecMaj, EigVecMed, EigVecMin). */
  98.     EIGVAL3EIGVEC3("12 elements eigenvalue/eigenvectors (EigMaj, EigMed, EigMin, EigVecMaj, EigVecMed, EigVecMin)",
  99.                    "km", "km", "km", "n/a", "n/a", "n/a", "n/a", "n/a", "n/a", "n/a", "n/a", "n/a"),

  101.     /** Equinoctial elements (a, af, ag, L=M+ω+frΩ, χ, ψ, fr). */
  102.     EQUINOCTIAL("Equinoctial elements (a, af, ag, L=M+ω+frΩ, χ, ψ, fr)",
  103.                 "km", "n/a", "n/a", "°", "n/a", "n/a", "n/a") {
  104.         /** {@inheritDoc} */
  105.         @Override
  106.         @DefaultDataContext
  107.         public TimeStampedPVCoordinates toCartesian(final AbsoluteDate date, final double[] elements, final double mu) {
  108.             if (elements[6] < 0) {
  109.                 // retrograde
  110.                 throw new OrekitException(OrekitMessages.CCSDS_UNSUPPORTED_RETROGRADE_EQUINOCTIAL,
  111.                                           EQUINOCTIAL.name());
  112.             }
  113.             return new EquinoctialOrbit(elements[0], elements[1], elements[2],
  114.                                         elements[5], elements[4], // BEWARE! the inversion here is intentional
  115.                                         elements[3], PositionAngle.MEAN,
  116.                                         FramesFactory.getGCRF(), date, mu).
  117.                             getPVCoordinates();
  118.         }
  119.     },

  121.     /** Modified equinoctial elements (p=a(1−e²), af, ag, L'=υ+ω+frΩ, χ, ψ, fr). */
  122.     EQUINOCTIALMOD("Modified equinoctial elements (p=a(1−e²), af, ag, L'=υ+ω+frΩ, χ, ψ, fr)",
  123.                    "km", "n/a", "n/a", "°", "n/a", "n/a", "n/a") {
  124.         /** {@inheritDoc} */
  125.         @Override
  126.         @DefaultDataContext
  127.         public TimeStampedPVCoordinates toCartesian(final AbsoluteDate date, final double[] elements, final double mu) {
  128.             if (elements[6] < 0) {
  129.                 // retrograde
  130.                 throw new OrekitException(OrekitMessages.CCSDS_UNSUPPORTED_RETROGRADE_EQUINOCTIAL,
  131.                                           EQUINOCTIALMOD.name());
  132.             }
  133.             final double oMe2 = 1.0 - elements[1] * elements[1] - elements[2] * elements[2];
  134.             return new EquinoctialOrbit(elements[0] / oMe2, elements[1], elements[2],
  135.                                         elements[5], elements[4], // BEWARE! the inversion here is intentional
  136.                                         elements[3], PositionAngle.TRUE,
  137.                                         FramesFactory.getGCRF(), date, mu).
  138.                             getPVCoordinates();
  139.         }
  140.     },

  142.     /** Geodetic elements (λ, ΦGD, β, A, h, vre). */
  143.     GEODETIC("Geodetic elements (λ, ΦGD, β, A, h, vre)",
  144.              "°", "°", "°", "°", "km", "km/s"),

  146.     /** Keplerian 6-element classical set (a, e, i, Ω, ω, ν). */
  147.     KEPLERIAN("Keplerian 6-elemnt classical set (a, e, i, Ω, ω, ν)",
  148.               "km", "n/a", "°", "°", "°", "°") {
  149.         /** {@inheritDoc} */
  150.         @Override
  151.         @DefaultDataContext
  152.         public TimeStampedPVCoordinates toCartesian(final AbsoluteDate date, final double[] elements, final double mu) {
  153.             return new KeplerianOrbit(elements[0], elements[1], elements[2],
  154.                                       elements[4], elements[3], // BEWARE! the inversion here is intentional
  155.                                       elements[5], PositionAngle.TRUE,
  156.                                       FramesFactory.getGCRF(), date, mu).
  157.                    getPVCoordinates();
  158.         }
  159.     },

  161.     /** Keplerian 6-element classical set (a, e, i, Ω, ω, M). */
  162.     KEPLERIANMEAN("Keplerian 6-elemnt classical set (a, e, i, Ω, ω, M)",
  163.                   "km", "n/a", "°", "°", "°", "°") {
  164.         /** {@inheritDoc} */
  165.         @Override
  166.         @DefaultDataContext
  167.         public TimeStampedPVCoordinates toCartesian(final AbsoluteDate date, final double[] elements, final double mu) {
  168.             return new KeplerianOrbit(elements[0], elements[1], elements[2],
  169.                                       elements[4], elements[3], // BEWARE! the inversion here is intentional
  170.                                       elements[5], PositionAngle.MEAN,
  171.                                       FramesFactory.getGCRF(), date, mu).
  172.                    getPVCoordinates();
  173.         }
  174.     },

  176.     /** Modified spherical 6-element set (λ, δ, β, A, r, v). */
  177.     LDBARV("Modified spherical 6-element set (λ, δ, β, A, r, v)",
  178.            "°", "°", "°", "°", "km", "km/s"),

  180.     /** Geosynchronous on-station tailored set (a, ex, ey, ix, iy, λ). */
  181.     ONSTATION("Geosynchronous on-station tailored set (a, ex, ey, ix, iy, λ)",
  182.               "km", "n/a", "n/a", "n/a", "n/a", "°"),

  184.     /** Canonical counterpart of equinoctial 6-element set (λM=M+ω+Ω, gp, hp, Lp, Gp, Hp). */
  185.     POINCARE("Canonical counterpart of equinoctial 6-element set (λM=M+ω+Ω, gp, hp, Lp, Gp, Hp)",
  186.              "°", "km/√s", "km/√s", "km²/s", "km/√s", "km/√s");

  188.     // CHECKSTYLE: resume MultipleStringLiterals check

  190.     /** Description. */
  191.     private final String description;

  193.     /** Elements units. */
  194.     private final List<Unit> units;

  196.     /** Simple constructor.
  197.      * @param description description
  198.      * @param unitsSpecifications elements units specifications
  199.      */
  200.     ElementsType(final String description, final String... unitsSpecifications) {
  201.         this.description = description;
  202.         this.units       = Stream.of(unitsSpecifications).
  203.                            map(s -> Unit.parse(s)).
  204.                            collect(Collectors.toList());
  205.     }

  207.     /** Get the elements units.
  208.      * @return elements units
  209.      */
  210.     public List<Unit> getUnits() {
  211.         return units;
  212.     }

  214.     /** Check if parsed units are compatible with elements types.
  215.      * @param parsedUnits units to check
  216.      */
  217.     public void checkUnits(final List<Unit> parsedUnits) {
  218.         if (parsedUnits.size() != units.size()) {
  219.             throw new OrekitException(OrekitMessages.CCSDS_ELEMENT_SET_WRONG_NB_COMPONENTS,
  220.                                       name(), toString(), units.size());
  221.         }
  222.         for (int i = 0; i < units.size(); ++i) {
  223.             if (!(units.get(i).sameDimension(parsedUnits.get(i)) &&
  224.                   Precision.equals(units.get(i).getScale(), parsedUnits.get(i).getScale(), 1))) {
  225.                 throw new OrekitException(OrekitMessages.INCOMPATIBLE_UNITS,
  226.                                           units.get(i).getName(),
  227.                                           parsedUnits.get(i).getName());
  228.             }
  229.         }
  230.     }

  232.     /** Convert to Cartesian coordinates.
  233.      * @param date elements date
  234.      * @param elements elements values
  235.      * @param mu gravitational parameter in m³/s²
  236.      * @return Cartesian coordinates
  237.      */
  238.     public TimeStampedPVCoordinates toCartesian(final AbsoluteDate date, final double[] elements, final double mu) {
  239.         throw new OrekitException(OrekitMessages.CCSDS_UNSUPPORTED_ELEMENT_SET_TYPE, name(), toString());
  240.     }

  242.     /** {@inheritDoc} */
  243.     @Override
  244.     public String toString() {
  245.         return description;
  246.     }

  248. }
Created with JaCoCo 0.8.8.202204050719