1   /* Copyright 2002-2019 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.models.earth.displacement;
18  
19  import org.hipparchus.geometry.euclidean.threed.Vector3D;
20  import org.orekit.data.BodiesElements;
21  import org.orekit.frames.Frame;
22  
23  /** Interface for computing reference points displacement.
24   * @author Luc Maisonobe
25   * @since 9.1
26   */
27  public interface StationDisplacement {
28  
29      /** Compute displacement of a ground reference point.
30       * @param elements elements affecting Earth orientation
31       * @param earthFrame Earth frame in which reference point is defined
32       * @param referencePoint reference point position in {@code earthFrame}
33       * @return displacement vector to be <em>added</em> to {@code referencePoint}
34       */
35      Vector3D displacement(BodiesElements elements, Frame earthFrame, Vector3D referencePoint);
36  
37  }