CenterName.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 org.orekit.annotation.DefaultDataContext;
  20. import org.orekit.bodies.CelestialBodies;
  21. import org.orekit.bodies.CelestialBody;
  22. import org.orekit.data.DataContext;

  24. /** Orbit central bodies for which a Celestial body can be created.
  25.  * @author sports
  26.  * @since 6.1
  27.  */
  28. public enum CenterName {
  29.     /** Solar system barycenter aggregated body. */
  30.     SOLAR_SYSTEM_BARYCENTER {

  32.         /** {@inheritDoc}
  33.          * @param celestialBodies*/
  34.         public CelestialBody getCelestialBody(final CelestialBodies celestialBodies) {
  35.             return celestialBodies.getSolarSystemBarycenter();
  36.         }
  37.     },
  38.     /** Sun body. */
  39.     SUN {

  41.         /** {@inheritDoc}
  42.          * @param celestialBodies*/
  43.         public CelestialBody getCelestialBody(final CelestialBodies celestialBodies) {
  44.             return celestialBodies.getSun();
  45.         }
  46.     },
  47.     /** Mercury body. */
  48.     MERCURY {

  50.         /** {@inheritDoc}
  51.          * @param celestialBodies*/
  52.         public CelestialBody getCelestialBody(final CelestialBodies celestialBodies) {
  53.             return celestialBodies.getMercury();
  54.         }
  55.     },
  56.     /** Venus body. */
  57.     VENUS {

  59.         /** {@inheritDoc}
  60.          * @param celestialBodies*/
  61.         public CelestialBody getCelestialBody(final CelestialBodies celestialBodies) {
  62.             return celestialBodies.getVenus();
  63.         }
  64.     },
  65.     /** Earth-Moon barycenter bodies pair. */
  66.     EARTH_MOON {

  68.         /** {@inheritDoc}
  69.          * @param celestialBodies*/
  70.         public CelestialBody getCelestialBody(final CelestialBodies celestialBodies) {
  71.             return celestialBodies.getEarthMoonBarycenter();
  72.         }
  73.     },
  74.     /** Earth body. */
  75.     EARTH {

  77.         /** {@inheritDoc}
  78.          * @param celestialBodies*/
  79.         public CelestialBody getCelestialBody(final CelestialBodies celestialBodies) {
  80.             return celestialBodies.getEarth();
  81.         }
  82.     },
  83.     /** Moon body. */
  84.     MOON {

  86.         /** {@inheritDoc}
  87.          * @param celestialBodies*/
  88.         public CelestialBody getCelestialBody(final CelestialBodies celestialBodies) {
  89.             return celestialBodies.getMoon();
  90.         }
  91.     },
  92.     /** Mars body. */
  93.     MARS {

  95.         /** {@inheritDoc}
  96.          * @param celestialBodies*/
  97.         public CelestialBody getCelestialBody(final CelestialBodies celestialBodies) {
  98.             return celestialBodies.getMars();
  99.         }
  100.     },
  101.     /** Jupiter body. */
  102.     JUPITER {

  104.         /** {@inheritDoc}
  105.          * @param celestialBodies*/
  106.         public CelestialBody getCelestialBody(final CelestialBodies celestialBodies) {
  107.             return celestialBodies.getJupiter();
  108.         }
  109.     },
  110.     /** Saturn body. */
  111.     SATURN {

  113.         /** {@inheritDoc}
  114.          * @param celestialBodies*/
  115.         public CelestialBody getCelestialBody(final CelestialBodies celestialBodies) {
  116.             return celestialBodies.getSaturn();
  117.         }
  118.     },
  119.     /** Uranus body. */
  120.     URANUS {

  122.         /** {@inheritDoc}
  123.          * @param celestialBodies*/
  124.         public CelestialBody getCelestialBody(final CelestialBodies celestialBodies) {
  125.             return celestialBodies.getUranus();
  126.         }
  127.     },
  128.     /** Neptune body. */
  129.     NEPTUNE {

  131.         /** {@inheritDoc}
  132.          * @param celestialBodies*/
  133.         public CelestialBody getCelestialBody(final CelestialBodies celestialBodies) {
  134.             return celestialBodies.getNeptune();
  135.         }
  136.     },
  137.     /** Pluto body. */
  138.     PLUTO {

  140.         /** {@inheritDoc}
  141.          * @param celestialBodies*/
  142.         public CelestialBody getCelestialBody(final CelestialBodies celestialBodies) {
  143.             return celestialBodies.getPluto();
  144.         }
  145.     };

  147.     /**
  148.      * Get the celestial body corresponding to the CCSDS constant.
  149.      *
  150.      * <p>This method uses the {@link DataContext#getDefault() default data context}.
  151.      *
  152.      * @return celestial body corresponding to the CCSDS constant
  153.      * @see #getCelestialBody(CelestialBodies)
  154.      */
  155.     @DefaultDataContext
  156.     public CelestialBody getCelestialBody() {
  157.         return getCelestialBody(DataContext.getDefault().getCelestialBodies());
  158.     }

  160.     /**
  161.      * Get the celestial body corresponding to the CCSDS constant.
  162.      *
  163.      * @param celestialBodies the set of celestial bodies to use.
  164.      * @return celestial body corresponding to the CCSDS constant
  165.      * @since 10.1
  166.      */
  167.     public abstract CelestialBody getCelestialBody(CelestialBodies celestialBodies);

  169. }
Created with JaCoCo 0.8.6.202009150832