1   /* Copyright 2002-2018 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.attitudes;
18  
19  import java.io.Serializable;
20  
21  import org.hipparchus.RealFieldElement;
22  import org.orekit.errors.OrekitException;
23  import org.orekit.frames.Frame;
24  import org.orekit.time.AbsoluteDate;
25  import org.orekit.time.FieldAbsoluteDate;
26  import org.orekit.utils.FieldPVCoordinatesProvider;
27  import org.orekit.utils.PVCoordinatesProvider;
28  
29  
30  /** This interface represents an attitude provider model set.
31   * <p>An attitude provider provides a way to compute an {@link Attitude Attitude}
32   * from an date and position-velocity local provider.</p>
33   * @author V&eacute;ronique Pommier-Maurussane
34   */
35  public interface AttitudeProvider extends Serializable {
36  
37      /** Compute the attitude corresponding to an orbital state.
38       * @param pvProv local position-velocity provider around current date
39       * @param date current date
40       * @param frame reference frame from which attitude is computed
41       * @return attitude attitude on the specified date and position-velocity state
42       * @throws OrekitException if attitude cannot be computed
43       */
44      Attitude getAttitude(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame)
45          throws OrekitException;
46  
47      /** Compute the attitude corresponding to an orbital state.
48       * @param pvProv local position-velocity provider around current date
49       * @param date current date
50       * @param frame reference frame from which attitude is computed
51       * @param <T> type of the field elements
52       * @return attitude attitude on the specified date and position-velocity state
53       * @throws OrekitException if attitude cannot be computed
54       * @since 9.0
55       */
56      <T extends RealFieldElement<T>> FieldAttitude<T> getAttitude(FieldPVCoordinatesProvider<T> pvProv,
57                                                                   FieldAbsoluteDate<T> date,
58                                                                   Frame frame)
59          throws OrekitException;
60  }