Package org.orekit.files.ccsds.ndm.odm

Class OdmCommonMetadata

  • All Implemented Interfaces:
    Section
    Direct Known Subclasses:
    OemMetadata, OmmMetadata
    public class OdmCommonMetadata
extends OdmMetadata
    Common metadata for Orbit Parameter/Ephemeris/Mean Messages.
    Since:
    11.0
    Author:
    Luc Maisonobe

    • Constructor Detail

      • OdmCommonMetadata

        public OdmCommonMetadata()
        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 Metadata
        Parameters:
        version - format version

      • finalizeMetadata

        public void finalizeMetadata​(ContextBinding context)
        Finalize the metadata.

        ODM standard enforces TIME_SYSTEM to appear *after* REF_FRAME_EPOCH, despite it is needed to interpret it. We have to wait until parsing end to finalize this date.

        Parameters:
        context - context binding

      • getObjectID

        public String getObjectID()
        Get the spacecraft ID for which the orbit state is provided.
        Returns:
        the spacecraft ID

      • setObjectID

        public void setObjectID​(String objectID)
        Set the spacecraft ID for which the orbit state is provided.
        Parameters:
        objectID - the spacecraft ID to be set

      • getLaunchYear

        public int getLaunchYear()
        Get the launch year.
        Returns:
        launch year

      • getLaunchNumber

        public int getLaunchNumber()
        Get the launch number.
        Returns:
        launch number

      • getLaunchPiece

        public String getLaunchPiece()
        Get the piece of launch.
        Returns:
        piece of launch

      • getCenter

        public BodyFacade getCenter()
        Get the origin of reference frame.
        Returns:
        the origin of reference frame.

      • setCenter

        public void setCenter​(BodyFacade center)
        Set the origin of reference frame.
        Parameters:
        center - origin of reference frame to be set

      • getFrame

        public Frame getFrame()
        Get the reference frame in which data are given: used for state vector and Keplerian elements data (and for the covariance reference frame if none is given).
        Returns:
        the reference frame

      • getReferenceFrame

        public FrameFacade getReferenceFrame()
        Get the value of REF_FRAME as an Orekit Frame. The CENTER_NAME key word has not been applied yet, so the returned frame may not correspond to the reference frame of the data in the file.
        Returns:
        The reference frame specified by the REF_FRAME keyword.
        See Also:
        getFrame()

      • setReferenceFrame

        public void setReferenceFrame​(FrameFacade referenceFrame)
        Set the reference frame in which data are given: used for state vector and Keplerian elements data (and for the covariance reference frame if none is given).
        Parameters:
        referenceFrame - the reference frame to be set

      • setFrameEpochString

        public void setFrameEpochString​(String frameEpochString)
        Set epoch of reference frame, if not intrinsic to the definition of the reference frame.
        Parameters:
        frameEpochString - the epoch of reference frame to be set

      • getFrameEpoch

        public AbsoluteDate getFrameEpoch()
        Get epoch of reference frame, if not intrinsic to the definition of the reference frame.
        Returns:
        epoch of reference frame

      • setFrameEpoch

        public void setFrameEpoch​(AbsoluteDate frameEpoch)
        Set epoch of reference frame, if not intrinsic to the definition of the reference frame.
        Parameters:
        frameEpoch - the epoch of reference frame to be set