Package org.orekit.utils

Interface ParameterDriversProvider

All Known Subinterfaces:

AccelerationModel, AttitudeProvider, AttitudeProviderModifier, AttitudeRotationModel, BoundedAttitudeProvider, DSSTForceModel, EstimationModifier<T>, ForceModel, ForceModelModifier, GNSSAttitudeProvider, IonosphericDelayModel, IonosphericModel, ManeuverTriggers, ObservedMeasurement<T>, PropulsionModel, RadiationForceModel, ResettableManeuverTriggers, ThrustPropulsionModel, TroposphericModel

All Known Implementing Classes:

AberrationModifier, AbstractAlmanac, AbstractAnalyticalGradientConverter, AbstractBodyAttraction, AbstractConstantThrustPropulsionModel, AbstractDragForceModel, AbstractGaussianContribution, AbstractInterSatellitesMeasurement, AbstractManeuverTriggers, AbstractMeasurement, AbstractNavigationMessage, AbstractOnBoardMeasurement, AbstractOneWayGNSSMeasurement, AbstractParametricAcceleration, AbstractRadiationForceModel, AbstractRelativisticClockOnBoardRangeRateModifier, AbstractVienna, AbstractWindUp, AggregateBoundedAttitudeProvider, AlignedAndConstrained, AngularAzEl, AngularIonosphericDelayModifier, AngularRaDec, AngularRadioRefractionModifier, AskneNordiusModel, AttitudesSequence, AttitudesSwitcher, BasicConstantThrustPropulsionModel, BeidouAlmanac, BeidouCivilianNavigationMessage, BeidouGeo, BeidouIGSO, BeidouLegacyNavigationMessage, BeidouMeo, Bias, BistaticRange, BistaticRangeIonosphericDelayModifier, BistaticRangeRate, BistaticRangeRateIonosphericDelayModifier, BistaticRangeRateTroposphericDelayModifier, BistaticRangeTroposphericDelayModifier, BodyCenterPointing, BrouwerLyddanePropagator, CanonicalSaastamoinenModel, CelestialBodyPointed, CivilianNavigationMessage, CommonGnssData, ConstantThrustManeuver, ConstantTroposphericModel, CR3BPForceModel, DateBasedManeuverTriggers, DeSitterRelativity, DragForce, DSSTAtmosphericDrag, DSSTJ2SquaredClosedForm, DSSTNewtonianAttraction, DSSTSolarRadiationPressure, DSSTTesseral, DSSTThirdBody, DSSTZonal, DynamicOutlierFilter, ECOM2, EstimatedIonosphericModel, EstimatedModel, FDOA, FieldAbstractAlmanac, FieldAbstractAnalyticalPropagator, FieldAbstractNavigationMessage, FieldBeidouAlmanac, FieldBeidouCivilianNavigationMessage, FieldBeidouLegacyNavigationMessage, FieldBrouwerLyddanePropagator, FieldCivilianNavigationMessage, FieldCommonGnssData, FieldDeepSDP4, FieldEcksteinHechlerPropagator, FieldGalileoAlmanac, FieldGalileoNavigationMessage, FieldGnssOrbitalElements, FieldGnssPropagator, FieldGPSAlmanac, FieldGPSCivilianNavigationMessage, FieldGPSLegacyNavigationMessage, FieldIntegratedEphemeris, FieldIntelsatElevenElementsPropagator, FieldKeplerianPropagator, FieldLegacyNavigationMessage, FieldNavICAlmanac, FieldNavicL1NvNavigationMessage, FieldNavicLegacyNavigationMessage, FieldQZSSAlmanac, FieldQZSSCivilianNavigationMessage, FieldQZSSLegacyNavigationMessage, FieldSGP4, FieldTLE, FieldTLEPropagator, FixedRate, FixedTroposphericDelay, FrameAlignedProvider, Galileo, GalileoAlmanac, GalileoNavigationMessage, GenericGNSS, GlobalIonosphereMapModel, Glonass, GNSSOrbitalElements, GNSSOrbitalElementsDriversProvider, GPSAlmanac, GPSBlockIIA, GPSBlockIIF, GPSBlockIIR, GPSCivilianNavigationMessage, GPSLegacyNavigationMessage, GroundPointing, GroundPointingAttitudeModifier, GroundReceiverMeasurement, HarmonicAccelerationModel, HolmesFeatherstoneAttractionModel, InertialForces, InterSatellitesOneWayRangeRate, InterSatellitesPhase, InterSatellitesRange, InterSatellitesWindUp, IntervalEventTrigger, ITURP834PathDelay, J2OnlyPerturbation, KlobucharIonoModel, KnockeRediffusedForceModel, LegacyNavigationMessage, LenseThirringRelativity, LofOffset, LofOffsetPointing, Maneuver, MariniMurray, MendesPavlisModel, ModifiedHopfieldModel, ModifiedSaastamoinenModel, MultiplexedMeasurement, NadirPointing, NavICAlmanac, NavICL1NvNavigationMessage, NavICLegacyNavigationMessage, NeQuickGalileo, NeQuickItu, NeQuickModel, NewtonianAttraction, OceanTides, OnBoardAntennaInterSatellitesPhaseModifier, OnBoardAntennaInterSatellitesRangeModifier, OnBoardAntennaOneWayGNSSPhaseModifier, OnBoardAntennaOneWayGNSSRangeModifier, OnBoardAntennaTurnAroundRangeModifier, OneWayGNSSPhase, OneWayGNSSRange, OneWayGNSSRangeRate, OutlierFilter, ParametricAcceleration, Phase, PhaseCentersPhaseModifier, PhaseCentersRangeModifier, PhaseIonosphericDelayModifier, PhaseTroposphericDelayModifier, PolynomialAccelerationModel, Position, ProfileThrustPropulsionModel, PV, QZSSAlmanac, QZSSCivilianNavigationMessage, QZSSLegacyNavigationMessage, RadiationPressureModel, Range, RangeIonosphericDelayModifier, RangeRate, RangeRateIonosphericDelayModifier, RangeRateTroposphericDelayModifier, RangeTroposphericDelayModifier, RelativisticClockInterSatellitesOneWayRangeRateModifier, RelativisticClockInterSatellitesPhaseModifier, RelativisticClockInterSatellitesRangeModifier, RelativisticClockOneWayGNSSPhaseModifier, RelativisticClockOneWayGNSSRangeModifier, RelativisticClockOneWayGNSSRangeRateModifier, RelativisticClockPhaseModifier, RelativisticClockRangeModifier, RelativisticClockRangeRateModifier, RelativisticJ2ClockInterSatellitesPhaseModifier, RelativisticJ2ClockInterSatellitesRangeModifier, RelativisticJ2ClockOneWayGNSSPhaseModifier, RelativisticJ2ClockOneWayGNSSRangeModifier, RelativisticJ2ClockPhaseModifier, RelativisticJ2ClockRangeModifier, Relativity, ScaledConstantThrustPropulsionModel, ShapiroInterSatellitePhaseModifier, ShapiroInterSatelliteRangeModifier, ShapiroOneWayGNSSPhaseModifier, ShapiroOneWayGNSSRangeModifier, ShapiroPhaseModifier, ShapiroRangeModifier, SingleBodyAbsoluteAttraction, SingleBodyRelativeAttraction, SolarRadiationPressure, SolidTides, SphericalConstantThrustPropulsionModel, SpinStabilized, SsrVtecIonosphericModel, StartStopEventsTrigger, TabulatedLofOffset, TabulatedProvider, TargetPointing, TDOA, TDOAIonosphericDelayModifier, TDOATroposphericDelayModifier, ThirdBodyAttraction, ThirdBodyAttractionEpoch, TimeIntervalsManeuverTrigger, TimeSpanDragForce, TimeSpanEstimatedModel, TimeSpanParametricAcceleration, TLE, TorqueFree, TurnAroundRange, TurnAroundRangeIonosphericDelayModifier, TurnAroundRangeTroposphericDelayModifier, ViennaOne, ViennaThree, WindUp, YawCompensation, YawSteering

public interface ParameterDriversProvider

Provider for parameters drivers.

Since:

11.2

Author:

Luc Maisonobe, Melina Vanel, Maxime Journot

Method Summary

Modifier and Type	Method	Description
static boolean	findByName(List<ParameterDriver> driversList, String name)	Find if a parameter driver with a given name already exists in a list of parameter drivers.
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

findByName

static boolean findByName(List<ParameterDriver> driversList,
                          String name)

Find if a parameter driver with a given name already exists in a list of parameter drivers.

Parameters:

driversList - the list of parameter drivers

name - the parameter driver's name to filter with

Returns:

true if the name was found, false otherwise

Since:

13.0

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()