PoleCorrection.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.frames;

  18. import java.io.Serializable;

  19. /** Simple container class for pole correction parameters.
  20.  * <p>This class is a simple container, it does not provide
  21.  * any processing method.</p>
  22.  * @author Luc Maisonobe
  23.  */
  24. public class PoleCorrection implements Serializable {

  25.     /** Null correction (xp = 0, yp = 0). */
  26.     public static final PoleCorrection NULL_CORRECTION =
  27.         new PoleCorrection(0, 0);

  28.     /** Serializable UID. */
  29.     private static final long serialVersionUID = 8695216598525302806L;

  30.     /** x<sub>p</sub> parameter (radians). */
  31.     private final double xp;

  32.     /** y<sub>p</sub> parameter (radians). */
  33.     private final double yp;

  34.     /** Simple constructor.
  35.      * @param xp x<sub>p</sub> parameter (radians)
  36.      * @param yp y<sub>p</sub> parameter (radians)
  37.      */
  38.     public PoleCorrection(final double xp, final double yp) {
  39.         this.xp = xp;
  40.         this.yp = yp;
  41.     }

  42.     /** Get the x<sub>p</sub> parameter.
  43.      * @return x<sub>p</sub> parameter
  44.      */
  45.     public double getXp() {
  46.         return xp;
  47.     }

  48.     /** Get the y<sub>p</sub> parameter.
  49.      * @return y<sub>p</sub> parameter
  50.      */
  51.     public double getYp() {
  52.         return yp;
  53.     }

  54. }