agi.foundation.navigation.datareaders

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

Class SP3aEphemeris

java.lang.Object

agi.foundation.navigation.datareaders.SP3aEphemeris

All Implemented Interfaces:

IAvailability

public class SP3aEphemeris
extends Object
implements IAvailability

Contains data for an SP3 version A precise ephemeris file.

Constructor Summary

Constructors

Constructor and Description
SP3aEphemeris() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
Point	createPoint(int prn) 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.
TimeIntervalCollection	getAvailabilityIntervals() Gets a TimeIntervalCollection over which data is available.
TimeIntervalCollection	getAvailabilityIntervals(TimeIntervalCollection consideredIntervals) Gets the intervals over which data is available.
SP3aEphemerisData<Double>	getClock() Gets the clock data, by pseudorandom number.
SP3aEphemerisData<Double>	getClockRate() Gets the clock rate data, by pseudorandom number.
SP3aHeaderRecord	getHeader() Gets the header of the SP3a file.
boolean	getIsVelocityIncluded() Gets a value indicating whether this SP3a file has velocity data included.
SP3aEphemerisData<Cartesian>	getPositions() Gets the position data, by pseudorandom number.
List<JulianDate>	getTimes() Gets the epochs listed in the SP3a file, in the GPS time standard.
SP3aEphemerisData<Cartesian>	getVelocities() Gets the Velocity data, by pseudorandom number.
boolean	isAvailable(JulianDate date) Determines if valid data is available for the given JulianDate.
static SP3aEphemeris	readFrom(BufferedReader reader) Reads the SP3 version A file from the BufferedReader and returns a SP3aEphemeris Record.
static SP3aEphemeris	readFrom(String fileName) Reads the SP3 version A file from a file and returns a SP3aEphemeris Record.
void	setHeader(SP3aHeaderRecord value) Sets the header of the SP3a file.
void	setIsVelocityIncluded(boolean value) Sets a value indicating whether this SP3a file has velocity data included.

Methods inherited from class java.lang.Object

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

Constructor Detail

SP3aEphemeris

public SP3aEphemeris()

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

Reads the SP3 version A file from a file and returns a SP3aEphemeris Record.

Parameters:

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

Returns:

SP3aEphemeris.

Throws:

ArgumentNullException - Thrown when fileName is null.

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

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

readFrom

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

Reads the SP3 version A file from the BufferedReader and returns a SP3aEphemeris Record.

Parameters:

reader - BufferedReader for the SP3a file to read.

Returns:

SP3aEphemeris.

Throws:

ArgumentNullException - Thrown when the reader is null.

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

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(int prn)

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

Parameters:

prn - The PRN to create the point for.

Returns:

A point based on the default interpolator.

Throws:

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

getTimes

@Nonnull
public final List<JulianDate> getTimes()

Gets the epochs listed in the SP3a file, in the GPS time standard.

getPositions

@Nonnull
public final SP3aEphemerisData<Cartesian> getPositions()

Gets the position data, by pseudorandom number.

The position data is returned in meters.

getVelocities

@Nonnull
public final SP3aEphemerisData<Cartesian> getVelocities()

Gets the Velocity data, by pseudorandom number.

The velocity data is returned in meters/second.

getClock

@Nonnull
public final SP3aEphemerisData<Double> getClock()

Gets the clock data, by pseudorandom number.

The clock data is returned in microseconds.

getClockRate

@Nonnull
public final SP3aEphemerisData<Double> getClockRate()

Gets the clock rate data, by pseudorandom number.

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

getHeader

public final SP3aHeaderRecord getHeader()

Gets the header of the SP3a file.

setHeader

public final void setHeader(SP3aHeaderRecord value)

Sets the header of the SP3a file.

getIsVelocityIncluded

public final boolean getIsVelocityIncluded()

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

setIsVelocityIncluded

public final void setIsVelocityIncluded(boolean value)

Sets a value indicating whether this SP3a file has velocity data included.