1   /* Copyright 2002-2025 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.propagation.conversion.osc2mean;
18  
19  import org.hipparchus.CalculusFieldElement;
20  import org.orekit.orbits.FieldOrbit;
21  import org.orekit.orbits.Orbit;
22  
23  /**
24   * Interface for osculating to mean orbit converters.
25   * <p>An osculating-to-mean converter consists of:
26   * <ul>
27   * <li>an algorithm performing the conversion, provided by an implementation of this interface,</li>
28   * <li>a theory giving the meaning of the mean orbit, to be set as the {@link MeanTheory mean theory}.</li>
29   * </ul>
30   *
31   * @author Pascal Parraud
32   * @since 13.0
33   */
34  public interface OsculatingToMeanConverter {
35  
36      /**
37       * Sets the theory defining the mean orbit.
38       * @param theory the mean theory
39       */
40      void setMeanTheory(MeanTheory theory);
41  
42      /**
43       * Gets the theory defining the mean orbit.
44       * @return the mean theory
45       */
46      MeanTheory getMeanTheory();
47  
48      /**
49       * Converts an osculating orbit into a mean orbit.
50       * @param osculating osculating orbit
51       * @return mean orbit
52       */
53      Orbit convertToMean(Orbit osculating);
54  
55      /**
56       * Converts an osculating orbit into a mean orbit.
57       * @param <T> type of the filed elements
58       * @param osculating osculating orbit
59       * @return mean orbit
60       */
61      <T extends CalculusFieldElement<T>> FieldOrbit<T> convertToMean(FieldOrbit<T> osculating);
62  
63  }