Package org.orekit.files.ccsds.section

Class Header

java.lang.Object
org.orekit.files.ccsds.section.CommentsContainer
org.orekit.files.ccsds.section.Header
All Implemented Interfaces:
Section
Direct Known Subclasses:
AdmHeader, CdmHeader, OdmHeader, TdmHeader
public class Header extends CommentsContainer
Header of a CCSDS Navigation Data Message.
Since:
10.2
Author:
Bryan Cazabonne

  • Constructor Details

    • Header

      public Header(double minVersionMessageId, double minVersionClassification)
      Constructor.
      Parameters:
      minVersionMessageId - minimum version for HeaderKey.MESSAGE_ID
      minVersionClassification - minimum version for HeaderKey.CLASSIFICATION

  • 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

    • getFormatVersion

      public double getFormatVersion()
      Get the CCSDS NDM (ADM, ODM or TDM) format version.
      Returns:
      format version

    • setFormatVersion

      public void setFormatVersion(double formatVersion)
      Set the CCSDS NDM (ADM, ODM or TDM) format version.
      Parameters:
      formatVersion - the format version to be set

    • getClassification

      public String getClassification()
      Get the classification/caveats.
      Returns:
      classification/caveats.

    • setClassification

      public void setClassification(String classification)
      Set the classification/caveats.
      Parameters:
      classification - classification/caveats to be set

    • getCreationDate

      public AbsoluteDate getCreationDate()
      Get the message creation date and time in UTC.
      Returns:
      the message creation date and time in UTC.

    • setCreationDate

      public void setCreationDate(AbsoluteDate creationDate)
      Set the message creation date and time in UTC.
      Parameters:
      creationDate - the creation date to be set

    • getOriginator

      public String getOriginator()
      Get the message originator.
      Returns:
      originator the message originator.

    • setOriginator

      public void setOriginator(String originator)
      Set the message originator.
      Parameters:
      originator - the originator to be set

    • getMessageId

      public String getMessageId()
      Get the ID that uniquely identifies a message from a given originator.
      Returns:
      ID that uniquely identifies a message from a given originator

    • setMessageId

      public void setMessageId(String messageId)
      Set the ID that uniquely identifies a message from a given originator.
      Parameters:
      messageId - ID that uniquely identifies a message from a given originator