Package org.orekit.utils.drivers

Class ParameterDriversSequenceBuilder

java.lang.Object

org.orekit.utils.drivers.BaseParameterDriversSequenceBuilder<Double,ParameterDriver,ParameterObserver,ParameterDriversSequence,ParameterDriversSequenceBuilder>

org.orekit.utils.drivers.ParameterDriversSequenceBuilder

public class ParameterDriversSequenceBuilder
extends BaseParameterDriversSequenceBuilder<Double,ParameterDriver,ParameterObserver,ParameterDriversSequence,ParameterDriversSequenceBuilder>

Builder for ParameterDriversSequence.

Since:

14.0

Author:

Luc Maisonobe

Field Summary

Fields inherited from class org.orekit.utils.drivers.BaseParameterDriversSequenceBuilder

SPAN_PREFIX

Constructor Summary

Constructors

Constructor	Description
ParameterDriversSequenceBuilder(String baseName, double scale, double minValue, double maxValue, Double defaultValue)	Constructor for an initially empty builder.

Method Summary

Modifier and Type	Method	Description
protected ParameterDriver	buildDriver(String name, Double referenceValue, double scale, double minValue, double maxValue, TimeInterval validity)	Build a parameter driver.
protected ParameterDriversSequence	buildSequence(TimeSpanMap<ParameterDriver> drivers)	Build a sequence.

Methods inherited from class org.orekit.utils.drivers.BaseParameterDriversSequenceBuilder

addReferenceValue, addReferenceValue, build

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ParameterDriversSequenceBuilder

public ParameterDriversSequenceBuilder(String baseName,
 double scale,
 double minValue,
 double maxValue,
 Double defaultValue)

Constructor for an initially empty builder.

The builder build() method cannot be called right after construction. Some reference values must be set before, either by calling the addReferenceValue(referenceValue) method once, or by calling the addReferenceValue(referenceValue, earliestValidityDate, latestValidityDate) method as many times as needed to cover the usage range before the build() method can be called.

Parameters:

baseName - base name of the parameters

scale - scaling factor to convert the parameters value to non-dimensional (typically set to the expected standard deviation of the parameter), it must be non-zero

minValue - minimum value allowed

maxValue - maximum value allowed

defaultValue - default value valid throughout timeline

Method Details

buildDriver

protected ParameterDriver buildDriver(String name,
 Double referenceValue,
 double scale,
 double minValue,
 double maxValue,
 TimeInterval validity)

Build a parameter driver.

Specified by:

buildDriver in class BaseParameterDriversSequenceBuilder<Double,ParameterDriver,ParameterObserver,ParameterDriversSequence,ParameterDriversSequenceBuilder>

Parameters:

name - name of the parameter

referenceValue - reference value of the parameter

scale - scaling factor to convert the parameters value to non-dimensional (typically set to the expected standard deviation of the parameter), it must be non-zero

minValue - minimum value allowed

maxValue - maximum value allowed

validity - validity interval

Returns:

built parameter driver

buildSequence

protected ParameterDriversSequence buildSequence(TimeSpanMap<ParameterDriver> drivers)

Build a sequence.

Specified by:

buildSequence in class BaseParameterDriversSequenceBuilder<Double,ParameterDriver,ParameterObserver,ParameterDriversSequence,ParameterDriversSequenceBuilder>

Parameters:

drivers - drivers sequence

Returns:

built sequence