1   /* Copyright 2002-2024 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  
19  import java.io.Serializable;
20  
21  /** Simple container class for pole correction parameters.
22   * <p>This class is a simple container, it does not provide
23   * any processing method.</p>
24   * @author Luc Maisonobe
25   */
26  public class PoleCorrection implements Serializable {
27  
28      /** Null correction (xp = 0, yp = 0). */
29      public static final PoleCorrection NULL_CORRECTION =
30          new PoleCorrection(0, 0);
31  
32      /** Serializable UID. */
33      private static final long serialVersionUID = 8695216598525302806L;
34  
35      /** x<sub>p</sub> parameter (radians). */
36      private final double xp;
37  
38      /** y<sub>p</sub> parameter (radians). */
39      private final double yp;
40  
41      /** Simple constructor.
42       * @param xp x<sub>p</sub> parameter (radians)
43       * @param yp y<sub>p</sub> parameter (radians)
44       */
45      public PoleCorrection(final double xp, final double yp) {
46          this.xp = xp;
47          this.yp = yp;
48      }
49  
50      /** Get the x<sub>p</sub> parameter.
51       * @return x<sub>p</sub> parameter
52       */
53      public double getXp() {
54          return xp;
55      }
56  
57      /** Get the y<sub>p</sub> parameter.
58       * @return y<sub>p</sub> parameter
59       */
60      public double getYp() {
61          return yp;
62      }
63  
64  }