1 /* Copyright 2002-2026 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 org.orekit.attitudes.AttitudeProvider;
20 import org.orekit.estimation.leastsquares.AbstractBatchLSModel;
21 import org.orekit.estimation.leastsquares.ModelObserver;
22 import org.orekit.estimation.measurements.ObservedMeasurement;
23 import org.orekit.orbits.Orbit;
24 import org.orekit.orbits.OrbitalParameterFactory;
25 import org.orekit.orbits.OrbitalParameters;
26 import org.orekit.propagation.Propagator;
27 import org.orekit.utils.ParameterDriversList;
28
29 import java.util.List;
30
31 /** This interface is the top-level abstraction to build propagators for conversion.
32 * @author Pascal Parraud
33 * @since 6.0
34 */
35 public interface PropagatorBuilder extends Cloneable {
36
37 /** Build a propagator.
38 * @param normalizedParameters normalized values for the selected parameters
39 * @return an initialized propagator
40 */
41 Propagator buildPropagator(double[] normalizedParameters);
42
43 /** Build a propagator from current value of selected normalized parameters.
44 * @return an initialized propagator
45 */
46 default Propagator buildPropagator() {
47 return buildPropagator(getSelectedNormalizedParameters());
48 }
49
50 /** Build a new batch least squares model.
51 * @param builders builders to use for propagation
52 * @param measurements measurements
53 * @param estimatedMeasurementsParameters estimated measurements parameters
54 * @param observer observer to be notified at model calls
55 * @return a new model for the Batch Least Squares orbit determination
56 * @since 12.0
57 */
58 AbstractBatchLSModel buildLeastSquaresModel(PropagatorBuilder[] builders,
59 List<ObservedMeasurement<?>> measurements,
60 ParameterDriversList estimatedMeasurementsParameters,
61 ModelObserver observer);
62
63 /** Get the current value of selected normalized parameters.
64 * @return current value of selected normalized parameters
65 */
66 double[] getSelectedNormalizedParameters();
67
68 /**
69 * Get the attitude provider.
70 *
71 * @return the attitude provider
72 * @since 13.0
73 */
74 AttitudeProvider getAttitudeProvider();
75
76 /** Get the orbital parameters factory.
77 * @return orbital parameters factory
78 * @since 14.0
79 */
80 OrbitalParameterFactory<? extends OrbitalParameters> getOrbitalParameterFactory();
81
82 /** Get the initial mass.
83 * @return the mass (kg)
84 * @since 13.0
85 */
86 double getMass();
87
88 /** Get the drivers for the configurable propagation parameters.
89 * <p>
90 * The parameters typically correspond to force models.
91 * </p>
92 * @return drivers for the configurable propagation parameters
93 * @since 8.0
94 */
95 ParameterDriversList getPropagationParametersDrivers();
96
97 /** Reset the orbit in the propagator builder.
98 * @param newOrbit New orbit to set in the propagator builder
99 * @since 12.0
100 */
101 void resetOrbit(Orbit newOrbit);
102
103 }