1   /* Copyright 2022-2025 Thales Alenia Space
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.estimation.measurements.gnss;
18  
19  import org.hipparchus.geometry.euclidean.threed.Vector3D;
20  
21  /** Dipole configuration for satellite-to-ground and inter-satellites wind-up effects.
22   * <p>
23   * The dipole configuration is given by two vectors.
24   * </p>
25   * @see WindUp
26   * @see InterSatellitesWindUp
27   * @author Luc Maisonobe
28   * @since 12.0
29   */
30  public class Dipole {
31  
32      /** Canonical dipole, with primary vector set to {@link Vector3D#PLUS_I}
33       * and secondary vector set to {@link Vector3D#PLUS_J}.
34       */
35      public static final Dipole CANONICAL_I_J = new Dipole(Vector3D.PLUS_I, Vector3D.PLUS_J);
36  
37      /** Primary dipole vector. */
38      private final Vector3D primary;
39  
40      /** Secondary dipole vector. */
41      private final Vector3D secondary;
42  
43      /** Simple constructor.
44       * @param primary primary dipole vector
45       * @param secondary secondary dipole vector
46       */
47      public Dipole(final Vector3D primary, final Vector3D secondary) {
48          this.primary   = primary;
49          this.secondary = secondary;
50      }
51  
52      /** Get the primary dipole vector.
53       * @return primary dipole vector
54       */
55      public Vector3D getPrimary() {
56          return primary;
57      }
58  
59      /** Get the secondary dipole vector.
60       * @return secondary dipole vector
61       */
62      public Vector3D getSecondary() {
63          return secondary;
64      }
65  
66  }