Package org.orekit.utils.drivers

Class BaseParameterDriver<P extends BaseParameterDriver<P,O>,O extends BaseParameterObserver<P,O>>

java.lang.Object
org.orekit.utils.drivers.BaseParameterDriver<P,O>
Type Parameters:
P - type of the parameter driver
O - type of the parameter observer
Direct Known Subclasses:
FieldParameterDriver, ParameterDriver
public abstract class BaseParameterDriver<P extends BaseParameterDriver<P,O>,O extends BaseParameterObserver<P,O>> extends Object
Common features for both ParameterDriver and FieldParameterDriver.
Since:
14.0
Author:
Luc Maisonobe
See Also:

  • Constructor Details

    • BaseParameterDriver

      public BaseParameterDriver(String name, double scale, double minValue, double maxValue, TimeInterval validity)
      Simple constructor.

      At construction, the parameter is configured as not selected, the reference date is set to null, the value is set to the referenceValue.

      Parameters:
      name - name 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

  • Method Details

    • addObserver

      public void addObserver(O observer)
      Add an observer for this driver.
      Parameters:
      observer - observer to add

    • removeObserver

      public void removeObserver(O observer)
      Remove an observer.
      Parameters:
      observer - observer to remove
      Since:
      9.1

    • replaceObserver

      public void replaceObserver(O oldObserver, O newObserver)
      Replace an observer.
      Parameters:
      oldObserver - observer to replace
      newObserver - new observer to use
      Since:
      10.1

    • getObservers

      public List<O> getObservers()
      Get the observers for this driver.
      Returns:
      an unmodifiable view of the observers for this driver
      Since:
      9.1

    • getName

      public String getName()
      Get parameter driver general name.
      Returns:
      name

    • setName

      public void setName(String name)
      Change the general name of this parameter driver.
      Parameters:
      name - new name

    • getMinValue

      public double getMinValue()
      Get minimum parameter value.
      Returns:
      minimum parameter value

    • setMinValue

      public void setMinValue(double minValue)
      Set minimum parameter value.
      Parameters:
      minValue - the minimum value to set.
      Since:
      9.3

    • getMaxValue

      public double getMaxValue()
      Get maximum parameter value.
      Returns:
      maximum parameter value

    • setMaxValue

      public void setMaxValue(double maxValue)
      Set maximum parameter value.
      Parameters:
      maxValue - the maximum value to set.

    • getScale

      public double getScale()
      Get scale.
      Returns:
      scale

    • setScale

      public void setScale(double scale)
      Set scale.
      Parameters:
      scale - the scale to set.
      Since:
      9.3

    • getValidity

      public TimeInterval getValidity()
      Get the validity interval.
      Returns:
      validity interval
      Since:
      14.0

    • setValidity

      public void setValidity(TimeInterval validity)
      Set the validity interval.
      Parameters:
      validity - validity interval
      Since:
      14.0

    • setSelected

      public void setSelected(boolean selected)
      Configure a parameter selection status.

      Selection is used for estimated parameters in orbit determination, or to compute the Jacobian matrix in partial derivatives computation.

      Parameters:
      selected - if true the parameter is selected, otherwise it will be fixed

    • isSelected

      public boolean isSelected()
      Check if parameter is selected.

      Selection is used for estimated parameters in orbit determination, or to compute the Jacobian matrix in partial derivatives computation.

      Returns:
      true if parameter is selected, false if it is not