agi.foundation.navigation.datareaders

(agi.foundation.navigation-2026r1.jar)

Class SP3cEphemeris

java.lang.Object

agi.foundation.navigation.datareaders.SP3cEphemeris

All Implemented Interfaces:

IAvailability

public class SP3cEphemeris
extends Object
implements IAvailability

Contains data for an SP3 version C precise ephemeris file.

Constructor Summary

Constructors

Constructor and Description
SP3cEphemeris() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
Point	createPoint(SatelliteIdentifier identifier) Creates a point based on the PointInterpolator using the ECEF coordinate frame and the default TranslationalMotionInterpolator.
PlatformCollection	createSatelliteCollection() Creates a GPS satellite for each PRN referenced in the SP3 file.
DateMotionCollection1<Double>	getApproximateClockStandardDeviationDataForSatellite(SatelliteIdentifier identifier) Gets the raw approximate clock standard deviation data associated with a particular satellite.
DateMotionCollection1<Cartesian>	getApproximatePositionalStandardDeviationDataForSatellite(SatelliteIdentifier identifier) Gets the raw approximate positional standard deviation data associated with a particular satellite.
TimeIntervalCollection	getAvailabilityIntervals() Gets a TimeIntervalCollection over which data is available.
TimeIntervalCollection	getAvailabilityIntervals(TimeIntervalCollection consideredIntervals) Gets the intervals over which data is available.
SP3cEphemerisData<Double>	getClockCorrection() Gets the clock data.
SP3cEphemerisData<Double>	getClockCorrectionRate() Gets the clock correction rate data.
SP3cEphemerisData<Double>	getClockCorrectionRateStandardDeviation() Gets the standard deviations for the clock correction rate data, defined on the "EV" lines of the SP3-c file.
SP3cEphemerisData<Double>	getClockCorrectionRateStandardDeviationApproximate() Gets the approximate standard deviations for the clock correction data, defined on the same line as the position data.
SP3cEphemerisData<Double>	getClockCorrectionStandardDeviation() Gets the standard deviations for the clock correction data, defined on the "EP" lines of the SP3-c file.
SP3cEphemerisData<Double>	getClockCorrectionStandardDeviationApproximate() Gets the approximate standard deviations for the clock correction data, defined on the same line as the position data.
DateMotionCollection1<Double>	getClockDataForSatellite(SatelliteIdentifier identifier) Gets the raw clock data associated with a particular satellite.
SP3cEphemerisData<JulianDate>	getClockEvent() Gets the clock event times as indicated by the clock event flag in the position 'P' record.
SP3cEphemerisData<JulianDate>	getClockPredicted() Gets the clock correction prediction times as indicated by the clock prediction flag in the position 'P' record.
DateMotionCollection1<Double>	getClockStandardDeviationDataForSatellite(SatelliteIdentifier identifier) Gets the raw clock standard deviation data associated with a particular satellite.
DateMotionCollection1<SP3cCorrelations>	getCorrelationDataForSatellite(SatelliteIdentifier identifier) Gets the raw correlation data associated with a particular satellite.
SP3cHeaderRecord	getHeader() Gets the header of the SP3-c file.
List<SatelliteIdentifier>	getIdentifiers() Gets the collection of satellite identifiers contained in this SP3-c file.
boolean	getIsVelocityIncluded() Gets a value indicating whether this SP3-c file has velocity data included.
SP3cEphemerisData<JulianDate>	getOrbitManeuver() Gets the orbit maneuver times as indicated by the orbit maneuver flag in the position 'P' record.
SP3cEphemerisData<JulianDate>	getOrbitPredicted() Gets the orbit prediction times as indicated by the orbit prediction flag in the position 'P' record.
DateMotionCollection1<Cartesian>	getPositionalDataForSatellite(SatelliteIdentifier identifier) Gets the raw positional data associated with a particular satellite.
DateMotionCollection1<Cartesian>	getPositionalStandardDeviationDataForSatellite(SatelliteIdentifier identifier) Gets the raw positional standard deviation data associated with a particular satellite.
SP3cEphemerisData<SP3cCorrelations>	getPositionCorrelations() Gets the correlations for the position data, defined on the "EP" lines of the SP3-c file.
SP3cEphemerisData<Cartesian>	getPositions() Gets the position data.
SP3cEphemerisData<Cartesian>	getPositionStandardDeviations() Gets the standard deviations for the position data, defined on the "EP" lines of the SP3-c file.
SP3cEphemerisData<Cartesian>	getPositionStandardDeviationsApproximate() Gets the approximate standard deviations for the position data, defined on the same line as the position data.
List<JulianDate>	getTimes() Gets the epochs listed in the SP3-c file, in the TimeStandard specified by the file.
SP3cEphemerisData<Cartesian>	getVelocities() Gets the velocity data.
SP3cEphemerisData<SP3cCorrelations>	getVelocityCorrelations() Gets the correlations for the velocity data, defined on the "EV" lines of the SP3-c file.
SP3cEphemerisData<Cartesian>	getVelocityStandardDeviations() Gets the standard deviations for the velocity data, defined on the "EV" lines of the SP3-c file.
SP3cEphemerisData<Cartesian>	getVelocityStandardDeviationsApproximate() Gets the approximate standard deviations for the velocity data, defined on the same line as the velocity data.
boolean	isAvailable(JulianDate date) Determines if valid data is available for the given JulianDate.
static SP3cEphemeris	readFrom(BufferedReader reader) Reads the SP3 version C file from the BufferedReader and returns a SP3cEphemeris record.
static SP3cEphemeris	readFrom(String fileName) Reads the SP3 version C file from a file and returns a SP3cEphemeris record.

Methods inherited from class java.lang.Object

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

Constructor Detail

SP3cEphemeris

public SP3cEphemeris()

Initializes a new instance.

Method Detail

getAvailabilityIntervals

public TimeIntervalCollection getAvailabilityIntervals(TimeIntervalCollection consideredIntervals)

Gets the intervals over which data is available.

Specified by:

getAvailabilityIntervals in interface IAvailability

Parameters:

consideredIntervals - The intervals over which availability information is needed. Note that the returned availability intervals may indicate availability outside of these intervals of consideration.

Returns:

The collection of availability intervals.

isAvailable

public final boolean isAvailable(@Nonnull
                                 JulianDate date)

Determines if valid data is available for the given JulianDate.

Specified by:

isAvailable in interface IAvailability

Parameters:

date - The date for which to check availability.

Returns:

true if valid data is available for this date; otherwise false.

getAvailabilityIntervals

@Nonnull
public final TimeIntervalCollection getAvailabilityIntervals()

Gets a TimeIntervalCollection over which data is available. If the availability interval is infinite, this returns Infinite (get).

It is recommended that you call SP3cEphemeris.isAvailable(agi.foundation.time.JulianDate) to determine availability instead of calling this method and checking for yourself.

Returns:

The collection of availability intervals.

readFrom

@Nonnull
public static SP3cEphemeris readFrom(@Nonnull
                                               String fileName)

Reads the SP3 version C file from a file and returns a SP3cEphemeris record.

Parameters:

fileName - The name of the SP3-c file from which to read.

Returns:

SP3cEphemeris.

Throws:

ArgumentNullException - Thrown when fileName is null.

InvalidDataException - Thrown when the file represented by the fileName is not version "C".

InvalidDataException - Thrown when the Position-Velocity flag in the SP3 file is neither 'P' nor 'V'.

readFrom

@Nonnull
public static SP3cEphemeris readFrom(@Nonnull
                                               BufferedReader reader)

Reads the SP3 version C file from the BufferedReader and returns a SP3cEphemeris record.

Parameters:

reader - BufferedReader for the SP3-c file to read.

Returns:

SP3cEphemeris.

Throws:

ArgumentNullException - Thrown when the reader is null.

InvalidDataException - Thrown when the file represented by the reader is not version "C".

InvalidDataException - Thrown when the Position-Velocity flag in the SP3 file is neither 'P' nor 'V'.

createSatelliteCollection

@Nonnull
public final PlatformCollection createSatelliteCollection()

Creates a GPS satellite for each PRN referenced in the SP3 file.

Returns:

The collection of GPS satellites. There is a GpsSatelliteExtension instance for each record in the SP3 file.

createPoint

@Nonnull
public final Point createPoint(@Nonnull
                                         SatelliteIdentifier identifier)

Creates a point based on the PointInterpolator using the ECEF coordinate frame and the default TranslationalMotionInterpolator.

Parameters:

identifier - The satellite to create the point for.

Returns:

A point based on the default interpolator.

Throws:

ArgumentOutOfRangeException - Thrown when the identifier is not listed in this SP3 file.

getTimes

@Nonnull
public final List<JulianDate> getTimes()

Gets the epochs listed in the SP3-c file, in the TimeStandard specified by the file.

getOrbitPredicted

@Nonnull
public final SP3cEphemerisData<JulianDate> getOrbitPredicted()

Gets the orbit prediction times as indicated by the orbit prediction flag in the position 'P' record. If the flag is set for this time, the orbit for this time is predicted, otherwise it is not.

getClockPredicted

@Nonnull
public final SP3cEphemerisData<JulianDate> getClockPredicted()

Gets the clock correction prediction times as indicated by the clock prediction flag in the position 'P' record. If the flag is set for this time, the clock correction for this time is predicted, otherwise it is not.

getClockEvent

@Nonnull
public final SP3cEphemerisData<JulianDate> getClockEvent()

Gets the clock event times as indicated by the clock event flag in the position 'P' record. If the flag is set for this time, there was a clock event after the previous epoch or at this epoch.

getOrbitManeuver

@Nonnull
public final SP3cEphemerisData<JulianDate> getOrbitManeuver()

Gets the orbit maneuver times as indicated by the orbit maneuver flag in the position 'P' record. If the flag is set for this time, there was an orbit maneuver after the previous epoch or at this epoch.

getPositions

@Nonnull
public final SP3cEphemerisData<Cartesian> getPositions()

Gets the position data.

The positions are returned in meters.

getVelocities

@Nonnull
public final SP3cEphemerisData<Cartesian> getVelocities()

Gets the velocity data.

getPositionStandardDeviationsApproximate

@Nonnull
public final SP3cEphemerisData<Cartesian> getPositionStandardDeviationsApproximate()

Gets the approximate standard deviations for the position data, defined on the same line as the position data.

If the standard deviation is blank in the SP3-c file, the returned value will be Double.NaN. The approximate position standard deviations are returned in millimeters and left unscaled by the multipliers in the header.

getVelocityStandardDeviationsApproximate

@Nonnull
public final SP3cEphemerisData<Cartesian> getVelocityStandardDeviationsApproximate()

Gets the approximate standard deviations for the velocity data, defined on the same line as the velocity data.

If the standard deviation is blank in the SP3-c file, the returned value will be Double.NaN. The approximate velocity standard deviations are returned in .0001 millimeters/second and left unscaled by the multipliers in the header.

getPositionStandardDeviations

@Nonnull
public final SP3cEphemerisData<Cartesian> getPositionStandardDeviations()

Gets the standard deviations for the position data, defined on the "EP" lines of the SP3-c file.

If the standard deviation is blank in the SP3-c file, the returned value will be Double.NaN. The position standard deviations are returned in millimeters.

getVelocityStandardDeviations

@Nonnull
public final SP3cEphemerisData<Cartesian> getVelocityStandardDeviations()

Gets the standard deviations for the velocity data, defined on the "EV" lines of the SP3-c file.

If the standard deviation is blank in the SP3-c file, the returned value will be Double.NaN. The velocity standard deviations are returned in .0001 millimeters/second.

getPositionCorrelations

@Nonnull
public final SP3cEphemerisData<SP3cCorrelations> getPositionCorrelations()

Gets the correlations for the position data, defined on the "EP" lines of the SP3-c file.

getVelocityCorrelations

@Nonnull
public final SP3cEphemerisData<SP3cCorrelations> getVelocityCorrelations()

Gets the correlations for the velocity data, defined on the "EV" lines of the SP3-c file.

getClockCorrection

@Nonnull
public final SP3cEphemerisData<Double> getClockCorrection()

Gets the clock data.

The clock correction is returned in microseconds.

getClockCorrectionRate

@Nonnull
public final SP3cEphemerisData<Double> getClockCorrectionRate()

Gets the clock correction rate data.

The clock correction rate is returned in .0001 microseconds/second.

getClockCorrectionStandardDeviationApproximate

@Nonnull
public final SP3cEphemerisData<Double> getClockCorrectionStandardDeviationApproximate()

Gets the approximate standard deviations for the clock correction data, defined on the same line as the position data.

If the standard deviation is blank in the SP3-c file, the returned value will be Double.NaN. The approximate clock correction standard deviation is returned in picoseconds.

getClockCorrectionRateStandardDeviationApproximate

@Nonnull
public final SP3cEphemerisData<Double> getClockCorrectionRateStandardDeviationApproximate()

Gets the approximate standard deviations for the clock correction data, defined on the same line as the position data.

If the standard deviation is blank in the SP3-c file, the returned value will be Double.NaN. The approximate clock correction rate standard deviation is returned in .0001 picoseconds/second.

getClockCorrectionStandardDeviation

@Nonnull
public final SP3cEphemerisData<Double> getClockCorrectionStandardDeviation()

Gets the standard deviations for the clock correction data, defined on the "EP" lines of the SP3-c file.

If the standard deviation is blank in the SP3-c file, the returned value will be Double.NaN. The clock correction standard deviation is returned in picoseconds.

getClockCorrectionRateStandardDeviation

@Nonnull
public final SP3cEphemerisData<Double> getClockCorrectionRateStandardDeviation()

Gets the standard deviations for the clock correction rate data, defined on the "EV" lines of the SP3-c file.

If the standard deviation is blank in the SP3-c file, the returned value will be Double.NaN. The clock correction rate standard deviation is returned in .0001 picoseconds/second.

getHeader

public final SP3cHeaderRecord getHeader()

Gets the header of the SP3-c file.

getIsVelocityIncluded

public final boolean getIsVelocityIncluded()

Gets a value indicating whether this SP3-c file has velocity data included.

getIdentifiers

@Nonnull
public final List<SatelliteIdentifier> getIdentifiers()

Gets the collection of satellite identifiers contained in this SP3-c file.

getPositionalDataForSatellite

@Nonnull
public final DateMotionCollection1<Cartesian> getPositionalDataForSatellite(@Nonnull
                                                                                      SatelliteIdentifier identifier)

Gets the raw positional data associated with a particular satellite. The Order (get) of the data will depend on whether this SP3-c file has velocity data included.

Parameters:

identifier - The identifier of the satellite.

Returns:

The positional data associated with the satellite.

Throws:

ArgumentException - Data does not exist for the specified satellite identifier.

getClockDataForSatellite

@Nonnull
public final DateMotionCollection1<Double> getClockDataForSatellite(@Nonnull
                                                                              SatelliteIdentifier identifier)

Gets the raw clock data associated with a particular satellite. The Order (get) of the data will depend on whether this SP3-c file has velocity data included.

Parameters:

identifier - The identifier of the satellite.

Returns:

The clock data associated with the satellite.

Throws:

ArgumentException - Data does not exist for the specified satellite identifier.

getApproximatePositionalStandardDeviationDataForSatellite

@Nonnull
public final DateMotionCollection1<Cartesian> getApproximatePositionalStandardDeviationDataForSatellite(@Nonnull
                                                                                                                  SatelliteIdentifier identifier)

Gets the raw approximate positional standard deviation data associated with a particular satellite. The Order (get) of the data will depend on whether this SP3-c file has velocity data included.

Parameters:

identifier - The identifier of the satellite.

Returns:

The approximate positional standard deviation data associated with the satellite.

Throws:

ArgumentException - Data does not exist for the specified satellite identifier.

getApproximateClockStandardDeviationDataForSatellite

@Nonnull
public final DateMotionCollection1<Double> getApproximateClockStandardDeviationDataForSatellite(@Nonnull
                                                                                                          SatelliteIdentifier identifier)

Gets the raw approximate clock standard deviation data associated with a particular satellite. The Order (get) of the data will depend on whether this SP3-c file has velocity data included.

Parameters:

identifier - The identifier of the satellite.

Returns:

The approximate clock standard deviation data associated with the satellite.

Throws:

ArgumentException - Data does not exist for the specified satellite identifier.

getPositionalStandardDeviationDataForSatellite

@Nonnull
public final DateMotionCollection1<Cartesian> getPositionalStandardDeviationDataForSatellite(@Nonnull
                                                                                                       SatelliteIdentifier identifier)

Gets the raw positional standard deviation data associated with a particular satellite. The Order (get) of the data will depend on whether this SP3-c file has velocity data included.

Parameters:

identifier - The identifier of the satellite.

Returns:

The approximate positional standard deviation data associated with the satellite.

Throws:

ArgumentException - Data does not exist for the specified satellite identifier.

getClockStandardDeviationDataForSatellite

@Nonnull
public final DateMotionCollection1<Double> getClockStandardDeviationDataForSatellite(@Nonnull
                                                                                               SatelliteIdentifier identifier)

Gets the raw clock standard deviation data associated with a particular satellite. The Order (get) of the data will depend on whether this SP3-c file has velocity data included.

Parameters:

identifier - The identifier of the satellite.

Returns:

The approximate clock standard deviation data associated with the satellite.

Throws:

ArgumentException - Data does not exist for the specified satellite identifier.

getCorrelationDataForSatellite

@Nonnull
public final DateMotionCollection1<SP3cCorrelations> getCorrelationDataForSatellite(@Nonnull
                                                                                              SatelliteIdentifier identifier)

Gets the raw correlation data associated with a particular satellite. The Order (get) of the data will depend on whether this SP3-c file has velocity data included.

Parameters:

identifier - The identifier of the satellite.

Returns:

The correlation data associated with the satellite.

Throws:

ArgumentException - Data does not exist for the specified satellite identifier.