org.orekit.files.ccsds

Class ODMFile

java.lang.Object

org.orekit.files.ccsds.ODMFile

Direct Known Subclasses:

OEMFile, OGMFile

public abstract class ODMFile
extends Object

The ODMFile (Orbit Data Message) class represents any of the three orbit messages used by the CCSDS, i.e. the Orbit Parameter Message (OPM), the Mean-Elements Message (OMM) and the Orbit Ephemeris Message (OEM). It contains the information of the message's header and configuration data (set in the parser).

Since:

6.1

Author:

sports

Constructor Summary

Constructors

Constructor and Description
ODMFile() ODMFile constructor.

Method Summary

Modifier and Type	Method and Description
IERSConventions	getConventions() Get IERS conventions.
AbsoluteDate	getCreationDate() Get the file creation date and time in UTC.
double	getFormatVersion() Get the CCSDS ODM (OPM, OMM or OEM) format version.
List<String>	getHeaderComment() Get the header comment.
AbsoluteDate	getMissionReferenceDate() Get reference date for Mission Elapsed Time and Mission Relative Time time systems.
double	getMuCreated() Get the gravitational coefficient created from the knowledge of the central body.
double	getMuParsed() Get the gravitational coefficient parsed in the ODM File.
double	getMuSet() Get the gravitational coefficient set by the user.
double	getMuUsed() Get the used gravitational coefficient.
String	getOriginator() Get the file originator.
protected void	setMuUsed() Set the gravitational coefficient created from the knowledge of the central body.

Methods inherited from class java.lang.Object

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

Constructor Detail

ODMFile

public ODMFile()

ODMFile constructor.

Method Detail

getMuSet

public double getMuSet()

Get the gravitational coefficient set by the user.

Returns:

the coefficient

getMuParsed

public double getMuParsed()

Get the gravitational coefficient parsed in the ODM File.

Returns:

the coefficient

getMuCreated

public double getMuCreated()

Get the gravitational coefficient created from the knowledge of the central body.

Returns:

the coefficient

getMuUsed

public double getMuUsed()

Get the used gravitational coefficient.

Returns:

the coefficient

setMuUsed

protected void setMuUsed()
                  throws OrekitException

Set the gravitational coefficient created from the knowledge of the central body. In order of decreasing priority, finalMU is set equal to:

1. the coefficient parsed in the file,
2. the coefficient set by the user with the parser's method setMu,
3. the coefficient created from the knowledge of the central body.

Throws:

OrekitException - if no gravitational coefficient can be found

getConventions

public IERSConventions getConventions()
                               throws OrekitException

Get IERS conventions.

Returns:

conventions IERS conventions

Throws:

OrekitException - if no IERS conventions have been set

getMissionReferenceDate

public AbsoluteDate getMissionReferenceDate()

Get reference date for Mission Elapsed Time and Mission Relative Time time systems.

Returns:

the reference date

getFormatVersion

public double getFormatVersion()

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

Returns:

format version

getHeaderComment

public List<String> getHeaderComment()

Get the header comment.

Returns:

header comment

getCreationDate

public AbsoluteDate getCreationDate()

Get the file creation date and time in UTC.

Returns:

the file creation date and time in UTC.

getOriginator

public String getOriginator()

Get the file originator.

Returns:

originator the file originator.