fr.cnes.sirius.patrius.files.general

Interface OrbitFile

All Known Implementing Classes:

SP3File

public interface OrbitFile

Interface for orbit file representations.

Author:

Thomas Neidhart

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OrbitFile.TimeSystem Time system used throughout this orbit file.

Method Summary

Modifier and Type	Method and Description
boolean	containsSatellite(String satId) Tests whether a satellite with the given id is contained in this orbit file.
String	getCoordinateSystem() Returns the coordinate system of the entries in this orbit file.
AbsoluteDate	getEpoch() Returns the start epoch of the orbit file.
double	getEpochInterval() Returns the time interval between epochs (in seconds).
int	getNumberOfEpochs() Returns the number of epochs contained in this orbit file.
SatelliteInformation	getSatellite(String satId) Get additional information about a satellite.
List<SatelliteTimeCoordinate>	getSatelliteCoordinates(String satId) Get the time coordinates for the given satellite.
int	getSatelliteCount() Get the number of satellites contained in this orbit file.
Collection<SatelliteInformation>	getSatellites() Returns a Collection of SatelliteInformation objects for all satellites contained in this orbit file.
OrbitFile.TimeSystem	getTimeSystem() Returns the OrbitFile.TimeSystem used to time-stamp position entries.

Method Detail

getEpoch

AbsoluteDate getEpoch()

Returns the start epoch of the orbit file.

Returns:

the start epoch

getEpochInterval

double getEpochInterval()

Returns the time interval between epochs (in seconds).

Returns:

the time interval between epochs

getNumberOfEpochs

int getNumberOfEpochs()

Returns the number of epochs contained in this orbit file.

Returns:

the number of epochs

getCoordinateSystem

String getCoordinateSystem()

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

Returns:

the coordinate system

getTimeSystem

OrbitFile.TimeSystem getTimeSystem()

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

Returns:

the OrbitFile.TimeSystem of the orbit file

getSatellites

Collection<SatelliteInformation> getSatellites()

Returns a Collection of SatelliteInformation objects for all satellites contained in this orbit file.

Returns:

a Collection of SatelliteInformation objects

getSatelliteCount

int getSatelliteCount()

Get the number of satellites contained in this orbit file.

Returns:

the number of satellites

getSatellite

SatelliteInformation getSatellite(String satId)

Get additional information about a satellite.

Parameters:

satId - the satellite id

Returns:

a SatelliteInformation object describing the satellite if present, null otherwise

containsSatellite

boolean containsSatellite(String satId)

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

Parameters:

satId - the satellite id

Returns:

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

getSatelliteCoordinates

List<SatelliteTimeCoordinate> getSatelliteCoordinates(String satId)

Get the time coordinates for the given satellite.

Parameters:

satId - the satellite id

Returns:

a List of SatelliteTimeCoordinate entries for this satellite