FieldPoleCorrection.java

  1. /* Copyright 2002-2017 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. import org.hipparchus.RealFieldElement;

  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.  * @param <T> type of the field elements
  23.  * @since 9.0
  24.  * @author Luc Maisonobe
  25.  */
  26. public class FieldPoleCorrection<T extends RealFieldElement<T>> {

  27.     /** x<sub>p</sub> parameter (radians). */
  28.     private final T xp;

  29.     /** y<sub>p</sub> parameter (radians). */
  30.     private final T yp;

  31.     /** Simple constructor.
  32.      * @param xp x<sub>p</sub> parameter (radians)
  33.      * @param yp y<sub>p</sub> parameter (radians)
  34.      */
  35.     public FieldPoleCorrection(final T xp, final T yp) {
  36.         this.xp = xp;
  37.         this.yp = yp;
  38.     }

  39.     /** Get the x<sub>p</sub> parameter.
  40.      * @return x<sub>p</sub> parameter
  41.      */
  42.     public T getXp() {
  43.         return xp;
  44.     }

  45.     /** Get the y<sub>p</sub> parameter.
  46.      * @return y<sub>p</sub> parameter
  47.      */
  48.     public T getYp() {
  49.         return yp;
  50.     }

  51. }