Package org.orekit.files.ccsds.section

Class Metadata

  • All Implemented Interfaces:
    Section
    Direct Known Subclasses:
    AdmMetadata, CdmMetadata, OdmMetadata, TdmMetadata
    public class Metadata
extends CommentsContainer
    This class gathers the meta-data present in the Navigation Data Message (ADM, ODM and TDM).

    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.0
    Author:
    Luc Maisonobe

    • Constructor Detail

      • Metadata

        protected Metadata​(TimeSystem defaultTimeSystem)
        Simple constructor.
        Parameters:
        defaultTimeSystem - default time system (may be null)

    • 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

      • getTimeSystem

        public TimeSystem getTimeSystem()
        Get the Time System that: for OPM, is used for metadata, state vector, maneuver and covariance data, for OMM, is used for metadata, orbit state and covariance data, for OEM, is used for metadata, ephemeris and covariance data.
        Returns:
        the time system

      • setTimeSystem

        public void setTimeSystem​(TimeSystem timeSystem)
        Set the Time System that: for OPM, is used for metadata, state vector, maneuver and covariance data, for OMM, is used for metadata, orbit state and covariance data, for OEM, is used for metadata, ephemeris and covariance data.
        Parameters:
        timeSystem - the time system to be set

      • getLaunchYear

        protected int getLaunchYear​(String objectID)
        Get the launch year.
        Parameters:
        objectID - object identifier
        Returns:
        launch year

      • getLaunchNumber

        protected int getLaunchNumber​(String objectID)
        Get the launch number.
        Parameters:
        objectID - object identifier
        Returns:
        launch number

      • getLaunchPiece

        protected String getLaunchPiece​(String objectID)
        Get the piece of launch.
        Parameters:
        objectID - object identifier
        Returns:
        piece of launch