Package org.orekit.files.ccsds

Class TDMFile

java.lang.Object

org.orekit.files.ccsds.TDMFile

public class TDMFile
extends Object

This class stocks all the information of the CCSDS Tracking Data Message file parsed by TDMParser or TDMXMLParser.

It contains the header and a list of Observations Blocks each containing TDM metadata and a list of observation data lines.

At this level the observations are not Orekit objects but custom object containing a keyword (type of observation), a timetag (date of the observation) and a measurement (value of the observation).

It is up to the user to convert these observations to Orekit tracking object (Range, Angular, TurnAroundRange etc...).

References:

CCSDS 503.0-B-1 recommended standard ("Tracking Data Message", Blue Book, Version 1.0, November 2007).

Since:

9.0

Author:

Maxime Journot

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TDMFile.Observation	The Observation class contains the data from an observation line.
static class	TDMFile.ObservationsBlock	The Observations Block class contain metadata and the list of observation data lines.
static class	TDMFile.TDMMetaData	The TDMMetadata class gathers the meta-data present in the Tracking Data Message (TDM).

Constructor Summary

Constructors

Constructor	Description
TDMFile()	OEMFile constructor.

Method Summary

Modifier and Type	Method	Description
void	addObservationsBlock()	Add a block to the list of observations blocks.
void	checkTimeSystems()	Check that, according to the CCSDS standard, every ObservationsBlock has the same time system.
AbsoluteDate	getCreationDate()	Get the file creation date and time in UTC.
double	getFormatVersion()	Get the CCSDS TDM format version.
List<String>	getHeaderComment()	Get the header comment.
List<TDMFile.ObservationsBlock>	getObservationsBlocks()	Get the list of observations blocks as an unmodifiable list.
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 ODM (OPM, OMM or OEM) format version.
void	setHeaderComment(List<String> headerComment)	Set the header comment.
void	setObservationsBlocks(List<TDMFile.ObservationsBlock> observationsBlocks)	Set the list of Observations Blocks.
void	setOriginator(String originator)	Set the file originator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TDMFile

public TDMFile()

OEMFile constructor.

Method Detail

getFormatVersion

public double getFormatVersion()

Get the CCSDS TDM format version.

Returns:

format version

setFormatVersion

public void setFormatVersion(double formatVersion)

Set the CCSDS ODM (OPM, OMM or OEM) format version.

Parameters:

formatVersion - the format version to be set

getHeaderComment

public List<String> getHeaderComment()

Get the header comment.

Returns:

header comment

setHeaderComment

public void setHeaderComment(List<String> headerComment)

Set the header comment.

Parameters:

headerComment - header comment

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

addObservationsBlock

public void addObservationsBlock()

Add a block to the list of observations blocks.

getObservationsBlocks

public List<TDMFile.ObservationsBlock> getObservationsBlocks()

Get the list of observations blocks as an unmodifiable list.

Returns:

the list of observations blocks

setObservationsBlocks

public void setObservationsBlocks(List<TDMFile.ObservationsBlock> observationsBlocks)

Set the list of Observations Blocks.

Parameters:

observationsBlocks - the list of Observations Blocks to set

checkTimeSystems

public void checkTimeSystems()
                      throws OrekitException

Check that, according to the CCSDS standard, every ObservationsBlock has the same time system.

Throws:

OrekitException - if some blocks do not have the same time system