PropagatorBuilder.java

/* Copyright 2002-2026 CS GROUP
 * Licensed to CS GROUP (CS) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * CS licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.orekit.propagation.conversion;

import org.orekit.attitudes.AttitudeProvider;
import org.orekit.estimation.leastsquares.AbstractBatchLSModel;
import org.orekit.estimation.leastsquares.ModelObserver;
import org.orekit.estimation.measurements.ObservedMeasurement;
import org.orekit.orbits.Orbit;
import org.orekit.orbits.OrbitalParameterFactory;
import org.orekit.orbits.OrbitalParameters;
import org.orekit.propagation.Propagator;
import org.orekit.utils.ParameterDriversList;

import java.util.List;

/** This interface is the top-level abstraction to build propagators for conversion.
 * @author Pascal Parraud
 * @since 6.0
 */
public interface PropagatorBuilder extends Cloneable {

    /** Build a propagator.
     * @param normalizedParameters normalized values for the selected parameters
     * @return an initialized propagator
     */
    Propagator buildPropagator(double[] normalizedParameters);

    /** Build a propagator from current value of selected normalized parameters.
     * @return an initialized propagator
     */
    default Propagator buildPropagator() {
        return buildPropagator(getSelectedNormalizedParameters());
    }

    /** Build a new batch least squares model.
     * @param builders builders to use for propagation
     * @param measurements measurements
     * @param estimatedMeasurementsParameters estimated measurements parameters
     * @param observer observer to be notified at model calls
     * @return a new model for the Batch Least Squares orbit determination
     * @since 12.0
     */
    AbstractBatchLSModel buildLeastSquaresModel(PropagatorBuilder[] builders,
                                                List<ObservedMeasurement<?>> measurements,
                                                ParameterDriversList estimatedMeasurementsParameters,
                                                ModelObserver observer);

    /** Get the current value of selected normalized parameters.
     * @return current value of selected normalized parameters
     */
    double[] getSelectedNormalizedParameters();

    /**
     * Get the attitude provider.
     *
     * @return the attitude provider
     * @since 13.0
     */
    AttitudeProvider getAttitudeProvider();

    /** Get the orbital parameters factory.
     * @return orbital parameters factory
     * @since 14.0
     */
    OrbitalParameterFactory<? extends OrbitalParameters> getOrbitalParameterFactory();

    /** Get the initial mass.
     * @return the mass (kg)
     * @since 13.0
     */
    double getMass();

    /** Get the drivers for the configurable propagation parameters.
     * <p>
     * The parameters typically correspond to force models.
     * </p>
     * @return drivers for the configurable propagation parameters
     * @since 8.0
     */
    ParameterDriversList getPropagationParametersDrivers();

    /** Reset the orbit in the propagator builder.
     * @param newOrbit New orbit to set in the propagator builder
     * @since 12.0
     */
    void resetOrbit(Orbit newOrbit);

}