agi.foundation.navigation.datareaders

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

Class PredictionSupportRecord

java.lang.Object

agi.foundation.navigation.datareaders.PredictionSupportRecord

All Implemented Interfaces:

IEquatable<PredictionSupportRecord>

public class PredictionSupportRecord
extends Object
implements IEquatable<PredictionSupportRecord>

This class provides a record of data read from the Prediction Support file (PSF). This data is used to support statistical predictions of navigation accuracy.

The following descriptions are from the Air Force Navigation Interface Data Description (IDD):

• Orbit error statistics in the PSF are in Radial - Along Track - Cross Track (RAC) coordinates relative to the satellite's orbit. Each value nominally represents the root-mean-square (RMS) of the last seven days' worth of PAF data for that variable. If there is a gap in the data that is 3 days or greater, the RMS will not include data prior to the gap. If less than one day of data is present for a satellite, then an average of all the other satellite's values for that variable is used. No data is to be included in the RMS for any time when the satellite is unhealthy.
• RMS Clock is satellite clock phase error converted to meters and is also nominally computed as an RMS of the last seven days of clock phase error data PerformanceAssessmentRecord The same shortened time interval logic is used for RMS Clock as for RMS RAC errors. No data is used for any time when the satellite is unhealthy.
• RMS User Range Error is a composite term of the RMS Radial, RMS Along Track, RMS Cross Track, and RMS Clock terms computed each time increment and then averaged over the appropriate time interval (nominally seven days) for a satellite.
• A, B and C Radial, Along Track, Cross Track, Clock and Age Of Data terms are set to 0 in version 1 PSF files.

Constructor Summary

Constructors

Constructor and Description
PredictionSupportRecord() Initializes a new instance.
PredictionSupportRecord(int pseudoRandomNumber, double rmsRadialError, double rmsAlongTrackError, double rmsCrossTrackError, double rmsClockError, double rmsUserRangeError) Initializes a new instance with RMS values and pseudo random number, setting all other values to 0.
PredictionSupportRecord(int pseudoRandomNumber, double rmsRadialError, double rmsAlongTrackError, double rmsCrossTrackError, double rmsClockError, double rmsUserRangeError, double radialErrorA, double alongTrackErrorA, double crossTrackErrorA, double clockErrorA, double radialErrorB, double alongTrackErrorB, double crossTrackErrorB, double clockErrorB, double radialErrorC, double alongTrackErrorC, double crossTrackErrorC, double clockErrorC, double ageOfData) Initializes the complete prediction support record.
PredictionSupportRecord(PredictionSupportRecord existingInstance) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
boolean	equalsType(PredictionSupportRecord other) Indicates whether another instance of this type is exactly equal to this instance.
double	getAgeOfData() Gets the age of the navigation data relative to the GPS master control station (MCS) upload generation epoch (minutes).
double	getAlongTrackErrorA() Gets the curve fit 2nd order term for the along track error growth (meters/sec^2).
double	getAlongTrackErrorB() Gets the curve fit 1st order term for the along track error growth (meters/sec).
double	getAlongTrackErrorC() Gets the curve fit 0th order term for the along track error growth (meters).
double	getClockErrorA() Gets the curve fit 2nd order term for the clock error growth (meters/sec^2).
double	getClockErrorB() Gets the curve fit 1st order term for the clock error growth (meters/sec).
double	getClockErrorC() Gets the curve fit 0th order term for the clock error growth (meters).
double	getCrossTrackErrorA() Gets the curve fit 2nd order term for the cross track error growth (meters/sec^2).
double	getCrossTrackErrorB() Gets the curve fit 1st order term for the cross track error growth (meters/sec).
double	getCrossTrackErrorC() Gets the curve fit 0th order term for the cross track error growth (meters).
int	getPseudoRandomNumber() Gets the pseudo random number of the satellite, otherwise known as the PRN or SVID.
double	getRadialErrorA() Gets the curve fit 2nd order term for the radial error growth (meters/sec^2).
double	getRadialErrorB() Gets the curve fit 1st order term for the radial error growth (meters/sec).
double	getRadialErrorC() Gets the curve fit 0th order term for the radial error growth (meters).
double	getRmsAlongTrackError() Gets the Root Mean Square along track error statistic (meters).
double	getRmsClockError() Gets the Root Mean Square clock error statistic (meters).
double	getRmsCrossTrackError() Gets the Root Mean Square cross track error statistic (meters).
double	getRmsRadialError() Gets the Root Mean Square radial error statistic (meters).
double	getRmsUserRangeError() Gets the Root Mean Square user range error statistic (meters).
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
void	setAgeOfData(double value) Sets the age of the navigation data relative to the GPS master control station (MCS) upload generation epoch (minutes).
void	setAlongTrackErrorA(double value) Sets the curve fit 2nd order term for the along track error growth (meters/sec^2).
void	setAlongTrackErrorB(double value) Sets the curve fit 1st order term for the along track error growth (meters/sec).
void	setAlongTrackErrorC(double value) Sets the curve fit 0th order term for the along track error growth (meters).
void	setClockErrorA(double value) Sets the curve fit 2nd order term for the clock error growth (meters/sec^2).
void	setClockErrorB(double value) Sets the curve fit 1st order term for the clock error growth (meters/sec).
void	setClockErrorC(double value) Sets the curve fit 0th order term for the clock error growth (meters).
void	setCrossTrackErrorA(double value) Sets the curve fit 2nd order term for the cross track error growth (meters/sec^2).
void	setCrossTrackErrorB(double value) Sets the curve fit 1st order term for the cross track error growth (meters/sec).
void	setCrossTrackErrorC(double value) Sets the curve fit 0th order term for the cross track error growth (meters).
void	setPseudoRandomNumber(int value) Sets the pseudo random number of the satellite, otherwise known as the PRN or SVID.
void	setRadialErrorA(double value) Sets the curve fit 2nd order term for the radial error growth (meters/sec^2).
void	setRadialErrorB(double value) Sets the curve fit 1st order term for the radial error growth (meters/sec).
void	setRadialErrorC(double value) Sets the curve fit 0th order term for the radial error growth (meters).
void	setRmsAlongTrackError(double value) Sets the Root Mean Square along track error statistic (meters).
void	setRmsClockError(double value) Sets the Root Mean Square clock error statistic (meters).
void	setRmsCrossTrackError(double value) Sets the Root Mean Square cross track error statistic (meters).
void	setRmsRadialError(double value) Sets the Root Mean Square radial error statistic (meters).
void	setRmsUserRangeError(double value) Sets the Root Mean Square user range error statistic (meters).

Methods inherited from class java.lang.Object

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

Constructor Detail

PredictionSupportRecord

public PredictionSupportRecord()

Initializes a new instance.

PredictionSupportRecord

public PredictionSupportRecord(int pseudoRandomNumber,
                               double rmsRadialError,
                               double rmsAlongTrackError,
                               double rmsCrossTrackError,
                               double rmsClockError,
                               double rmsUserRangeError)

Initializes a new instance with RMS values and pseudo random number, setting all other values to 0.

Parameters:

pseudoRandomNumber - The PRN of the vehicle for which this data applies.

rmsRadialError - The Root Mean Square Radial Error

rmsAlongTrackError - The Root Mean Square Along Track Error

rmsCrossTrackError - The Root Mean Square Cross Track Error

rmsClockError - The Root Mean Square Clock Error

rmsUserRangeError - The Root Mean Square User Range Error

PredictionSupportRecord

public PredictionSupportRecord(int pseudoRandomNumber,
                               double rmsRadialError,
                               double rmsAlongTrackError,
                               double rmsCrossTrackError,
                               double rmsClockError,
                               double rmsUserRangeError,
                               double radialErrorA,
                               double alongTrackErrorA,
                               double crossTrackErrorA,
                               double clockErrorA,
                               double radialErrorB,
                               double alongTrackErrorB,
                               double crossTrackErrorB,
                               double clockErrorB,
                               double radialErrorC,
                               double alongTrackErrorC,
                               double crossTrackErrorC,
                               double clockErrorC,
                               double ageOfData)

Initializes the complete prediction support record.

The Age of Data element typically denotes the age of the data being broadcast from the GPS satellite. Since this file type is statistically based, this age of data element doesn't make much sense. But the Air Force has it in the record anyway.

Parameters:

pseudoRandomNumber - The PRN of the vehicle for which this data applies.

rmsRadialError - The Root Mean Square Radial Error

rmsAlongTrackError - The Root Mean Square Along Track Error

rmsCrossTrackError - The Root Mean Square Cross Track Error

rmsClockError - The Root Mean Square Clock Error

rmsUserRangeError - The Root Mean Square User Range Error

radialErrorA - The A coefficient of the Radial Error

alongTrackErrorA - The A coefficient of the Along Track Error

crossTrackErrorA - The A coefficient of the Cross Track Error

clockErrorA - The A coefficient of the Clock Error

radialErrorB - The B coefficient of the Radial Error

alongTrackErrorB - The B coefficient of the Along Track Error

crossTrackErrorB - The B coefficient of the Cross Track Error

clockErrorB - The B coefficient of the Clock Error

radialErrorC - The C coefficient of the Radial Error

alongTrackErrorC - The C coefficient of the Along Track Error

crossTrackErrorC - The C coefficient of the Cross Track Error

clockErrorC - The C coefficient of the Clock Error

ageOfData - The Age of Data

PredictionSupportRecord

public PredictionSupportRecord(@Nonnull
                               PredictionSupportRecord existingInstance)

Initializes a new instance as a copy of an existing instance.

Parameters:

existingInstance - The existing instance to copy.

Throws:

ArgumentNullException - Thrown when existingInstance is null.

Method Detail

equalsType

public final boolean equalsType(PredictionSupportRecord other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<PredictionSupportRecord>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

getAlongTrackErrorA

public final double getAlongTrackErrorA()

Gets the curve fit 2nd order term for the along track error growth (meters/sec^2).

setAlongTrackErrorA

public final void setAlongTrackErrorA(double value)

Sets the curve fit 2nd order term for the along track error growth (meters/sec^2).

getClockErrorA

public final double getClockErrorA()

Gets the curve fit 2nd order term for the clock error growth (meters/sec^2).

setClockErrorA

public final void setClockErrorA(double value)

Sets the curve fit 2nd order term for the clock error growth (meters/sec^2).

getCrossTrackErrorA

public final double getCrossTrackErrorA()

Gets the curve fit 2nd order term for the cross track error growth (meters/sec^2).

setCrossTrackErrorA

public final void setCrossTrackErrorA(double value)

Sets the curve fit 2nd order term for the cross track error growth (meters/sec^2).

getRadialErrorA

public final double getRadialErrorA()

Gets the curve fit 2nd order term for the radial error growth (meters/sec^2).

setRadialErrorA

public final void setRadialErrorA(double value)

Sets the curve fit 2nd order term for the radial error growth (meters/sec^2).

getAlongTrackErrorB

public final double getAlongTrackErrorB()

Gets the curve fit 1st order term for the along track error growth (meters/sec).

setAlongTrackErrorB

public final void setAlongTrackErrorB(double value)

Sets the curve fit 1st order term for the along track error growth (meters/sec).

getClockErrorB

public final double getClockErrorB()

Gets the curve fit 1st order term for the clock error growth (meters/sec).

setClockErrorB

public final void setClockErrorB(double value)

Sets the curve fit 1st order term for the clock error growth (meters/sec).

getCrossTrackErrorB

public final double getCrossTrackErrorB()

Gets the curve fit 1st order term for the cross track error growth (meters/sec).

setCrossTrackErrorB

public final void setCrossTrackErrorB(double value)

Sets the curve fit 1st order term for the cross track error growth (meters/sec).

getRadialErrorB

public final double getRadialErrorB()

Gets the curve fit 1st order term for the radial error growth (meters/sec).

setRadialErrorB

public final void setRadialErrorB(double value)

Sets the curve fit 1st order term for the radial error growth (meters/sec).

getAlongTrackErrorC

public final double getAlongTrackErrorC()

Gets the curve fit 0th order term for the along track error growth (meters).

setAlongTrackErrorC

public final void setAlongTrackErrorC(double value)

Sets the curve fit 0th order term for the along track error growth (meters).

getClockErrorC

public final double getClockErrorC()

Gets the curve fit 0th order term for the clock error growth (meters).

setClockErrorC

public final void setClockErrorC(double value)

Sets the curve fit 0th order term for the clock error growth (meters).

getCrossTrackErrorC

public final double getCrossTrackErrorC()

Gets the curve fit 0th order term for the cross track error growth (meters).

setCrossTrackErrorC

public final void setCrossTrackErrorC(double value)

Sets the curve fit 0th order term for the cross track error growth (meters).

getRadialErrorC

public final double getRadialErrorC()

Gets the curve fit 0th order term for the radial error growth (meters).

setRadialErrorC

public final void setRadialErrorC(double value)

Sets the curve fit 0th order term for the radial error growth (meters).

getRmsAlongTrackError

public final double getRmsAlongTrackError()

Gets the Root Mean Square along track error statistic (meters).

setRmsAlongTrackError

public final void setRmsAlongTrackError(double value)

Sets the Root Mean Square along track error statistic (meters).

getRmsClockError

public final double getRmsClockError()

Gets the Root Mean Square clock error statistic (meters).

setRmsClockError

public final void setRmsClockError(double value)

Sets the Root Mean Square clock error statistic (meters).

getRmsCrossTrackError

public final double getRmsCrossTrackError()

Gets the Root Mean Square cross track error statistic (meters).

setRmsCrossTrackError

public final void setRmsCrossTrackError(double value)

Sets the Root Mean Square cross track error statistic (meters).

getRmsRadialError

public final double getRmsRadialError()

Gets the Root Mean Square radial error statistic (meters).

setRmsRadialError

public final void setRmsRadialError(double value)

Sets the Root Mean Square radial error statistic (meters).

getPseudoRandomNumber

public final int getPseudoRandomNumber()

Gets the pseudo random number of the satellite, otherwise known as the PRN or SVID.

setPseudoRandomNumber

public final void setPseudoRandomNumber(int value)

Sets the pseudo random number of the satellite, otherwise known as the PRN or SVID.

getRmsUserRangeError

public final double getRmsUserRangeError()

Gets the Root Mean Square user range error statistic (meters).

setRmsUserRangeError

public final void setRmsUserRangeError(double value)

Sets the Root Mean Square user range error statistic (meters).

getAgeOfData

public final double getAgeOfData()

Gets the age of the navigation data relative to the GPS master control station (MCS) upload generation epoch (minutes).

setAgeOfData

public final void setAgeOfData(double value)

Sets the age of the navigation data relative to the GPS master control station (MCS) upload generation epoch (minutes).