Package org.orekit.utils

Interface ParameterDriversProvider

All Known Subinterfaces:

AccelerationModel, DiscreteTroposphericModel, DSSTForceModel, EstimationModifier<T>, ForceModel, IonosphericModel, ManeuverTriggers, ObservedMeasurement<T>, PropulsionModel, ThrustPropulsionModel

All Known Implementing Classes:

AberrationModifier, AbstractAnalyticalGradientConverter, AbstractConstantThrustPropulsionModel, AbstractDragForceModel, AbstractGaussianContribution, AbstractManeuverTriggers, AbstractMeasurement, AbstractRadiationForceModel, AbstractWindUp, AngularAzEl, AngularIonosphericDelayModifier, AngularRaDec, AngularRadioRefractionModifier, AngularTroposphericDelayModifier, BasicConstantThrustPropulsionModel, Bias, BistaticRange, BistaticRangeIonosphericDelayModifier, BistaticRangeRate, BistaticRangeRateIonosphericDelayModifier, BistaticRangeRateTroposphericDelayModifier, BistaticRangeTroposphericDelayModifier, BrouwerLyddanePropagator, ConfigurableLowThrustManeuver, ConstantThrustManeuver, CR3BPForceModel, DateBasedManeuverTriggers, DeSitterRelativity, DragForce, DSSTAtmosphericDrag, DSSTJ2SquaredClosedForm, DSSTNewtonianAttraction, DSSTSolarRadiationPressure, DSSTTesseral, DSSTThirdBody, DSSTZonal, DynamicOutlierFilter, ECOM2, EstimatedIonosphericModel, EstimatedTroposphericModel, FDOA, FieldAbstractAnalyticalPropagator, FieldBrouwerLyddanePropagator, FieldDeepSDP4, FieldEcksteinHechlerPropagator, FieldIntegratedEphemeris, FieldKeplerianPropagator, FieldSGP4, FieldTLE, FieldTLEPropagator, FixedTroposphericDelay, GlobalIonosphereMapModel, GroundReceiverMeasurement, HarmonicAccelerationModel, HolmesFeatherstoneAttractionModel, InertialForces, InterSatellitesPhase, InterSatellitesPhaseAmbiguityModifier, InterSatellitesRange, InterSatellitesWindUp, IntervalEventTrigger, KlobucharIonoModel, KnockeRediffusedForceModel, LenseThirringRelativity, Maneuver, MariniMurrayModel, MendesPavlisModel, ModifiedSaastamoinenModel, MultiplexedMeasurement, NeQuickModel, NewtonianAttraction, OceanTides, OnBoardAntennaInterSatellitesPhaseModifier, OnBoardAntennaInterSatellitesRangeModifier, OnBoardAntennaOneWayGNSSPhaseModifier, OnBoardAntennaOneWayGNSSRangeModifier, OnBoardAntennaTurnAroundRangeModifier, OneWayGNSSPhase, OneWayGNSSPhaseAmbiguityModifier, OneWayGNSSRange, OutlierFilter, ParametricAcceleration, Phase, PhaseAmbiguityModifier, PhaseCentersPhaseModifier, PhaseCentersRangeModifier, PhaseIonosphericDelayModifier, PhaseTroposphericDelayModifier, PolynomialAccelerationModel, Position, ProfileThrustPropulsionModel, PV, Range, RangeIonosphericDelayModifier, RangeRate, RangeRateIonosphericDelayModifier, RangeRateTroposphericDelayModifier, RangeTroposphericDelayModifier, RelativisticClockInterSatellitesPhaseModifier, RelativisticClockInterSatellitesRangeModifier, RelativisticClockOneWayGNSSPhaseModifier, RelativisticClockOneWayGNSSRangeModifier, RelativisticClockPhaseModifier, RelativisticClockRangeModifier, RelativisticClockRangeRateModifier, RelativisticJ2ClockInterSatellitesPhaseModifier, RelativisticJ2ClockInterSatellitesRangeModifier, RelativisticJ2ClockOneWayGNSSPhaseModifier, RelativisticJ2ClockOneWayGNSSRangeModifier, RelativisticJ2ClockPhaseModifier, RelativisticJ2ClockRangeModifier, Relativity, SaastamoinenModel, ScaledConstantThrustPropulsionModel, ShapiroInterSatellitePhaseModifier, ShapiroInterSatelliteRangeModifier, ShapiroOneWayGNSSPhaseModifier, ShapiroOneWayGNSSRangeModifier, ShapiroPhaseModifier, ShapiroRangeModifier, SingleBodyAbsoluteAttraction, SingleBodyRelativeAttraction, SolarRadiationPressure, SolidTides, SsrVtecIonosphericModel, StartStopEventsTrigger, TDOA, TDOAIonosphericDelayModifier, TDOATroposphericDelayModifier, ThirdBodyAttraction, ThirdBodyAttractionEpoch, TimeSpanDragForce, TimeSpanEstimatedTroposphericModel, TimeSpanParametricAcceleration, TLE, TurnAroundRange, TurnAroundRangeIonosphericDelayModifier, TurnAroundRangeTroposphericDelayModifier, ViennaOneModel, ViennaThreeModel, WindUp

public interface ParameterDriversProvider

Provider for parameters drivers.

Since:

11.2

Author:

Luc Maisonobe, Melina Vanel, Maxime Journot

Method Summary

Modifier and Type	Method	Description
default int	getNbParametersDriversValue()	Get total number of spans for all the parameters driver.
default ParameterDriver	getParameterDriver(String name)	Get parameter value from its name.
default double[]	getParameters()	Get model parameters.
default <T extends CalculusFieldElement<T>> T[]	getParameters(Field<T> field)	Get model parameters.
default <T extends CalculusFieldElement<T>> T[]	getParameters(Field<T> field, FieldAbsoluteDate<T> date)	Get model parameters.
default double[]	getParameters(AbsoluteDate date)	Get model parameters.
default double[]	getParametersAllValues()	Get model parameters, return a list a all span values of all parameters.
default <T extends CalculusFieldElement<T>> T[]	getParametersAllValues(Field<T> field)	Get model parameters.
List<ParameterDriver>	getParametersDrivers()	Get the drivers for parameters.
default boolean	isSupported(String name)	Check if a parameter is supported.

Method Detail

getParametersDrivers

List<ParameterDriver> getParametersDrivers()

Get the drivers for parameters.

Returns:

drivers for parameters

getNbParametersDriversValue

default int getNbParametersDriversValue()

Get total number of spans for all the parameters driver.

Returns:

total number of span to be estimated

Since:

12.0

getParameters

default double[] getParameters()

Get model parameters.

Returns:

model parameters, will throw an exception if one PDriver has several values driven. If it's the case (if at least 1 PDriver of the model has several values driven) the method getParameters(AbsoluteDate) must be used.

Since:

12.0

getParameters

default double[] getParameters(AbsoluteDate date)

Get model parameters.

Parameters:

date - date at which the parameters want to be known, can be new AbsoluteDate() if all the parameters have no validity period that is to say that they have only 1 estimated value over the all interval

Returns:

model parameters

Since:

12.0

getParametersAllValues

default double[] getParametersAllValues()

Get model parameters, return a list a all span values of all parameters.

Returns:

model parameters

Since:

12.0

getParametersAllValues

default <T extends CalculusFieldElement<T>> T[] getParametersAllValues(Field<T> field)

Get model parameters.

Type Parameters:

T - type of the elements

Parameters:

field - field to which the elements belong

Returns:

model parameters

Since:

9.0

getParameters

default <T extends CalculusFieldElement<T>> T[] getParameters(Field<T> field)

Get model parameters.

Type Parameters:

T - type of the elements

Parameters:

field - field to which the elements belong

Returns:

model parameters, will throw an exception if one PDriver of the has several values driven. If it's the case (if at least 1 PDriver of the model has several values driven) the method getParameters(Field, FieldAbsoluteDate) must be used.

Since:

9.0

getParameters

default <T extends CalculusFieldElement<T>> T[] getParameters(Field<T> field,
                                                              FieldAbsoluteDate<T> date)

Get model parameters.

Type Parameters:

T - type of the elements

Parameters:

field - field to which the elements belong

date - field date at which the parameters want to be known, can be new AbsoluteDate() if all the parameters have no validity period.

Returns:

model parameters

Since:

9.0

getParameterDriver

default ParameterDriver getParameterDriver(String name)

Get parameter value from its name.

Parameters:

name - parameter name

Returns:

parameter value

Since:

8.0

isSupported

default boolean isSupported(String name)

Check if a parameter is supported.

Supported parameters are those listed by getParametersDrivers().

Parameters:

name - parameter name to check

Returns:

true if the parameter is supported

Since:

8.0

See Also:

getParametersDrivers()