Package org.orekit.files.ccsds.ndm.cdm

Class ODParameters

java.lang.Object
org.orekit.files.ccsds.section.CommentsContainer
org.orekit.files.ccsds.ndm.cdm.ODParameters
All Implemented Interfaces:
Section
public class ODParameters extends CommentsContainer
Container for OD parameters data block.

Beware that the Orekit getters and setters all rely on SI units. The parsers and writers take care of converting these SI units into CCSDS mandatory units. The Unit class provides useful fromSi and toSI methods in case the callers already use CCSDS units instead of the API SI units. The general-purpose Unit class (without an 's') and the CCSDS-specific Units class (with an 's') also provide some predefined units. These predefined units and the fromSi and toSI conversion methods are indeed what the parsers and writers use for the conversions.

Since:
11.2
Author:
Melina Vanel

  • Constructor Details

    • ODParameters

      public ODParameters()
      Simple constructor.

  • Method Details

    • validate

      public void validate(double version)
      Check is all mandatory entries have been initialized.

      This method should throw an exception if some mandatory entries are missing or not compatible with version number.

      Specified by:
      validate in interface Section
      Overrides:
      validate in class CommentsContainer
      Parameters:
      version - format version

    • getTimeLastObsStart

      public AbsoluteDate getTimeLastObsStart()
      Get the start of a time interval (UTC) that contains the time of the last accepted observation.
      Returns:
      the start of a time interval (UTC)

    • setTimeLastObsStart

      public void setTimeLastObsStart(AbsoluteDate timeLastObsStart)
      Set the start of a time interval (UTC) that contains the time of the last accepted observation.
      Parameters:
      timeLastObsStart - the start of a time interval (UTC)

    • getTimeLastObsEnd

      public AbsoluteDate getTimeLastObsEnd()
      Get the start of a time interval (UTC) that contains the time of the last accepted observation.
      Returns:
      the start of a time interval (UTC)

    • setTimeLastObsEnd

      public void setTimeLastObsEnd(AbsoluteDate timeLastObsEnd)
      Set the start of a time interval (UTC) that contains the time of the last accepted observation.
      Parameters:
      timeLastObsEnd - the start of a time interval (UTC)

    • getRecommendedOdSpan

      public double getRecommendedOdSpan()
      Get the recommended OD time span calculated for the object.
      Returns:
      the recommended OD time span (in days) calculated for the object

    • setRecommendedOdSpan

      public void setRecommendedOdSpan(double recommendedOdSpan)
      Set the recommended OD time span calculated for the object.
      Parameters:
      recommendedOdSpan - recommended OD time span (in days) calculated for the object

    • getActualOdSpan

      public double getActualOdSpan()
      Get the actual OD time based on the observations available and the RECOMMENDED_OD_SPAN.
      Returns:
      the actual OD time (in days)

    • setActualOdSpan

      public void setActualOdSpan(double actualOdSpan)
      Set the actual OD time based on the observations available and the RECOMMENDED_OD_SPAN.
      Parameters:
      actualOdSpan - the actual OD time (in days)

    • getObsAvailable

      public int getObsAvailable()
      Get the number of observations available for the OD of the object.
      Returns:
      the number of observations available

    • setObsAvailable

      public void setObsAvailable(int obsAvailable)
      Set the number of observations available for the OD of the object.
      Parameters:
      obsAvailable - the number of observations available

    • getObsUsed

      public int getObsUsed()
      Get the number of observations accepted for the OD of the object.
      Returns:
      the number of observations used

    • setObsUsed

      public void setObsUsed(int obsUsed)
      Set the number of observations accepted for the OD of the object.
      Parameters:
      obsUsed - the number of observations used

    • getTracksAvailable

      public int getTracksAvailable()
      Get the number of sensor tracks available for the OD of the object.
      Returns:
      the number of sensor tracks available

    • setTracksAvailable

      public void setTracksAvailable(int tracksAvailable)
      Set the number of sensor tracks available for the OD of the object.
      Parameters:
      tracksAvailable - the number of sensor tracks available

    • getTracksUsed

      public int getTracksUsed()
      Get the number of sensor tracks used for the OD of the object.
      Returns:
      the number of sensor tracks used

    • setTracksUsed

      public void setTracksUsed(int tracksUsed)
      Set the number of sensor tracks used for the OD of the object.
      Parameters:
      tracksUsed - the number of sensor tracks used

    • getResidualsAccepted

      public double getResidualsAccepted()
      Get the percentage of residuals accepted in the OD of the object (from 0 to 100).
      Returns:
      the percentage of residuals accepted in the OD

    • setResidualsAccepted

      public void setResidualsAccepted(double residualsAccepted)
      Set the percentage of residuals accepted in the OD of the object (from 0 to 100).
      Parameters:
      residualsAccepted - the percentage of residuals accepted in the OD to be set

    • getWeightedRMS

      public double getWeightedRMS()
      Get the weighted Root Mean Square (RMS) of the residuals from a batch least squares OD.
      Returns:
      the weighted Root Mean Square (RMS) of the residuals from a batch least squares OD

    • setWeightedRMS

      public void setWeightedRMS(double WeightedRMS)
      Set the weighted Root Mean Square (RMS) of the residuals from a batch least squares OD.
      Parameters:
      WeightedRMS - the weighted Root Mean Square (RMS) of the residuals from a batch least squares OD

    • getOdEpoch

      public AbsoluteDate getOdEpoch()
      Get the epoch of the orbit determination used for this message.
      Returns:
      the odEpoch the epoch of the orbit determination used for this message

    • setOdEpoch

      public void setOdEpoch(AbsoluteDate odEpoch)
      Set the epoch of the orbit determination used for this message.
      Parameters:
      odEpoch - the odEpoch to set