Commit dfa4f528 authored by Luc Maisonobe's avatar Luc Maisonobe
Browse files

Fixed javadoc.

parent 26e2d7fb
Pipeline #2961 failed with stages
in 38 minutes and 24 seconds
......@@ -160,8 +160,7 @@ public interface ForceModel extends ParametersDriversProvider {
* @param 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 ({@link org.orekit.utils.ParameterDriver#setPeriods} with
* validity period = 0)
* interval
* @return force model parameters
* @since 12.0
*/
......@@ -176,11 +175,7 @@ public interface ForceModel extends ParametersDriversProvider {
}
/** Get force model parameters, return a list a all span values
* of all force parameters. In order to select the right value of
* the span accordingly with the date the
* {@link AbstractForceModel#extractParameters}
* should be called (as in {@link #acceleration}
* method).
* of all force parameters.
* @return force model parameters
* @since 12.0
*/
......@@ -241,10 +236,7 @@ public interface ForceModel extends ParametersDriversProvider {
* @param field field to which the elements belong
* @param <T> type of the elements
* @param date field 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 ( {@link org.orekit.utils.ParameterDriver#setPeriods} with
* validity period = 0)
* be new AbsoluteDate() if all the parameters have no validity period.
* @return force model parameters
* @since 9.0
*/
......
......@@ -96,8 +96,7 @@ public interface IonosphericModel extends ParametersDriversProvider, Serializabl
* @param 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 ({@link org.orekit.utils.ParameterDriver#setPeriods} with
* validity period = 0)
* interval.
* @return ionospheric model parameters
*/
default double[] getParameters(AbsoluteDate date) {
......@@ -129,8 +128,7 @@ public interface IonosphericModel extends ParametersDriversProvider, Serializabl
* @param date field 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 ( {@link org.orekit.utils.ParameterDriver#setPeriods} with
* validity period = 0)
* interval.
* @return ionospheric model parameters
*/
default <T extends CalculusFieldElement<T>> T[] getParameters(final Field<T> field, final FieldAbsoluteDate<T> date) {
......
......@@ -84,8 +84,7 @@ public interface DiscreteTroposphericModel extends ParametersDriversProvider {
* @param 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 ({@link org.orekit.utils.ParameterDriver#setPeriods} with
* validity period = 0)
* interval.
* @return tropospheric model parameters
*/
default double[] getParameters(AbsoluteDate date) {
......@@ -117,8 +116,7 @@ public interface DiscreteTroposphericModel extends ParametersDriversProvider {
* @param 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 ({@link org.orekit.utils.ParameterDriver#setPeriods} with
* validity period = 0)
* interval.
* @return tropospheric model parameters
*/
default <T extends CalculusFieldElement<T>> T[] getParameters(final Field<T> field, FieldAbsoluteDate<T> date) {
......
......@@ -61,8 +61,7 @@ import org.orekit.utils.TimeSpanMap.Span;
* However, for low Earth orbits, the magnitude of the perturbative acceleration due to
* atmospheric drag can be significant. Warren Phipps' 1992 thesis considered the atmospheric
* drag by time derivatives of the <i>mean</i> mean anomaly using the catch-all coefficient
* {@link #M2Driver}. Beware that M2Driver must have only 1 span on its TimeSpanMap value (that is
* to say {@link ParameterDriver#setPeriods} method should not be called).
* {@link #M2Driver}. Beware that M2Driver must have only 1 span on its TimeSpanMap value.
*
* Usually, M2 is adjusted during an orbit determination process and it represents the
* combination of all unmodeled secular along-track effects (i.e. not just the atmospheric drag).
......
......@@ -208,8 +208,7 @@ public interface DSSTForceModel extends ParametersDriversProvider {
* @param 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 ({@link org.orekit.utils.ParameterDriver#setPeriods} with
* validity period = 0)
* interval.
* @return force model parameters
* @since 12.0
*/
......@@ -250,8 +249,7 @@ public interface DSSTForceModel extends ParametersDriversProvider {
* @param date field 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 ( {@link org.orekit.utils.ParameterDriver#setPeriods} with
* validity period = 0)
* interval.
* @return force model parameters
* @since 12.0
*/
......@@ -265,7 +263,7 @@ public interface DSSTForceModel extends ParametersDriversProvider {
}
/** Extract the proper parameter drivers' values from the array in input of the
* {@link #acceleration(SpacecraftState, double[]) acceleration} method.
* {@link #updateShortPeriodTerms(double[], SpacecraftState...) updateShortPeriodTerms} method.
* Parameters are filtered given an input date.
* @param parameters the input parameters array containing all span values of all drivers
* from which the parameter values at date date wants to be extracted
......@@ -295,8 +293,8 @@ public interface DSSTForceModel extends ParametersDriversProvider {
}
/** Extract the proper parameter drivers' values from the array in input of the
* {@link #acceleration(FieldSpacecraftState, CalculusFieldElement[]) acceleration} method.
* Parameters are filtered given an input date.
* {@link #updateShortPeriodTerms(CalculusFieldElement[], FieldSpacecraftState...)
* updateShortPeriodTerms} method. Parameters are filtered given an input date.
* @param parameters the input parameters array containing all span values of all drivers
* from which the parameter values at date date wants to be extracted
* @param date the date
......@@ -304,7 +302,7 @@ public interface DSSTForceModel extends ParametersDriversProvider {
* @return the parameters given the date
*/
default <T extends CalculusFieldElement<T>> T[] extractParameters(final T[] parameters,
final FieldAbsoluteDate<T> date) {
final FieldAbsoluteDate<T> date) {
// Find out the indexes of the parameters in the whole array of parameters
final List<ParameterDriver> allParameters = getParametersDrivers();
......
......@@ -308,7 +308,7 @@ public class ParameterDriver {
/** Add an observer for this driver.
* <p>
* The observer {@link ParameterObserver#valueSpanMapChanged(double, ParameterDriver)
* The observer {@link ParameterObserver#valueSpanMapChanged(TimeSpanMap, ParameterDriver)
* valueSpanMapChanged} method is called once automatically when the
* observer is added, and then called at each value change.
* </p>
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment