org.orekit.files.ccsds

Class ODMFile

java.lang.Object

org.orekit.files.ccsds.ODMFile

All Implemented Interfaces:

OrbitFile

Direct Known Subclasses:

OEMFile, OGMFile

public abstract class ODMFile
extends Object
implements OrbitFile

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.orekit.files.general.OrbitFile

OrbitFile.TimeSystem

Constructor Summary

Constructors

Constructor and Description
ODMFile() ODMFile constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsSatellite(String satId) Tests whether a satellite with the given id is contained in this orbit file.
IERSConventions	getConventions() Get IERS conventions.
AbsoluteDate	getCreationDate() Get the file creation date and time in UTC.
double	getEpochInterval() Not supported by CCSDS orbit messages.
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.
int	getNumberOfEpochs() Not supported by CCSDS orbit messages.
String	getOriginator() Get the file originator.
List<SatelliteTimeCoordinate>	getSatelliteCoordinates(String satId) Get the time coordinates for the given satellite.
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

Methods inherited from interface org.orekit.files.general.OrbitFile

getCoordinateSystem, getEpoch, getSatellite, getSatelliteCount, getSatellites, getTimeSystem

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.

getEpochInterval

public double getEpochInterval()

Not supported by CCSDS orbit messages.

Specified by:

getEpochInterval in interface OrbitFile

Returns:

always throws an UnsupportedOperationException

Throws:

UnsupportedOperationException - always

getNumberOfEpochs

public int getNumberOfEpochs()

Not supported by CCSDS orbit messages.

Specified by:

getNumberOfEpochs in interface OrbitFile

Returns:

always throws an UnsupportedOperationException

Throws:

UnsupportedOperationException - always

containsSatellite

public boolean containsSatellite(String satId)

Tests whether a satellite with the given id is contained in this orbit file.

Specified by:

containsSatellite in interface OrbitFile

Parameters:

satId - the satellite id

Returns:

true if the satellite is contained in the file, false otherwise

getSatelliteCoordinates

public List<SatelliteTimeCoordinate> getSatelliteCoordinates(String satId)

Get the time coordinates for the given satellite.

Specified by:

getSatelliteCoordinates in interface OrbitFile

Parameters:

satId - the satellite id

Returns:

a List of SatelliteTimeCoordinate entries for this satellite