PropagatorBuilder.java

  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;

  19. import org.orekit.estimation.leastsquares.AbstractBatchLSModel;
  20. import org.orekit.estimation.leastsquares.ModelObserver;
  21. import org.orekit.estimation.measurements.ObservedMeasurement;
  22. import org.orekit.frames.Frame;
  23. import org.orekit.orbits.Orbit;
  24. import org.orekit.orbits.OrbitType;
  25. import org.orekit.orbits.PositionAngleType;
  26. import org.orekit.propagation.Propagator;
  27. import org.orekit.time.AbsoluteDate;
  28. import org.orekit.utils.ParameterDriversList;

  30. import java.util.List;

  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 extends Cloneable {

  38.     /** Create a new instance identical to this one.
  39.      * @return new instance identical to this one
  40.      * @deprecated as of 12.2, replaced by {@link Object#clone()}
  41.      */
  42.     @Deprecated
  43.     PropagatorBuilder copy();

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

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

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

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

  76.     /** Get the orbit type expected for the 6 first parameters in
  77.      * {@link #buildPropagator(double[])}.
  78.      * @return orbit type to use in {@link #buildPropagator(double[])}
  79.      * @see #buildPropagator(double[])
  80.      * @see #getPositionAngleType()
  81.      * @since 7.1
  82.      */
  83.     OrbitType getOrbitType();

  85.     /** Get the position angle type expected for the 6 first parameters in
  86.      * {@link #buildPropagator(double[])}.
  87.      * @return position angle type to use in {@link #buildPropagator(double[])}
  88.      * @see #buildPropagator(double[])
  89.      * @see #getOrbitType()
  90.      * @since 7.1
  91.      */
  92.     PositionAngleType getPositionAngleType();

  94.     /** Get the date of the initial orbit.
  95.      * @return date of the initial orbit
  96.      */
  97.     AbsoluteDate getInitialOrbitDate();

  99.     /** Get the frame in which the orbit is propagated.
  100.      * @return frame in which the orbit is propagated
  101.      */
  102.     Frame getFrame();

  104.     /** Get the central attraction coefficient (µ - m³/s²) value.
  105.      * @return the central attraction coefficient (µ - m³/s²) value
  106.      * @since 12.0
  107.      */
  108.     double getMu();

  110.     /** Get the drivers for the configurable orbital parameters.
  111.      * Orbital drivers should have only 1 value estimated (1 span)
  112.      * @return drivers for the configurable orbital parameters
  113.      * @since 8.0
  114.      */
  115.     ParameterDriversList getOrbitalParametersDrivers();

  117.     /** Get the drivers for the configurable propagation parameters.
  118.      * <p>
  119.      * The parameters typically correspond to force models.
  120.      * </p>
  121.      * @return drivers for the configurable propagation parameters
  122.      * @since 8.0
  123.      */
  124.     ParameterDriversList getPropagationParametersDrivers();

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

  132. }
Created with JaCoCo 0.8.12.202403310830