org.orekit.files.general

Interface EphemerisFile.SatelliteEphemeris

All Known Implementing Classes:

OEMFile.OemSatelliteEphemeris, OrekitEphemerisFile.OrekitSatelliteEphemeris, SP3File.SP3Ephemeris

Enclosing interface:

EphemerisFile

public static interface EphemerisFile.SatelliteEphemeris

Contains the information about a single satellite from an EphemerisFile.

A satellite ephemeris consists of one or more EphemerisFile.EphemerisSegments. Segments are typically used to split up an ephemeris at discontinuous events, such as a maneuver.

Author:

Evan Ward

See Also:

EphemerisFile, EphemerisFile.EphemerisSegment

Method Summary

Modifier and Type	Method and Description
String	getId() Get the satellite ID.
double	getMu() Get the standard gravitational parameter for the satellite.
default BoundedPropagator	getPropagator() View this ephemeris as a propagator, combining data from all segments.
List<? extends EphemerisFile.EphemerisSegment>	getSegments() Get the segments of the ephemeris.
AbsoluteDate	getStart() Get the start date of the ephemeris.
AbsoluteDate	getStop() Get the end date of the ephemeris.

Method Detail

getId

String getId()

Get the satellite ID. The satellite ID is unique only within the same ephemeris file.

Returns:

the satellite's ID, never null.

getMu

double getMu()

Get the standard gravitational parameter for the satellite.

Returns:

the gravitational parameter use in getPropagator(), in m^3 / s^2.

getSegments

List<? extends EphemerisFile.EphemerisSegment> getSegments()

Get the segments of the ephemeris.

Ephemeris segments are typically used to split an ephemeris around discontinuous events, such as maneuvers.

Returns:

the segments contained in the ephemeris file for this satellite.

getStart

AbsoluteDate getStart()

Get the start date of the ephemeris.

The date returned by this method is equivalent to getPropagator().getMinDate().

Returns:

ephemeris start date.

getStop

AbsoluteDate getStop()

Get the end date of the ephemeris.

The date returned by this method is equivalent to getPropagator().getMaxDate().

Returns:

ephemeris end date.

getPropagator

default BoundedPropagator getPropagator()
                                 throws OrekitException

View this ephemeris as a propagator, combining data from all segments.

In order to view the ephemeris for this satellite as a Propagator several conditions must be met. An Orekit Frame and TimeScale must be constructable from the frame and time scale specification in the ephemeris file. This condition is met when EphemerisFile.EphemerisSegment.getFrame() and EphemerisFile.EphemerisSegment.getTimeScale() return normally for all segments. If there are multiple segments they must be adjacent such that there are no duplicates or gaps in the ephemeris. The definition of adjacent depends on the ephemeris format as some formats define usable start and stop times that are different from the ephemeris data start and stop times. If these conditions are not met an OrekitException may be thrown by this method or by one of the methods of the returned Propagator.

Each call to this method creates a new propagator.

Returns:

a propagator for all the data in this ephemeris file.

Throws:

OrekitException - if any of the conditions are not met.