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

Class AdditionalCovarianceMetadata

  • All Implemented Interfaces:
    Section
    public class AdditionalCovarianceMetadata
extends CommentsContainer
    Container for the additional covariance metadata (optional).

    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.

    • Constructor Detail

      • AdditionalCovarianceMetadata

        public AdditionalCovarianceMetadata()
        Simple constructor.

    • Method Detail

      • 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

      • getDensityForecastUncertainty

        public double getDensityForecastUncertainty()
        Get the atmospheric density forecast error.
        Returns:
        densityForecastUncertainty

      • setDensityForecastUncertainty

        public void setDensityForecastUncertainty​(double densityForecastUncertainty)
        Set the atmospheric density forecast error.
        Parameters:
        densityForecastUncertainty - the cScaleFactorMax to set

      • getcScaleFactorMin

        public double getcScaleFactorMin()
        Get the minimum suggested covariance scale factor.
        Returns:
        the cScaleFactorMin

      • setcScaleFactorMin

        public void setcScaleFactorMin​(double cScaleFactorMin)
        Set the minimum suggested covariance scale factor.
        Parameters:
        cScaleFactorMin - the cScaleFactorMin to set

      • getcScaleFactor

        public double getcScaleFactor()
        Get the (median) suggested covariance scale factor.
        Returns:
        the cScaleFactor

      • setcScaleFactor

        public void setcScaleFactor​(double cScaleFactor)
        Set the (median) suggested covariance scale factor.
        Parameters:
        cScaleFactor - the cScaleFactor to set

      • getcScaleFactorMax

        public double getcScaleFactorMax()
        Get the maximum suggested covariance scale factor.
        Returns:
        the cScaleFactorMax

      • setcScaleFactorMax

        public void setcScaleFactorMax​(double cScaleFactorMax)
        set the maximum suggested covariance scale factor.
        Parameters:
        cScaleFactorMax - the cScaleFactorMax to set

      • getScreeningDataSource

        public String getScreeningDataSource()
        Get the source (or origin) of the specific orbital data for this object.
        Returns:
        the screeningDataSource

      • setScreeningDataSource

        public void setScreeningDataSource​(String screeningDataSource)
        Set the source (or origin) of the specific orbital data for this object.
        Parameters:
        screeningDataSource - the screeningDataSource to set

      • getDcpSensitivityVectorPosition

        public double[] getDcpSensitivityVectorPosition()
        Get the DCP sensitivity vector (position errors at TCA).
        Returns:
        the dcpSensitivityVectorPosition

      • setDcpSensitivityVectorPosition

        public void setDcpSensitivityVectorPosition​(double[] dcpSensitivityVectorPosition)
        Set the DCP sensitivity vector (position errors at TCA).
        Parameters:
        dcpSensitivityVectorPosition - the dcpSensitivityVectorPosition to set

      • getDcpSensitivityVectorVelocity

        public double[] getDcpSensitivityVectorVelocity()
        Get the DCP sensitivity vector (velocity errors at TCA).
        Returns:
        the dcpSensitivityVectorVelocity

      • setDcpSensitivityVectorVelocity

        public void setDcpSensitivityVectorVelocity​(double[] dcpSensitivityVectorVelocity)
        Set the DCP sensitivity vector (velocity errors at TCA).
        Parameters:
        dcpSensitivityVectorVelocity - the dcpSensitivityVectorVelocity to set