Package org.orekit.tutorials.yaml

Class TutorialEstimatedParameter

java.lang.Object

org.orekit.tutorials.yaml.TutorialEstimatedParameter

public class TutorialEstimatedParameter
extends Object

Utility class for estimated parameters during an orbit determination process.

Data are read from a YAML file. Initial, minimum and maximum value of the parameter are stored into an array. Conventions are:

Estimated parameter

Element	Value
0	Initial value
1	Minimum value
2	Maximum value

Author:

Bryan Cazabonne

Constructor Summary

Constructors

Constructor	Description
TutorialEstimatedParameter()	Constructor.

Method Summary

Modifier and Type	Method	Description
double	getInitialValue()	Get the initial value for the estimated parameter.
double	getMaxValue()	Get the maximum allowed value for the parameter.
double	getMinValue()	Get the minimum allowed value for the parameter.
double[]	getValues()	Get the initial, minimum and maximum value of the parameter.
boolean	isEstimated()	Get the flag for the parameter estimation.
void	setIsEstimated(boolean estimated)	Set the flag for the parameter estimation.
void	setValues(double[] values)	Set the initial, minimum and maximum value of the parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

TutorialEstimatedParameter

public TutorialEstimatedParameter()

Constructor.

Method Detail

getValues

public double[] getValues()

Get the initial, minimum and maximum value of the parameter.

Returns:

an array containing the initial, minimum and maximum value of the parameter

setValues

public void setValues(double[] values)

Set the initial, minimum and maximum value of the parameter.

Parameters:

values - array containing the initial, minimum and maximum value of the parameter

getInitialValue

public double getInitialValue()

Get the initial value for the estimated parameter.

Returns:

the initial value for the estimated parameter

getMinValue

public double getMinValue()

Get the minimum allowed value for the parameter.

Returns:

the minimum allowed value for the parameter

getMaxValue

public double getMaxValue()

Get the maximum allowed value for the parameter.

Returns:

the maximum allowed value for the parameter

isEstimated

public boolean isEstimated()

Get the flag for the parameter estimation.

Returns:

true if the parameter is estimated

setIsEstimated

public void setIsEstimated(boolean estimated)

Set the flag for the parameter estimation.

Parameters:

estimated - true if the parameter is estimated