1   /* Copyright 2020-2025 Exotrail
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.averaging;
18  
19  import org.orekit.frames.Frame;
20  import org.orekit.orbits.Orbit;
21  import org.orekit.orbits.OrbitType;
22  import org.orekit.orbits.PositionAngleType;
23  import org.orekit.time.AbsoluteDate;
24  import org.orekit.time.TimeStamped;
25  import org.orekit.propagation.conversion.averaging.elements.AveragedOrbitalElements;
26  
27  /**
28   * Interface representing averaged orbital elements at a specific instant.
29   * Inheritors shall implement a conversion method to transform into an osculating {@link Orbit}.
30   *
31   * @author Romain Serra
32   * @see TimeStamped
33   * @see AveragedOrbitalElements
34   * @since 12.1
35   */
36  public interface AveragedOrbitalState extends TimeStamped {
37  
38      /** {@inheritDoc} */
39      @Override
40      AbsoluteDate getDate();
41  
42      /**
43       * Getter for the averaged orbital elements.
44       * @return averaged elements
45       */
46      AveragedOrbitalElements getAveragedElements();
47  
48      /**
49       * Getter for the central body's gravitational constant.
50       * @return gravitational constant
51       */
52      double getMu();
53  
54      /**
55       * Getter for the reference frame.
56       * @return frame
57       */
58      Frame getFrame();
59  
60      /**
61       * Getter for the averaged orbit type.
62       * @return orbit type
63       */
64      OrbitType getOrbitType();
65  
66      /**
67       * Getter for the averaged position angle.
68       * @return position angle type
69       */
70      PositionAngleType getPositionAngleType();
71  
72      /**
73       * Convert instance to an osculating orbit.
74       * @return osculating orbit
75       */
76      Orbit toOsculatingOrbit();
77  
78  }