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