org.orekit.files.ccsds

Class OPMFile

java.lang.Object

org.orekit.files.ccsds.ODMFile

org.orekit.files.ccsds.OGMFile

org.orekit.files.ccsds.OPMFile

All Implemented Interfaces:

OrbitFile

public class OPMFile
extends OGMFile

This class gathers the informations present in the Orbital Parameter Message (OPM), and contains methods to generate CartesianOrbit, KeplerianOrbit or SpacecraftState.

Since:

6.1

Author:

sports

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OPMFile.Maneuver Maneuver in an OPM file.

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

OrbitFile.TimeSystem

Method Summary

Modifier and Type	Method and Description
CartesianOrbit	generateCartesianOrbit() Generate a CartesianOrbit from the OPM state vector data.
KeplerianOrbit	generateKeplerianOrbit() Generate a KeplerianOrbit from the OPM keplerian elements if hasKeplerianElements is true, or from the state vector data otherwise.
SpacecraftState	generateSpacecraftState() Generate spacecraft state from the CartesianOrbit generated by generateCartesianOrbit.
String	getCoordinateSystem() Returns the coordinate system of the entries in this orbit file.
boolean	getHasManeuver() Get boolean testing whether the OPM contains at least one maneuver.
OPMFile.Maneuver	getManeuver(int index) Get a maneuver.
List<OPMFile.Maneuver>	getManeuvers() Get a list of all maneuvers.
ODMMetaData	getMetaData() Get the meta data.
List<String>	getMetaDataComment() Get the comment for meta-data.
int	getNbManeuvers() Get the number of maneuvers present in the OPM.
Vector3D	getPosition() Get position vector.
PVCoordinates	getPVCoordinates() Get the position/velocity coordinates contained in the OPM.
List<SatelliteTimeCoordinate>	getSatelliteCoordinates(String satId) Get the time coordinates for the given satellite.
SatelliteTimeCoordinate	getSatelliteCoordinatesOPM() Get the SatelliteTimeCoordinate of the OPM.
OrbitFile.TimeSystem	getTimeSystem() Returns the OrbitFile.TimeSystem used to time-stamp position entries.
Vector3D	getVelocity() Get velocity vector.

Methods inherited from class org.orekit.files.ccsds.OGMFile

getA, getAnomaly, getAnomalyType, getCovarianceComment, getCovarianceMatrix, getCovRefFrame, getCovRefLofType, getDragArea, getDragCoeff, getE, getEpoch, getEpochComment, getI, getKeplerianElementsComment, getMass, getPa, getRaan, getSatellite, getSatelliteCount, getSatellites, getSolarRadArea, getSolarRadCoeff, getSpacecraftComment, getUserDefinedParameters, hasCovarianceMatrix, hasKeplerianElements

Methods inherited from class org.orekit.files.ccsds.ODMFile

containsSatellite, getConventions, getCreationDate, getEpochInterval, getFormatVersion, getHeaderComment, getMissionReferenceDate, getMuCreated, getMuParsed, getMuSet, getMuUsed, getNumberOfEpochs, getOriginator, setMuUsed

Methods inherited from class java.lang.Object

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

Method Detail

getMetaData

public ODMMetaData getMetaData()

Get the meta data.

Specified by:

getMetaData in class OGMFile

Returns:

meta data

getPosition

public Vector3D getPosition()

Get position vector.

Returns:

the position vector

getVelocity

public Vector3D getVelocity()

Get velocity vector.

Returns:

the velocity vector

getNbManeuvers

public int getNbManeuvers()

Get the number of maneuvers present in the OPM.

Returns:

the number of maneuvers

getManeuvers

public List<OPMFile.Maneuver> getManeuvers()

Get a list of all maneuvers.

Returns:

unmodifiable list of all maneuvers.

getManeuver

public OPMFile.Maneuver getManeuver(int index)

Get a maneuver.

Parameters:

index - maneuver index, counting from 0

Returns:

maneuver

getHasManeuver

public boolean getHasManeuver()

Get boolean testing whether the OPM contains at least one maneuver.

Returns:

true if OPM contains at least one maneuver false otherwise

getMetaDataComment

public List<String> getMetaDataComment()

Get the comment for meta-data.

Returns:

comment for meta-data

getSatelliteCoordinates

public List<SatelliteTimeCoordinate> getSatelliteCoordinates(String satId)

Get the time coordinates for the given satellite.

Specified by:

getSatelliteCoordinates in interface OrbitFile

Overrides:

getSatelliteCoordinates in class ODMFile

Parameters:

satId - the satellite id

Returns:

a List of SatelliteTimeCoordinate entries for this satellite

getSatelliteCoordinatesOPM

public SatelliteTimeCoordinate getSatelliteCoordinatesOPM()

Get the SatelliteTimeCoordinate of the OPM.

Returns:

the SatelliteTimeCoordinate

getPVCoordinates

public PVCoordinates getPVCoordinates()

Get the position/velocity coordinates contained in the OPM.

Returns:

the position/velocity coordinates contained in the OPM

getCoordinateSystem

public String getCoordinateSystem()

Returns the coordinate system of the entries in this orbit file.

Returns:

the coordinate system

getTimeSystem

public OrbitFile.TimeSystem getTimeSystem()

Returns the OrbitFile.TimeSystem used to time-stamp position entries.

Returns:

the OrbitFile.TimeSystem of the orbit file

generateCartesianOrbit

public CartesianOrbit generateCartesianOrbit()
                                      throws OrekitException

Generate a CartesianOrbit from the OPM state vector data. If the reference frame is not pseudo-inertial, an exception is raised.

Returns:

the CartesianOrbit generated from the OPM information

Throws:

OrekitException - if the reference frame is not pseudo-inertial or if the central body gravitational coefficient cannot be retrieved from the OPM

generateKeplerianOrbit

public KeplerianOrbit generateKeplerianOrbit()
                                      throws OrekitException

Generate a KeplerianOrbit from the OPM keplerian elements if hasKeplerianElements is true, or from the state vector data otherwise. If the reference frame is not pseudo-inertial, an exception is raised.

Returns:

the KeplerianOrbit generated from the OPM information

Throws:

OrekitException - if the reference frame is not pseudo-inertial or if the central body gravitational coefficient cannot be retrieved from the OPM

generateSpacecraftState

public SpacecraftState generateSpacecraftState()
                                        throws OrekitException

Generate spacecraft state from the CartesianOrbit generated by generateCartesianOrbit. Raises an exception if OPM doesn't contain spacecraft mass information.

Returns:

the spacecraft state of the OPM

Throws:

OrekitException - if there is no spacecraft mass associated with the OPM