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:
CdmHeader
public class Header extends CommentsContainer
Header of a CCSDS Navigation Data Message.- Since:
- 10.2
- Author:
- Bryan Cazabonne
-
-
Constructor Summary
Constructors Constructor Description Header(double minVersionMessageId)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AbsoluteDate
getCreationDate()
Get the file creation date and time in UTC.double
getFormatVersion()
Get the CCSDS NDM (ADM, ODM or TDM) format version.String
getMessageId()
Get the ID that uniquely identifies a message from a given originator.String
getOriginator()
Get the file originator.void
setCreationDate(AbsoluteDate creationDate)
Set the file creation date and time in UTC.void
setFormatVersion(double formatVersion)
Set the CCSDS NDM (ADM, ODM or TDM) format version.void
setMessageId(String messageId)
Set the ID that uniquely identifies a message from a given originator.void
setOriginator(String originator)
Set the file originator.void
validate(double version)
Check is all mandatory entries have been initialized.-
Methods inherited from class org.orekit.files.ccsds.section.CommentsContainer
acceptComments, addComment, checkAllowed, checkNotNaN, checkNotNegative, checkNotNull, getComments, refuseFurtherComments
-
-
-
-
Constructor Detail
-
Header
public Header(double minVersionMessageId)
Constructor.- Parameters:
minVersionMessageId
- minimum version forHeaderKey.MESSAGE_ID
-
-
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 interfaceSection
- Overrides:
validate
in classCommentsContainer
- 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
-
getCreationDate
public AbsoluteDate getCreationDate()
Get the file creation date and time in UTC.- Returns:
- the file creation date and time in UTC.
-
setCreationDate
public void setCreationDate(AbsoluteDate creationDate)
Set the file creation date and time in UTC.- Parameters:
creationDate
- the creation date to be set
-
getOriginator
public String getOriginator()
Get the file originator.- Returns:
- originator the file originator.
-
setOriginator
public void setOriginator(String originator)
Set the file 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
-
-