agi.foundation.navigation.datareaders

(agi.foundation.navigation-2024r3.jar)

Class SP3dEphemeris

java.lang.Object

agi.foundation.navigation.datareaders.SP3dEphemeris

All Implemented Interfaces:

IAvailability

public class SP3dEphemeris
extends Object
implements IAvailability

Contains data for an SP3 version D precise ephemeris file.

Constructor Summary

Constructors

Constructor and Description
SP3dEphemeris() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
PlatformCollection	createSatelliteCollection() Creates a GPS satellite for each PRN referenced in the SP3 file.
TimeIntervalCollection	getAvailabilityIntervals() Gets a TimeIntervalCollection over which data is available.
TimeIntervalCollection	getAvailabilityIntervals(TimeIntervalCollection consideredIntervals) Gets the intervals over which data is available.
SP3dEphemerisData<Double>	getClockCorrection() Gets the clock data, by Satellite Identifier.
SP3dEphemerisData<Double>	getClockCorrectionRate() Gets the clock correction rate data, by Satellite Identifier.
SP3dEphemerisData<Double>	getClockCorrectionRateStandardDeviation() Gets the standard deviations for the clock correction rate data, defined on the "EV" lines of the SP3d file, by Satellite Identifier.
SP3dEphemerisData<Double>	getClockCorrectionRateStandardDeviationApproximate() Gets the approximate standard deviations for the clock correction data, defined on the same line as the position data, by Satellite Identifier.
SP3dEphemerisData<Double>	getClockCorrectionStandardDeviation() Gets the standard deviations for the clock correction data, defined on the "EP" lines of the SP3d file, by Satellite Identifier.
SP3dEphemerisData<Double>	getClockCorrectionStandardDeviationApproximate() Gets the approximate standard deviations for the clock correction data, defined on the same line as the position data, by Satellite Identifier.
SP3dEphemerisData<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.
SP3dEphemerisData<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.
SP3dHeaderRecord	getHeader() Gets the header of the SP3d file.
boolean	getIsVelocityIncluded() Gets a value indicating whether this SP3d file has velocity data included.
SP3dEphemerisData<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.
SP3dEphemerisData<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.
SP3dEphemerisData<SP3dCorrelations>	getPositionCorrelations() Gets the correlations for the position data, defined on the "EP" lines of the SP3d file, by Satellite Identifier.
SP3dEphemerisData<Cartesian>	getPositions() Gets the position data, by Satellite Identifier.
SP3dEphemerisData<Cartesian>	getPositionStandardDeviations() Gets the standard deviations for the position data, defined on the "EP" lines of the SP3d file, by Satellite Identifier.
SP3dEphemerisData<Cartesian>	getPositionStandardDeviationsApproximate() Gets the approximate standard deviations for the position data, defined on the same line as the position data, by Satellite Identifier.
List<JulianDate>	getTimes() Gets the epochs listed in the SP3d file, in the TimeStandard specified by the file.
SP3dEphemerisData<Cartesian>	getVelocities() Gets the Velocity data, by Satellite Identifier.
SP3dEphemerisData<SP3dCorrelations>	getVelocityCorrelations() Gets the correlations for the velocity data, defined on the "EV" lines of the SP3d file, by Satellite Identifier.
SP3dEphemerisData<Cartesian>	getVelocityStandardDeviations() Gets the standard deviations for the velocity data, defined on the "EV" lines of the SP3d file, by Satellite Identifier.
SP3dEphemerisData<Cartesian>	getVelocityStandardDeviationsApproximate() Gets the approximate standard deviations for the velocity data, defined on the same line as the velocity data, by Satellite Identifier.
boolean	isAvailable(JulianDate date) Determines if valid data is available for the given JulianDate.
static SP3dEphemeris	readFrom(BufferedReader reader) Reads the SP3 version D file from the BufferedReader and returns a SP3dEphemeris record.
static SP3dEphemeris	readFrom(String fileName) Reads the SP3 version D file from a file and returns a SP3dEphemeris record.

Methods inherited from class java.lang.Object

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

Constructor Detail

SP3dEphemeris

public SP3dEphemeris()

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 SP3dEphemeris.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 SP3dEphemeris readFrom(@Nonnull
                                               String fileName)

Reads the SP3 version D file from a file and returns a SP3dEphemeris record.

Parameters:

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

Returns:

SP3dEphemeris.

Throws:

ArgumentNullException - Thrown when fileName is null.

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

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

readFrom

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

Reads the SP3 version D file from the BufferedReader and returns a SP3dEphemeris record.

Parameters:

reader - BufferedReader for the SP3d file to read.

Returns:

SP3dEphemeris.

Throws:

ArgumentNullException - Thrown when the reader is null.

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

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.

getTimes

@Nonnull
public final List<JulianDate> getTimes()

Gets the epochs listed in the SP3d file, in the TimeStandard specified by the file.

getOrbitPredicted

@Nonnull
public final SP3dEphemerisData<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 SP3dEphemerisData<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 SP3dEphemerisData<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 SP3dEphemerisData<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 SP3dEphemerisData<Cartesian> getPositions()

Gets the position data, by Satellite Identifier.

The positions are returned in meters.

getPositionStandardDeviationsApproximate

@Nonnull
public final SP3dEphemerisData<Cartesian> getPositionStandardDeviationsApproximate()

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

If the standard deviation is blank in the SP3d 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.

getPositionStandardDeviations

@Nonnull
public final SP3dEphemerisData<Cartesian> getPositionStandardDeviations()

Gets the standard deviations for the position data, defined on the "EP" lines of the SP3d file, by Satellite Identifier.

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

getPositionCorrelations

@Nonnull
public final SP3dEphemerisData<SP3dCorrelations> getPositionCorrelations()

Gets the correlations for the position data, defined on the "EP" lines of the SP3d file, by Satellite Identifier.

getVelocities

@Nonnull
public final SP3dEphemerisData<Cartesian> getVelocities()

Gets the Velocity data, by Satellite Identifier.

getVelocityStandardDeviationsApproximate

@Nonnull
public final SP3dEphemerisData<Cartesian> getVelocityStandardDeviationsApproximate()

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

If the standard deviation is blank in the SP3d 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.

getVelocityStandardDeviations

@Nonnull
public final SP3dEphemerisData<Cartesian> getVelocityStandardDeviations()

Gets the standard deviations for the velocity data, defined on the "EV" lines of the SP3d file, by Satellite Identifier.

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

getVelocityCorrelations

@Nonnull
public final SP3dEphemerisData<SP3dCorrelations> getVelocityCorrelations()

Gets the correlations for the velocity data, defined on the "EV" lines of the SP3d file, by Satellite Identifier.

getClockCorrection

@Nonnull
public final SP3dEphemerisData<Double> getClockCorrection()

Gets the clock data, by Satellite Identifier.

The clock correction is returned in microseconds.

getClockCorrectionStandardDeviationApproximate

@Nonnull
public final SP3dEphemerisData<Double> getClockCorrectionStandardDeviationApproximate()

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

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

getClockCorrectionStandardDeviation

@Nonnull
public final SP3dEphemerisData<Double> getClockCorrectionStandardDeviation()

Gets the standard deviations for the clock correction data, defined on the "EP" lines of the SP3d file, by Satellite Identifier.

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

getClockCorrectionRate

@Nonnull
public final SP3dEphemerisData<Double> getClockCorrectionRate()

Gets the clock correction rate data, by Satellite Identifier.

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

getClockCorrectionRateStandardDeviationApproximate

@Nonnull
public final SP3dEphemerisData<Double> getClockCorrectionRateStandardDeviationApproximate()

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

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

getClockCorrectionRateStandardDeviation

@Nonnull
public final SP3dEphemerisData<Double> getClockCorrectionRateStandardDeviation()

Gets the standard deviations for the clock correction rate data, defined on the "EV" lines of the SP3d file, by Satellite Identifier.

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

getHeader

public final SP3dHeaderRecord getHeader()

Gets the header of the SP3d file.

getIsVelocityIncluded

public final boolean getIsVelocityIncluded()

Gets a value indicating whether this SP3d file has velocity data included.