org.orekit.tutorials.yaml

Class TutorialEstimatedDateParameter

java.lang.Object

org.orekit.tutorials.yaml.TutorialEstimatedDateParameter

public class TutorialEstimatedDateParameter
extends Object

Utility class for estimated date parameters during a maneuver estimation process.

Dates are read from a YAML file. Initial, minimum and maximum dates for the parameter are stored into an AbsoluteDate array.

NOTE: the minimum and maximum dates are automatically set by the algorithm to NEGATIVE and POSITIVE infinity respectively, regardless the values provided in the input file.

Constructor Summary

Constructors

Constructor and Description
TutorialEstimatedDateParameter() Constructor.

Method Summary

Modifier and Type	Method and Description
org.orekit.time.AbsoluteDate	getInitialValue() Get the initial value for the estimated date parameter.
org.orekit.time.AbsoluteDate	getMaxValue() Get the maximum allowed value for the date parameter.
org.orekit.time.AbsoluteDate	getMinValue() Get the minimum allowed value for the date parameter.
org.orekit.time.AbsoluteDate[]	getValues() Get the initial, minimum and maximum dates for the parameter.
boolean	isEstimated() Get the flag for the date parameter estimation.
void	setIsEstimated(boolean estimated) Set the flag for the date parameter estimation.
void	setValues(String[] values) Set the initial, minimum and maximum dates for the parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

TutorialEstimatedDateParameter

public TutorialEstimatedDateParameter()

Constructor.

Method Detail

getValues

public org.orekit.time.AbsoluteDate[] getValues()

Get the initial, minimum and maximum dates for the parameter.

Returns:

an AbsoluteDate array containing the initial, minimum and maximum dates for the parameter

setValues

public void setValues(String[] values)

Set the initial, minimum and maximum dates for the parameter.

Parameters:

values - array containing the initial, minimum and maximum dates for the parameter

getInitialValue

public org.orekit.time.AbsoluteDate getInitialValue()

Get the initial value for the estimated date parameter.

Returns:

the initial value for the estimated date parameter

getMinValue

public org.orekit.time.AbsoluteDate getMinValue()

Get the minimum allowed value for the date parameter.

Returns:

the minimum allowed value for the date parameter

getMaxValue

public org.orekit.time.AbsoluteDate getMaxValue()

Get the maximum allowed value for the date parameter.

Returns:

the maximum allowed value for the date parameter

isEstimated

public boolean isEstimated()

Get the flag for the date parameter estimation.

Returns:

true if the date parameter is estimated

setIsEstimated

public void setIsEstimated(boolean estimated)

Set the flag for the date parameter estimation.

Parameters:

estimated - true if the date parameter is estimated