Package org.orekit.utils.drivers

Class ParameterDriversSequenceBuilder

java.lang.Object

org.orekit.utils.drivers.ParameterDriversSequenceBuilder

public class ParameterDriversSequenceBuilder
extends Object

Builder for ParameterDriversSequence.

Since:

14.0

Author:

Luc Maisonobe

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SPAN_PREFIX	Prefix for drivers limited to one time span.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ParameterDriversSequenceBuilder	addReferenceValue(double referenceValue)	Add a reference value throughout timeline.
ParameterDriversSequenceBuilder	addReferenceValue(double referenceValue, AbsoluteDate earliestValidityDate, AbsoluteDate latestValidityDate)	Add a reference value valid for a time span.
ParameterDriversSequence	build()	Build a ParameterDriversSequence.

Methods inherited from class java.lang.Object

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

Field Details

SPAN_PREFIX

public static final String SPAN_PREFIX

Prefix for drivers limited to one time span.

See Also:

• Constant Field Values

Constructor Details

ParameterDriversSequenceBuilder

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

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

Method Details

addReferenceValue

public ParameterDriversSequenceBuilder addReferenceValue(double referenceValue)

Add a reference value throughout timeline.

Calling this method is equivalent to call addReferenceValue(referenceValue, AbsoluteDate.PAST_INFINITY, AbsoluteDate.FUTURE_INFINITY).

Parameters:

referenceValue - reference value

Returns:

the instance itself, allowing use of the fluent interface pattern

addReferenceValue

public ParameterDriversSequenceBuilder addReferenceValue(double referenceValue,
 AbsoluteDate earliestValidityDate,
 AbsoluteDate latestValidityDate)

Add a reference value valid for a time span.

Parameters:

referenceValue - reference value

earliestValidityDate - date after which the coefficient is valid

latestValidityDate - date before which the coefficient is valid

Returns:

the instance itself, allowing use of the fluent interface pattern

build

public ParameterDriversSequence build()

Build a ParameterDriversSequence.

If only one reference value has been set, its name will be the base name set at construction. If several reference values have been set, their names will be built by concatenating together SPAN_PREFIX, followed by the base name set at construction, followed by a single "-", and finally appending the index of the parameter driver, counting from 0.

Returns:

built sequence