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  
18  package org.orekit.frames;
19  
20  import java.io.Serializable;
21  
22  import org.hipparchus.CalculusFieldElement;
23  import org.orekit.time.AbsoluteDate;
24  import org.orekit.time.FieldAbsoluteDate;
25  
26  /** Interface for Transform providers.
27   * <p>The transform provider interface is mainly used to define the
28   * transform between a frame and its parent frame.
29   * </p>
30   * @author Luc Maisonobe
31   */
32  public interface TransformProvider extends Serializable {
33  
34      /** Get the {@link Transform} corresponding to specified date.
35       * @param date current date
36       * @return transform at specified date
37       */
38      Transform getTransform(AbsoluteDate date);
39  
40      /** Get the {@link FieldTransform} corresponding to specified date.
41       * @param date current date
42       * @param <T> type of the field elements
43       * @return transform at specified date
44       * @since 9.0
45       */
46      <T extends CalculusFieldElement<T>> FieldTransform<T> getTransform(FieldAbsoluteDate<T> date);
47  
48      /**
49       * Get a transform for position and velocity, not acceleration.
50       *
51       * <p>The default implementation returns {@link #getTransform(AbsoluteDate)}
52       * but implementations may override it for better performance.
53       *
54       * @param date current date.
55       * @return the kinematic transform.
56       * @since 12.1
57       */
58      default KinematicTransform getKinematicTransform(AbsoluteDate date) {
59          return getTransform(date);
60      }
61  
62      /**
63       * Get a transform for position and velocity, not acceleration.
64       *
65       * <p>The default implementation returns {@link #getTransform(AbsoluteDate)}
66       * but implementations may override it for better performance.
67       *
68       * @param <T> type of the elements
69       * @param date current date.
70       * @return the kinematic transform.
71       * @since 12.1
72       */
73      default <T extends CalculusFieldElement<T>> FieldKinematicTransform<T> getKinematicTransform(FieldAbsoluteDate<T> date) {
74          return getTransform(date);
75      }
76  
77      /**
78       * Get a transform for only rotations and translations on the specified date.
79       *
80       * <p>The default implementation calls {@link #getTransform(AbsoluteDate)}
81       * but implementations may override it for better performance.
82       *
83       * @param date current date.
84       * @return the static transform.
85       */
86      default StaticTransform getStaticTransform(AbsoluteDate date) {
87          return getTransform(date).toStaticTransform();
88      }
89  
90      /**
91       * Get a transform for only rotations and translations on the specified date.
92       *
93       * <p>The default implementation returns {@link #getTransform(AbsoluteDate)}
94       * but implementations may override it for better performance.
95       *
96       * @param <T> type of the elements
97       * @param date current date.
98       * @return the static transform.
99       * @since 12.0
100      */
101     default <T extends CalculusFieldElement<T>> FieldStaticTransform<T> getStaticTransform(FieldAbsoluteDate<T> date) {
102         return getTransform(date).toStaticTransform();
103     }
104 
105 }