agi.foundation.navigation.datareaders

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

Class YumaAlmanacRecord

java.lang.Object

agi.foundation.navigation.datareaders.YumaAlmanacRecord

All Implemented Interfaces:

IGpsElements

public class YumaAlmanacRecord
extends Object
implements IGpsElements

A record in a YUMA almanac, corresponding to a single space vehicle (SV).

Constructor Summary

Constructors

Constructor and Description
YumaAlmanacRecord() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
Platform	createSatellite() Creates a GPS satellite for this YUMA almanac record.
double	getArgumentOfPerigee() Gets the argument of perigee.
double	getCosineCorrectionToArgumentOfLatitude() Gets the amplitude of the cosine harmonic correction term to the Argument of Latitude.
double	getCosineCorrectionToInclination() Gets the amplitude of the cosine harmonic correction term to the angle of inclination.
double	getCosineCorrectionToOrbitRadius() Gets the amplitude of the sine harmonic correction term to the orbit radius.
double	getEccentricity() Gets eccentricity.
GlobalPositioningSystemDate	getEpoch() Gets the epoch at which these elements are specified.
double	getFirstOrderClockCorrection() Gets the first order clock correction.
int	getHealth() Gets the satellite health code.
double	getInclinationAngle() Gets the inclination angle.
double	getIssueOfData() Gets the issue of data ephemeris (IODE).
double	getLongitudeOfAscendingNode() Gets the longitude of ascending node of orbit plane at weekly epoch.
double	getMeanAnomaly() Gets the mean anomaly.
double	getMeanMotionDifference() Gets the mean motion difference from computed value.
int	getPseudoRandomNumber() Gets the Pseudo Random Number (PRN).
double	getRateOfInclinationAngle() Gets the rate of inclination angle (IDOT).
double	getRateOfRightAscension() Gets the rate of right ascension.
double	getSineCorrectionToArgumentOfLatitude() Gets the amplitude of the sine harmonic correction term to the Argument of Latitude.
double	getSineCorrectionToInclination() Gets the amplitude of the sine harmonic correction term to the angle of inclination.
double	getSineCorrectionToOrbitRadius() Gets the amplitude of the sine harmonic correction term to the orbit radius.
double	getSquareRootOfSemimajorAxis() Gets the square root of the semi-major axis (sqrt(meters)).
double	getZerothOrderClockCorrection() Gets the zeroth order clock correction.
static YumaAlmanacRecord	readFrom(BufferedReader reader, int rolloverCount) Reads a record from a reader.
void	setArgumentOfPerigee(double value) Sets the argument of perigee.
void	setEccentricity(double value) Sets eccentricity.
void	setEpoch(GlobalPositioningSystemDate value) Sets the epoch at which these elements are specified.
void	setFirstOrderClockCorrection(double value) Sets the first order clock correction.
void	setHealth(int value) Sets the satellite health code.
void	setInclinationAngle(double value) Sets the inclination angle.
void	setLongitudeOfAscendingNode(double value) Sets the longitude of ascending node of orbit plane at weekly epoch.
void	setMeanAnomaly(double value) Sets the mean anomaly.
void	setPseudoRandomNumber(int value) Sets the Pseudo Random Number (PRN).
void	setRateOfRightAscension(double value) Sets the rate of right ascension.
void	setSquareRootOfSemimajorAxis(double value) Sets the square root of the semi-major axis (sqrt(meters)).
void	setZerothOrderClockCorrection(double value) Sets the zeroth order clock correction.

Methods inherited from class java.lang.Object

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

Constructor Detail

YumaAlmanacRecord

public YumaAlmanacRecord()

Initializes a new instance.

Method Detail

readFrom

@Nullable
public static YumaAlmanacRecord readFrom(@Nonnull
                                                    BufferedReader reader,
                                                    int rolloverCount)

Reads a record from a reader.

The following list represents the rollover dates for the GPS week parameter. On or after the date listed below, you will need to use the specified rollover count.

Date	Rollover Count
January 6, 1980	0
August 22, 1999	1
April 7, 2019	2
November 21, 2038	3
July 7, 2058	4

To compute the rollover count for a given date, construct a GlobalPositioningSystemDate and use the value of RolloverCount (get / set).

Parameters:

reader - The reader to read from.

rolloverCount - The number of times the GPS week counter had rolled over when this almanac was created. See below for more information.

Returns:

A record read from the stream, or null if there are no records left to be read.

Throws:

ArgumentNullException - Thrown when reader is null.

ArgumentOutOfRangeException - Thrown when rolloverCount is less than zero.

NumberFormatException - Thrown when the Yuma Almanac is not well-formed.

RuntimeException - Thrown when the values in the Yuma almanac are too large.

IndexOutOfBoundsException - Thrown when a line in the Yuma almanac is not well-formed.

getEpoch

@Nonnull
public final GlobalPositioningSystemDate getEpoch()

Gets the epoch at which these elements are specified.

Specified by:

getEpoch in interface IGpsElements

setEpoch

public final void setEpoch(@Nonnull
                           GlobalPositioningSystemDate value)

Sets the epoch at which these elements are specified.

getPseudoRandomNumber

public final int getPseudoRandomNumber()

Gets the Pseudo Random Number (PRN).

setPseudoRandomNumber

public final void setPseudoRandomNumber(int value)

Sets the Pseudo Random Number (PRN).

getZerothOrderClockCorrection

public final double getZerothOrderClockCorrection()

Gets the zeroth order clock correction.

setZerothOrderClockCorrection

public final void setZerothOrderClockCorrection(double value)

Sets the zeroth order clock correction.

getFirstOrderClockCorrection

public final double getFirstOrderClockCorrection()

Gets the first order clock correction.

setFirstOrderClockCorrection

public final void setFirstOrderClockCorrection(double value)

Sets the first order clock correction.

getInclinationAngle

public final double getInclinationAngle()

Gets the inclination angle. Units: rad

Specified by:

getInclinationAngle in interface IGpsElements

setInclinationAngle

public final void setInclinationAngle(double value)

Sets the inclination angle. Units: rad

getMeanAnomaly

public final double getMeanAnomaly()

Gets the mean anomaly. Units: rad

Specified by:

getMeanAnomaly in interface IGpsElements

setMeanAnomaly

public final void setMeanAnomaly(double value)

Sets the mean anomaly. Units: rad

getArgumentOfPerigee

public final double getArgumentOfPerigee()

Gets the argument of perigee. Units: rad

Specified by:

getArgumentOfPerigee in interface IGpsElements

setArgumentOfPerigee

public final void setArgumentOfPerigee(double value)

Sets the argument of perigee. Units: rad

getRateOfRightAscension

public final double getRateOfRightAscension()

Gets the rate of right ascension. Units: rad / s

Specified by:

getRateOfRightAscension in interface IGpsElements

setRateOfRightAscension

public final void setRateOfRightAscension(double value)

Sets the rate of right ascension. Units: rad / s

getLongitudeOfAscendingNode

public final double getLongitudeOfAscendingNode()

Gets the longitude of ascending node of orbit plane at weekly epoch. Units: rad

Specified by:

getLongitudeOfAscendingNode in interface IGpsElements

setLongitudeOfAscendingNode

public final void setLongitudeOfAscendingNode(double value)

Sets the longitude of ascending node of orbit plane at weekly epoch. Units: rad

getHealth

public final int getHealth()

Gets the satellite health code.

setHealth

public final void setHealth(int value)

Sets the satellite health code.

createSatellite

@Nonnull
public final Platform createSatellite()

Creates a GPS satellite for this YUMA almanac record.

Returns:

The satellite created from this record.

getCosineCorrectionToArgumentOfLatitude

public final double getCosineCorrectionToArgumentOfLatitude()

Gets the amplitude of the cosine harmonic correction term to the Argument of Latitude. Units: rad

This property always returns 0.0 because Yuma almanacs do not include this information.

Specified by:

getCosineCorrectionToArgumentOfLatitude in interface IGpsElements

getCosineCorrectionToInclination

public final double getCosineCorrectionToInclination()

Gets the amplitude of the cosine harmonic correction term to the angle of inclination. Units: rad

This property always returns 0.0 because Yuma almanacs do not include this information.

Specified by:

getCosineCorrectionToInclination in interface IGpsElements

getCosineCorrectionToOrbitRadius

public final double getCosineCorrectionToOrbitRadius()

Gets the amplitude of the sine harmonic correction term to the orbit radius. Units: m

This property always returns 0.0 because Yuma almanacs do not include this information.

Specified by:

getCosineCorrectionToOrbitRadius in interface IGpsElements

getEccentricity

public final double getEccentricity()

Gets eccentricity. Units: unitless

Specified by:

getEccentricity in interface IGpsElements

setEccentricity

public final void setEccentricity(double value)

Sets eccentricity. Units: unitless

getIssueOfData

public final double getIssueOfData()

Gets the issue of data ephemeris (IODE).

This property always returns 0 because Yuma almanacs do not include this information.

Specified by:

getIssueOfData in interface IGpsElements

getMeanMotionDifference

public final double getMeanMotionDifference()

Gets the mean motion difference from computed value. Units: rad / s

This property always returns 0.0 because Yuma almanacs do not include this information.

Specified by:

getMeanMotionDifference in interface IGpsElements

getRateOfInclinationAngle

public final double getRateOfInclinationAngle()

Gets the rate of inclination angle (IDOT). Units: rad / s

This property always returns 0.0 because Yuma almanacs do not include this information.

Specified by:

getRateOfInclinationAngle in interface IGpsElements

getSineCorrectionToArgumentOfLatitude

public final double getSineCorrectionToArgumentOfLatitude()

Gets the amplitude of the sine harmonic correction term to the Argument of Latitude. Units: rad

This property always returns 0.0 because Yuma almanacs do not include this information.

Specified by:

getSineCorrectionToArgumentOfLatitude in interface IGpsElements

getSineCorrectionToInclination

public final double getSineCorrectionToInclination()

Gets the amplitude of the sine harmonic correction term to the angle of inclination. Units: rad

This property always returns 0.0 because Yuma almanacs do not include this information.

Specified by:

getSineCorrectionToInclination in interface IGpsElements

getSineCorrectionToOrbitRadius

public final double getSineCorrectionToOrbitRadius()

Gets the amplitude of the sine harmonic correction term to the orbit radius. Units: m

This property always returns 0.0 because Yuma almanacs do not include this information.

Specified by:

getSineCorrectionToOrbitRadius in interface IGpsElements

getSquareRootOfSemimajorAxis

public final double getSquareRootOfSemimajorAxis()

Gets the square root of the semi-major axis (sqrt(meters)). Units: sqrt(m)

Specified by:

getSquareRootOfSemimajorAxis in interface IGpsElements

setSquareRootOfSemimajorAxis

public final void setSquareRootOfSemimajorAxis(double value)

Sets the square root of the semi-major axis (sqrt(meters)). Units: sqrt(m)