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.attitudes;
18  
19  import org.hipparchus.CalculusFieldElement;
20  import org.hipparchus.geometry.euclidean.threed.FieldRotation;
21  import org.hipparchus.geometry.euclidean.threed.Rotation;
22  import org.orekit.frames.Frame;
23  import org.orekit.time.AbsoluteDate;
24  import org.orekit.time.FieldAbsoluteDate;
25  import org.orekit.utils.FieldPVCoordinatesProvider;
26  import org.orekit.utils.PVCoordinatesProvider;
27  
28  
29  /** This interface represents an attitude provider model set.
30   * <p>An attitude provider provides a way to compute an {@link Attitude Attitude}
31   * from an date and position-velocity local provider.</p>
32   * @author V&eacute;ronique Pommier-Maurussane
33   */
34  public interface AttitudeProvider {
35  
36      /** Compute the attitude corresponding to an orbital state.
37       * @param pvProv local position-velocity provider around current date
38       * @param date current date
39       * @param frame reference frame from which attitude is computed
40       * @return attitude on the specified date and position-velocity state
41       */
42      Attitude getAttitude(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame);
43  
44      /** Compute the attitude corresponding to an orbital state.
45       * @param pvProv local position-velocity provider around current date
46       * @param date current date
47       * @param frame reference frame from which attitude is computed
48       * @param <T> type of the field elements
49       * @return attitude on the specified date and position-velocity state
50       * @since 9.0
51       */
52      <T extends CalculusFieldElement<T>> FieldAttitude<T> getAttitude(FieldPVCoordinatesProvider<T> pvProv,
53                                                                       FieldAbsoluteDate<T> date,
54                                                                       Frame frame);
55  
56      /** Compute the attitude-related rotation corresponding to an orbital state.
57       * @param pvProv local position-velocity provider around current date
58       * @param date current date
59       * @param frame reference frame from which attitude is computed
60       * @return attitude-related rotation on the specified date and position-velocity state
61       * @since 12.0
62       */
63      default Rotation getAttitudeRotation(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame) {
64          return getAttitude(pvProv, date, frame).getRotation();
65      }
66  
67      /** Compute the attitude-related rotation corresponding to an orbital state.
68       * @param pvProv local position-velocity provider around current date
69       * @param date current date
70       * @param frame reference frame from which attitude is computed
71       * @param <T> type of the field elements
72       * @return rotation on the specified date and position-velocity state
73       * @since 12.0
74       */
75      default <T extends CalculusFieldElement<T>> FieldRotation<T> getAttitudeRotation(FieldPVCoordinatesProvider<T> pvProv,
76                                                                                       FieldAbsoluteDate<T> date,
77                                                                                       Frame frame) {
78          return getAttitude(pvProv, date, frame).getRotation();
79      }
80  
81  }