agi.foundation.navigation.datareaders

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

Class RinexNavigationRecord

java.lang.Object

agi.foundation.navigation.datareaders.RinexNavigationRecord

All Implemented Interfaces:

IAvailability

public class RinexNavigationRecord
extends Object
implements IAvailability

An ephemeris record in a RINEX Navigation File, corresponding to a single space vehicle (SV).

Constructor Summary

Constructors

Constructor and Description
RinexNavigationRecord(int prn) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
Platform	createSatellite() Creates a GPS satellite for this RINEX record.
Platform	createSatellite(BehaviorBeyondAvailability evaluationBehavior) Creates a GPS satellite for this RINEX record.
RinexNavigationEphemeris[]	getAllEphemerisData() Retrieves the RinexNavigationEphemeris defining all the characteristics of this satellite.
IGpsElements[]	getAllGpsElementsFromEphemerisData() Retrieves the IGpsElements defining the orbit of this satellite.
TimeIntervalCollection	getAvailabilityIntervals() Gets a TimeIntervalCollection over which data is available.
TimeIntervalCollection	getAvailabilityIntervals(TimeIntervalCollection consideredIntervals) Gets the intervals over which data is available.
RinexNavigationEphemeris	getDataFromMostRecentEphemeris(GlobalPositioningSystemDate date) Retrieves the RinexNavigationEphemeris defining all characteristics of this satellite which represent the most recent ephemeris prior to date, compared to TransmissionTime (get).
IGpsElements	getElementsFromMostRecentEphemeris(GlobalPositioningSystemDate date) Retrieves the IGpsElements defining the orbit of this satellite which represent the most recent ephemeris prior to date.
int	getNumberOfEphemerides() Gets the number of ephemerides in this record for this PseudoRandomNumber (get).
int	getPseudoRandomNumber() Gets the Pseudo Random Number (PRN).
boolean	isAvailable(JulianDate date) Determines if valid data is available for the given JulianDate.
void	readEphemerisBlock(String[] ephemerisBlock) Reads a record from a stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

RinexNavigationRecord

public RinexNavigationRecord(int prn)

Initializes a new instance.

Parameters:

prn - The pseudo-random number (PRN) of satellite associated with this record.

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 RinexNavigationRecord.isAvailable(agi.foundation.time.JulianDate) to determine availability instead of calling this method and checking for yourself.

Returns:

The collection of availability intervals.

readEphemerisBlock

public final void readEphemerisBlock(@Nonnull
                                     String[] ephemerisBlock)

Reads a record from a stream.

Parameters:

ephemerisBlock - The block of eight lines representing the ephemeris for a single GPS PRN.

Throws:

ArgumentNullException - Thrown when ephemerisBlock is null.

ArgumentException - Thrown when the length of the ephemerisBlock is less than 8.

IllegalStateException - Thrown when the ephemerisBlock has an invalid pseudo-random number (PRN) in its first line.

createSatellite

@Nonnull
public final Platform createSatellite()

Creates a GPS satellite for this RINEX record.

Returns:

The satellite created from this record.

createSatellite

@Nonnull
public final Platform createSatellite(@Nonnull
                                                BehaviorBeyondAvailability evaluationBehavior)

Creates a GPS satellite for this RINEX record.

Parameters:

evaluationBehavior - Instructs the GpsRinexPropagator what to do outside of this record's availability.

Returns:

The satellite created from this record.

getElementsFromMostRecentEphemeris

public final IGpsElements getElementsFromMostRecentEphemeris(@Nonnull
                                                             GlobalPositioningSystemDate date)

Retrieves the IGpsElements defining the orbit of this satellite which represent the most recent ephemeris prior to date.

Parameters:

date - The date to consider.

Returns:

The most recent GPS ephemeris. Returns null if the data is prior to all existing data.

getDataFromMostRecentEphemeris

public final RinexNavigationEphemeris getDataFromMostRecentEphemeris(@Nonnull
                                                                     GlobalPositioningSystemDate date)

Retrieves the RinexNavigationEphemeris defining all characteristics of this satellite which represent the most recent ephemeris prior to date, compared to TransmissionTime (get).

The ephemeris blocks are ordered according to the TransmissionTime (get) within the current GPS week. The GpsWeek (get) parameter is not used in the comparison because that week is referenced to the TimeOfEphemeris (get) and not the TransmissionTime (get). While there is a GPS week parameter downlinked by GPS in Subframe 1 (word 3), it is not included in the RINEX format.

Parameters:

date - The date to consider.

Returns:

The most recent GPS data. Returns the first entry if the date is prior to all existing data.

getAllGpsElementsFromEphemerisData

public final IGpsElements[] getAllGpsElementsFromEphemerisData()

Retrieves the IGpsElements defining the orbit of this satellite.

The array is sorted to be sequentially increasing according to TransmissionTime (get).

Returns:

The GPS ephemeris.

getAllEphemerisData

public final RinexNavigationEphemeris[] getAllEphemerisData()

Retrieves the RinexNavigationEphemeris defining all the characteristics of this satellite.

The array is sorted to be sequentially increasing according to TransmissionTimeGpsDate (get).

Returns:

The ephemeris data from this record.

getNumberOfEphemerides

public final int getNumberOfEphemerides()

Gets the number of ephemerides in this record for this PseudoRandomNumber (get).

getPseudoRandomNumber

public final int getPseudoRandomNumber()

Gets the Pseudo Random Number (PRN).