agi.foundation.navigation.datareaders

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

Class RinexNavigation

java.lang.Object

agi.foundation.compatibility.BaseCollection<RinexNavigationRecord>

agi.foundation.navigation.datareaders.RinexNavigation

All Implemented Interfaces:

Iterable<RinexNavigationRecord>, Collection<RinexNavigationRecord>, List<RinexNavigationRecord>

public final class RinexNavigation
extends BaseCollection<RinexNavigationRecord>

A RINEX Navigation file describing GPS satellite broadcast orbits and other data. This class represents a RINEX Navigation file, version 2.0 and 2.1. Other versions are not supported.

Reading compressed RINEX files is not currently supported.

Method Summary

Modifier and Type	Method and Description
PlatformCollection	createSatelliteCollection() Creates a GPS satellite for each record in the RINEX Navigation file.
PlatformCollection	createSatelliteCollection(BehaviorBeyondAvailability evaluationBehavior) Creates a GPS satellite for each record in the RINEX Navigation file, using the specified evaluation behavior.
RinexNavigationRecord	findRecordByPrn(int prn) Finds the record corresponding to a particular PRN.
String	getDate() Gets the date of file creation.
double	getDeltaUtcOne() Gets the first order polynomial term for UTC correction
int	getDeltaUtcReferenceTime() Gets the reference time for UTC data
int	getDeltaUtcReferenceWeek() Gets the UTC Reference week number.
double	getDeltaUtcZero() Gets the zeroth order polynomial term for UTC correction
double	getIonosphereAlphaOne() Gets the ionosphere parameters of almanac
double	getIonosphereAlphaThree() Gets the ionosphere parameters of almanac
double	getIonosphereAlphaTwo() Gets the ionosphere parameters of almanac
double	getIonosphereAlphaZero() Gets the ionosphere parameters of almanac
double	getIonosphereBetaOne() Gets the ionosphere parameters of almanac
double	getIonosphereBetaThree() Gets the ionosphere parameters of almanac
double	getIonosphereBetaTwo() Gets the ionosphere parameters of almanac
double	getIonosphereBetaZero() Gets the ionosphere parameters of almanac
int	getLeapSeconds() Gets the time correction due to leap seconds
int	getNumberOfSatellites() Gets the number of SVs in the RINEX Navigation file.
String	getProgram() Gets the program that created the file.
String	getRunBy() Gets the agency that created the file.
static RinexNavigation	readFrom(BufferedReader reader) Reads a RINEX Navigation file from the specified stream.
static RinexNavigation	readFrom(String fileName) Reads a RINEX Navigation file from the specified file.

Methods inherited from class agi.foundation.compatibility.BaseCollection

add, add, addAll, addAll, clear, clearItems, contains, containsAll, get, getItems, indexOf, insertItem, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeItem, retainAll, set, setItem, size, subList, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

equals, hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

readFrom

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

Reads a RINEX Navigation file from the specified file.

Parameters:

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

Returns:

The ephemeris read from the file.

Throws:

ArgumentNullException - Thrown when fileName is null.

InvalidDataException - Thrown when the Rinex Meteorological File has an invalid format.

readFrom

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

Reads a RINEX Navigation file from the specified stream.

Parameters:

reader - The stream from which to read the broadcast ephemeris.

Returns:

The ephemeris read from the stream.

Throws:

ArgumentNullException - Thrown when reader is null.

InvalidDataException - Thrown when the Rinex Meteorological File has an invalid format.

findRecordByPrn

@Nullable
public final RinexNavigationRecord findRecordByPrn(int prn)

Finds the record corresponding to a particular PRN.

Parameters:

prn - The PRN to find.

Returns:

The record corresponding to the PRN, or null if the PRN does not exist in the almanac.

createSatelliteCollection

@Nonnull
public final PlatformCollection createSatelliteCollection()

Creates a GPS satellite for each record in the RINEX Navigation file.

Returns:

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

createSatelliteCollection

@Nonnull
public final PlatformCollection createSatelliteCollection(@Nonnull
                                                                    BehaviorBeyondAvailability evaluationBehavior)

Creates a GPS satellite for each record in the RINEX Navigation file, using the specified evaluation behavior.

Parameters:

evaluationBehavior - Instructs the GpsRinexPropagator what to do when evaluated beyond this file's availability.

Returns:

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

getNumberOfSatellites

public final int getNumberOfSatellites()

Gets the number of SVs in the RINEX Navigation file.

getProgram

@Nonnull
public final String getProgram()

Gets the program that created the file.

getRunBy

@Nonnull
public final String getRunBy()

Gets the agency that created the file.

getDate

@Nonnull
public final String getDate()

Gets the date of file creation.

This date is returned as a string because there is no defined format for the date in the RINEX documentation.

getIonosphereAlphaZero

public final double getIonosphereAlphaZero()

Gets the ionosphere parameters of almanac

getIonosphereAlphaOne

public final double getIonosphereAlphaOne()

Gets the ionosphere parameters of almanac

getIonosphereAlphaTwo

public final double getIonosphereAlphaTwo()

Gets the ionosphere parameters of almanac

getIonosphereAlphaThree

public final double getIonosphereAlphaThree()

Gets the ionosphere parameters of almanac

getIonosphereBetaZero

public final double getIonosphereBetaZero()

Gets the ionosphere parameters of almanac

getIonosphereBetaOne

public final double getIonosphereBetaOne()

Gets the ionosphere parameters of almanac

getIonosphereBetaTwo

public final double getIonosphereBetaTwo()

Gets the ionosphere parameters of almanac

getIonosphereBetaThree

public final double getIonosphereBetaThree()

Gets the ionosphere parameters of almanac

getDeltaUtcZero

public final double getDeltaUtcZero()

Gets the zeroth order polynomial term for UTC correction

getDeltaUtcOne

public final double getDeltaUtcOne()

Gets the first order polynomial term for UTC correction

getDeltaUtcReferenceTime

public final int getDeltaUtcReferenceTime()

Gets the reference time for UTC data

getDeltaUtcReferenceWeek

public final int getDeltaUtcReferenceWeek()

Gets the UTC Reference week number. Continuous number, not mod(1024)!

getLeapSeconds

public final int getLeapSeconds()

Gets the time correction due to leap seconds