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.propagation.conversion;
18  
19  import java.util.List;
20  
21  import org.orekit.estimation.leastsquares.AbstractBatchLSModel;
22  import org.orekit.estimation.leastsquares.ModelObserver;
23  import org.orekit.estimation.measurements.ObservedMeasurement;
24  import org.orekit.frames.Frame;
25  import org.orekit.orbits.Orbit;
26  import org.orekit.orbits.OrbitType;
27  import org.orekit.orbits.PositionAngleType;
28  import org.orekit.propagation.Propagator;
29  import org.orekit.time.AbsoluteDate;
30  import org.orekit.utils.ParameterDriversList;
31  
32  /** This interface is the top-level abstraction to build propagators for conversion.
33   * @author Pascal Parraud
34   * @since 6.0
35   */
36  public interface PropagatorBuilder {
37  
38      /** Create a new instance identical to this one.
39       * @return new instance identical to this one
40       */
41      PropagatorBuilder copy();
42  
43      /** Build a propagator.
44       * @param normalizedParameters normalized values for the selected parameters
45       * @return an initialized propagator
46       */
47      Propagator buildPropagator(double[] normalizedParameters);
48  
49      /** Build a propagator from current value of selected normalized parameters.
50       * @return an initialized propagator
51       */
52      default Propagator buildPropagator() {
53          return buildPropagator(getSelectedNormalizedParameters());
54      }
55  
56      /** Build a new batch least squares model.
57       * @param builders builders to use for propagation
58       * @param measurements measurements
59       * @param estimatedMeasurementsParameters estimated measurements parameters
60       * @param observer observer to be notified at model calls
61       * @return a new model for the Batch Least Squares orbit determination
62       * @since 12.0
63       */
64      AbstractBatchLSModel buildLeastSquaresModel(PropagatorBuilder[] builders,
65                                                  List<ObservedMeasurement<?>> measurements,
66                                                  ParameterDriversList estimatedMeasurementsParameters,
67                                                  ModelObserver observer);
68  
69      /** Get the current value of selected normalized parameters.
70       * @return current value of selected normalized parameters
71       */
72      double[] getSelectedNormalizedParameters();
73  
74      /** Get the orbit type expected for the 6 first parameters in
75       * {@link #buildPropagator(double[])}.
76       * @return orbit type to use in {@link #buildPropagator(double[])}
77       * @see #buildPropagator(double[])
78       * @see #getPositionAngleType()
79       * @since 7.1
80       */
81      OrbitType getOrbitType();
82  
83      /** Get the position angle type expected for the 6 first parameters in
84       * {@link #buildPropagator(double[])}.
85       * @return position angle type to use in {@link #buildPropagator(double[])}
86       * @see #buildPropagator(double[])
87       * @see #getOrbitType()
88       * @since 7.1
89       */
90      PositionAngleType getPositionAngleType();
91  
92      /** Get the date of the initial orbit.
93       * @return date of the initial orbit
94       */
95      AbsoluteDate getInitialOrbitDate();
96  
97      /** Get the frame in which the orbit is propagated.
98       * @return frame in which the orbit is propagated
99       */
100     Frame getFrame();
101 
102     /** Get the central attraction coefficient (µ - m³/s²) value.
103      * @return the central attraction coefficient (µ - m³/s²) value
104      * @since 12.0
105      */
106     double getMu();
107 
108     /** Get the drivers for the configurable orbital parameters.
109      * Orbital drivers should have only 1 value estimated (1 span)
110      * @return drivers for the configurable orbital parameters
111      * @since 8.0
112      */
113     ParameterDriversList getOrbitalParametersDrivers();
114 
115     /** Get the drivers for the configurable propagation parameters.
116      * <p>
117      * The parameters typically correspond to force models.
118      * </p>
119      * @return drivers for the configurable propagation parameters
120      * @since 8.0
121      */
122     ParameterDriversList getPropagationParametersDrivers();
123 
124     /** Reset the orbit in the propagator builder.
125      * @param newOrbit New orbit to set in the propagator builder
126      * @since 12.0
127      */
128     void resetOrbit(Orbit newOrbit);
129 
130 }