Predefined.java

  1. /* Copyright 2002-2013 CS Systèmes d'Information
  2.  * Licensed to CS Systèmes d'Information (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.frames;


  18. /** Predefined frames provided by {@link FramesFactory}.
  19.  * @author Luc Maisonobe
  20.  */
  21. public enum Predefined {

  22.     /** GCRF frame.*/
  23.     GCRF(Frame.getRoot().getName()),

  24.     /** ICRF frame.*/
  25.     ICRF("ICRF"),

  26.     /** EME2000 frame.*/
  27.     EME2000("EME2000"),

  28.     /** CIO-based ITRF, IERS 2010 conventions with simple EOP interpolation.
  29.      * @since 6.1
  30.      */
  31.     ITRF_CIO_CONV_2010_SIMPLE_EOP("CIO/2010-based ITRF simple EOP"),

  32.     /** CIO-based ITRF, IERS 2010 conventions with accurate EOP interpolation.
  33.      * @since 6.1
  34.      */
  35.     ITRF_CIO_CONV_2010_ACCURATE_EOP("CIO/2010-based ITRF accurate EOP"),

  36.     /** CIO-based ITRF, IERS 2003 conventions with simple EOP interpolation.
  37.      * @since 6.1
  38.      */
  39.     ITRF_CIO_CONV_2003_SIMPLE_EOP("CIO/2003-based ITRF simple EOP"),

  40.     /** CIO-based ITRF, IERS 2003 conventions with accurate EOP interpolation.
  41.      * @since 6.1
  42.      */
  43.     ITRF_CIO_CONV_2003_ACCURATE_EOP("CIO/2003-based ITRF accurate EOP"),

  44.     /** CIO-based ITRF, IERS 1996 conventions with simple EOP interpolation.
  45.      * @since 6.1
  46.      */
  47.     ITRF_CIO_CONV_1996_SIMPLE_EOP("CIO/1996-based ITRF simple EOP"),

  48.     /** CIO-based ITRF, IERS 1996 conventions with accurate EOP interpolation.
  49.      * @since 6.1
  50.      */
  51.     ITRF_CIO_CONV_1996_ACCURATE_EOP("CIO/1996-based ITRF accurate EOP"),

  52.     /** ITRF2008 with simple EOP interpolation.
  53.      * @deprecated as of 6.1, replaced with {@link #ITRF_CIO_CONV_2010_SIMPLE_EOP}
  54.      */
  55.     @Deprecated
  56.     ITRF_2008_WITHOUT_TIDAL_EFFECTS("ITRF2008 accurate EOP"),

  57.     /** ITRF2008 with accurate EOP interpolation.
  58.      * @deprecated as of 6.1, replaced with {@link #ITRF_CIO_CONV_2010_ACCURATE_EOP}
  59.      */
  60.     @Deprecated
  61.     ITRF_2008_WITH_TIDAL_EFFECTS("ITRF2008 simple EOP"),

  62.     /** ITRF2005 with simple EOP interpolation.
  63.      * @deprecated as of 6.1, replaced with {@link #ITRF_CIO_CONV_2010_SIMPLE_EOP}
  64.      * and {@link HelmertTransformation.Predefined#ITRF_2008_TO_ITRF_2005}
  65.      */
  66.     @Deprecated
  67.     ITRF_2005_WITHOUT_TIDAL_EFFECTS("ITRF2005 accurate EOP"),

  68.     /** ITRF2005 with accurate EOP interpolation.
  69.      * @deprecated as of 6.1, replaced with {@link #ITRF_CIO_CONV_2010_ACCURATE_EOP}
  70.      * and {@link HelmertTransformation.Predefined#ITRF_2008_TO_ITRF_2005}
  71.      */
  72.     @Deprecated
  73.     ITRF_2005_WITH_TIDAL_EFFECTS("ITRF2005 simple EOP"),

  74.     /** ITRF2000 with simple EOP interpolation.
  75.      * @deprecated as of 6.1, replaced with {@link #ITRF_CIO_CONV_2010_SIMPLE_EOP}
  76.      * and {@link HelmertTransformation.Predefined#ITRF_2008_TO_ITRF_2000}
  77.      */
  78.     @Deprecated
  79.     ITRF_2000_WITHOUT_TIDAL_EFFECTS("ITRF2000 accurate EOP"),

  80.     /** ITRF2000 with accurate EOP interpolation.
  81.      * @deprecated as of 6.1, replaced with {@link #ITRF_CIO_CONV_2010_ACCURATE_EOP}
  82.      * and {@link HelmertTransformation.Predefined#ITRF_2008_TO_ITRF_2000}
  83.      */
  84.     @Deprecated
  85.     ITRF_2000_WITH_TIDAL_EFFECTS("ITRF2000 simple EOP"),

  86.     /** ITRF97 with simple EOP interpolation.
  87.      * @deprecated as of 6.1, replaced with {@link #ITRF_CIO_CONV_2010_SIMPLE_EOP}
  88.      * and {@link HelmertTransformation.Predefined#ITRF_2008_TO_ITRF_97}
  89.      */
  90.     @Deprecated
  91.     ITRF_97_WITHOUT_TIDAL_EFFECTS("ITRF97 accurate EOP"),

  92.     /** ITRF97 with accurate EOP interpolation.
  93.      * @deprecated as of 6.1, replaced with {@link #ITRF_CIO_CONV_2010_ACCURATE_EOP}
  94.      * and {@link HelmertTransformation.Predefined#ITRF_2008_TO_ITRF_97}
  95.      */
  96.     @Deprecated
  97.     ITRF_97_WITH_TIDAL_EFFECTS("ITRF97 simple EOP"),

  98.     /** ITRF93 with simple EOP interpolation.
  99.      * @deprecated as of 6.1, replaced with {@link #ITRF_CIO_CONV_2010_SIMPLE_EOP}
  100.      * and {@link HelmertTransformation.Predefined#ITRF_2008_TO_ITRF_93}
  101.      */
  102.     @Deprecated
  103.     ITRF_93_WITHOUT_TIDAL_EFFECTS("ITRF93 accurate EOP"),

  104.     /** ITRF93 with accurate EOP interpolation.
  105.      * @deprecated as of 6.1, replaced with {@link #ITRF_CIO_CONV_2010_ACCURATE_EOP}
  106.      * and {@link HelmertTransformation.Predefined#ITRF_2008_TO_ITRF_93}
  107.      */
  108.     @Deprecated
  109.     ITRF_93_WITH_TIDAL_EFFECTS("ITRF93 simple EOP"),

  110.     /** Equinox-based ITRF, IERS 2010 conventions with simple EOP interpolation.
  111.      * @since 6.1
  112.      */
  113.     ITRF_EQUINOX_CONV_2010_SIMPLE_EOP("Equinox/2010-based ITRF simple EOP"),

  114.     /** Equinox-based ITRF, IERS 2010 conventions with accurate EOP interpolation.
  115.      * @since 6.1
  116.      */
  117.     ITRF_EQUINOX_CONV_2010_ACCURATE_EOP("Equinox/2010-based ITRF accurate EOP"),

  118.     /** Equinox-based ITRF, IERS 2003 conventions with simple EOP interpolation.
  119.      * @since 6.1
  120.      */
  121.     ITRF_EQUINOX_CONV_2003_SIMPLE_EOP("Equinox/2003-based ITRF simple EOP"),

  122.     /** Equinox-based ITRF, IERS 2003 conventions with accurate EOP interpolation.
  123.      * @since 6.1
  124.      */
  125.     ITRF_EQUINOX_CONV_2003_ACCURATE_EOP("Equinox/2003-based ITRF accurate EOP"),

  126.     /** Equinox-based ITRF.
  127.      * @deprecated as of 6.1 replaced with {@link #ITRF_EQUINOX_CONV_1996_SIMPLE_EOP}
  128.      */
  129.     @Deprecated
  130.     ITRF_EQUINOX("Equinox-based ITRF"),

  131.     /** Equinox-based ITRF, IERS 1996 conventions with simple EOP interpolation.
  132.      * @since 6.1
  133.      */
  134.     ITRF_EQUINOX_CONV_1996_SIMPLE_EOP("Equinox/1996-based ITRF simple EOP"),

  135.     /** Equinox-based ITRF, IERS 1996 conventions with accurate EOP interpolation.
  136.      * @since 6.1
  137.      */
  138.     ITRF_EQUINOX_CONV_1996_ACCURATE_EOP("Equinox/1996-based ITRF accurate EOP"),

  139.     /** TIRF2000, IERS 2010 conventions, with simple EOP interpolation.
  140.      * @deprecated as of 6.1 replaced with {@link #TIRF_CONVENTIONS_2010_SIMPLE_EOP}
  141.      */
  142.     @Deprecated
  143.     TIRF_2000_CONV_2010_WITHOUT_TIDAL_EFFECTS("TIRF2000/2010 accurate EOP"),

  144.     /** TIRF, IERS 2010 conventions, with simple EOP interpolation.
  145.      * @since 6.1
  146.      */
  147.     TIRF_CONVENTIONS_2010_SIMPLE_EOP("TIRF/2010 simple EOP"),

  148.     /** TIRF2000, IERS 2010 conventions, with accurate EOP interpolation.
  149.      * @deprecated as of 6.1 replaced with {@link #TIRF_CONVENTIONS_2010_ACCURATE_EOP}
  150.      */
  151.     @Deprecated
  152.     TIRF_2000_CONV_2010_WITH_TIDAL_EFFECTS("TIRF2000/2010 simple EOP"),

  153.     /** TIRF, IERS 2010 conventions, with accurate EOP interpolation.
  154.      * @since 6.1
  155.      */
  156.     TIRF_CONVENTIONS_2010_ACCURATE_EOP("TIRF/2010 accurate EOP"),

  157.     /** TIRF2000, IERS 2003 conventions, with simple EOP interpolation.
  158.      * @deprecated as of 6.1 replaced with {@link #TIRF_CONVENTIONS_2003_SIMPLE_EOP}
  159.      */
  160.     @Deprecated
  161.     TIRF_2000_CONV_2003_WITHOUT_TIDAL_EFFECTS("TIRF2000/2003 accurate EOP"),

  162.     /** TIRF, IERS 2003 conventions, with simple EOP interpolation.
  163.      * @since 6.1
  164.      */
  165.     TIRF_CONVENTIONS_2003_SIMPLE_EOP("TIRF/2003 simple EOP"),

  166.     /** TIRF2000, IERS 2003 conventions, with accurate EOP interpolation.
  167.      * @deprecated as of 6.1 replaced with {@link #TIRF_CONVENTIONS_2003_ACCURATE_EOP}
  168.      */
  169.     @Deprecated
  170.     TIRF_2000_CONV_2003_WITH_TIDAL_EFFECTS("TIRF2000/2003 simple EOP"),

  171.     /** TIRF, IERS 2003 conventions, with accurate EOP interpolation.
  172.      * @since 6.1
  173.      */
  174.     TIRF_CONVENTIONS_2003_ACCURATE_EOP("TIRF/2003 accurate EOP"),

  175.     /** TIRF, IERS 1996 conventions, with simple EOP interpolation.
  176.      * @since 6.1
  177.      */
  178.     TIRF_CONVENTIONS_1996_SIMPLE_EOP("TIRF/1996 simple EOP"),

  179.     /** TIRF, IERS 996 conventions, with accurate EOP interpolation.
  180.      * @since 6.1
  181.      */
  182.     TIRF_CONVENTIONS_1996_ACCURATE_EOP("TIRF/1996 accurate EOP"),

  183.     /** CIRF2000 frame, IERS 2010 conventions.
  184.      * @deprecated as of 6.1 replaced with {@link #CIRF_CONVENTIONS_2010_ACCURATE_EOP}
  185.      */
  186.     @Deprecated
  187.     CIRF_2000_CONV_2010("CIRF2000/2010"),

  188.     /** CIRF frame, IERS 2010 conventions, with accurate EOP interpolation.
  189.      * @since 6.1
  190.      */
  191.     CIRF_CONVENTIONS_2010_ACCURATE_EOP("CIRF/2010 accurate EOP"),

  192.     /** CIRF frame, IERS 2010 conventions, with simple EOP interpolation.
  193.      * @since 6.1
  194.      */
  195.     CIRF_CONVENTIONS_2010_SIMPLE_EOP("CIRF/2010 simple EOP"),

  196.     /** CIRF2000 frame, IERS 2003 conventions.
  197.      * @deprecated as of 6.1 replaced with {@link #CIRF_CONVENTIONS_2003_ACCURATE_EOP}
  198.      */
  199.     @Deprecated
  200.     CIRF_2000_CONV_2003("CIRF2000/2003"),

  201.     /** CIRF frame, IERS 2003 conventions, with accurate EOP interpolation.
  202.      * @since 6.1
  203.      */
  204.     CIRF_CONVENTIONS_2003_ACCURATE_EOP("CIRF/2003 accurate EOP"),

  205.     /** CIRF frame, IERS 2003 conventions, with simple EOP interpolation.
  206.      * @since 6.1
  207.      */
  208.     CIRF_CONVENTIONS_2003_SIMPLE_EOP("CIRF/2003 simple EOP"),

  209.     /** CIRF frame, IERS 1996 conventions, with accurate EOP interpolation.
  210.      * @since 6.1
  211.      */
  212.     CIRF_CONVENTIONS_1996_ACCURATE_EOP("CIRF/1996 accurate EOP"),

  213.     /** CIRF frame, IERS 1996 conventions, with simple EOP interpolation.
  214.      * @since 6.1
  215.      */
  216.     CIRF_CONVENTIONS_1996_SIMPLE_EOP("CIRF/1996 simple EOP"),

  217.     /** Veis 1950. */
  218.     VEIS_1950("VEIS1950"),

  219.     /** GTOD, IERS 1996 conventions without EOP corrections.
  220.      */
  221.     GTOD_WITHOUT_EOP_CORRECTIONS("GTOD/1996 without EOP"),

  222.     /** GTOD, IERS 2010 conventions, with accurate EOP interpolation.
  223.      * @since 6.1
  224.      */
  225.     GTOD_CONVENTIONS_2010_ACCURATE_EOP("GTOD/2010 accurate EOP"),

  226.     /** GTOD, IERS 2010 conventions, with simple EOP interpolation.
  227.      * @since 6.1
  228.      */
  229.     GTOD_CONVENTIONS_2010_SIMPLE_EOP("GTOD/2010 simple EOP"),

  230.     /** GTOD, IERS 2003 conventions, with accurate EOP interpolation.
  231.      * @since 6.1
  232.      */
  233.     GTOD_CONVENTIONS_2003_ACCURATE_EOP("GTOD/2003 accurate EOP"),

  234.     /** GTOD, IERS 2003 conventions, with simple EOP interpolation.
  235.      * @since 6.1
  236.      */
  237.     GTOD_CONVENTIONS_2003_SIMPLE_EOP("GTOD/2003 simple EOP"),

  238.     /** GTOD, IERS 1996 conventions with EOP corrections.
  239.      * @deprecated as of 6.1 replaced with {@link #GTOD_CONVENTIONS_1996_ACCURATE_EOP}
  240.      */
  241.     @Deprecated
  242.     GTOD_WITH_EOP_CORRECTIONS("GTOD with EOP"),

  243.     /** GTOD, IERS 1996 conventions, with accurate EOP interpolation.
  244.      * @since 6.1
  245.      */
  246.     GTOD_CONVENTIONS_1996_ACCURATE_EOP("GTOD/1996 accurate EOP"),

  247.     /** GTOD, IERS 1996 conventions, with simple EOP interpolation.
  248.      * @since 6.1
  249.      */
  250.     GTOD_CONVENTIONS_1996_SIMPLE_EOP("GTOD/1996 simple EOP"),

  251.     /** TOD, IERS 1996 conventions without EOP corrections.
  252.      */
  253.     TOD_WITHOUT_EOP_CORRECTIONS("TOD/1996 without EOP"),

  254.     /** TOD, IERS 2010 conventions, with accurate EOP interpolation.
  255.      * @since 6.1
  256.      */
  257.     TOD_CONVENTIONS_2010_ACCURATE_EOP("TOD/2010 accurate EOP"),

  258.     /** TOD, IERS 2010 conventions, with simple EOP interpolation.
  259.      * @since 6.1
  260.      */
  261.     TOD_CONVENTIONS_2010_SIMPLE_EOP("TOD/2010 simple EOP"),

  262.     /** TOD, IERS 2003 conventions, with accurate EOP interpolation.
  263.      * @since 6.1
  264.      */
  265.     TOD_CONVENTIONS_2003_ACCURATE_EOP("TOD/2003 accurate EOP"),

  266.     /** TOD, IERS 2003 conventions, with simple EOP interpolation.
  267.      * @since 6.1
  268.      */
  269.     TOD_CONVENTIONS_2003_SIMPLE_EOP("TOD/2003 simple EOP"),

  270.     /** TOD, IERS 1996 conventions with EOP corrections.
  271.      * @deprecated as of 6.1 replaced with {@link #TOD_CONVENTIONS_1996_ACCURATE_EOP}
  272.      */
  273.     @Deprecated
  274.     TOD_WITH_EOP_CORRECTIONS("TOD with EOP"),

  275.     /** TOD, IERS 1996 conventions, with accurate EOP interpolation.
  276.      * @since 6.1
  277.      */
  278.     TOD_CONVENTIONS_1996_ACCURATE_EOP("TOD/1996 accurate EOP"),

  279.     /** TOD, IERS 1996 conventions, with simple EOP interpolation.
  280.      * @since 6.1
  281.      */
  282.     TOD_CONVENTIONS_1996_SIMPLE_EOP("TOD/1996 simple EOP"),


  283.     /** MOD, IERS 1996 conventions without EOP corrections.
  284.      */
  285.     MOD_WITHOUT_EOP_CORRECTIONS("MOD/1996 without EOP"),

  286.     /** MOD, IERS 2010 conventions.
  287.      * @since 6.1
  288.      */
  289.     MOD_CONVENTIONS_2010("MOD/2010"),

  290.     /** MOD, IERS 2003 conventions.
  291.      * @since 6.1
  292.      */
  293.     MOD_CONVENTIONS_2003("MOD/2003"),

  294.     /** MOD, IERS 1996 conventions with EOP corrections.
  295.      * @deprecated as of 6.1 replaced with {@link #MOD_CONVENTIONS_1996}
  296.      */
  297.     @Deprecated
  298.     MOD_WITH_EOP_CORRECTIONS("MOD with EOP"),

  299.     /** MOD, IERS 1996 conventions.
  300.      * @since 6.1
  301.      */
  302.     MOD_CONVENTIONS_1996("MOD/1996"),

  303.     /** TEME frame. */
  304.     TEME("TEME");

  305.     /** Name fo the frame. */
  306.     private final String name;

  307.     /** Simple constructor.
  308.      * @param name name of the frame
  309.      */
  310.     private Predefined(final String name) {
  311.         this.name = name;
  312.     }

  313.     /** Get the name of the frame.
  314.      * @return name of the frame
  315.      */
  316.     public String getName() {
  317.         return name;
  318.     }

  319. }