agi.foundation.navigation.datareaders

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

Class YumaAlmanac

java.lang.Object

agi.foundation.compatibility.BaseCollection<YumaAlmanacRecord>

agi.foundation.navigation.datareaders.YumaAlmanac

All Implemented Interfaces:

Iterable<YumaAlmanacRecord>, Collection<YumaAlmanacRecord>, List<YumaAlmanacRecord>

public final class YumaAlmanac
extends BaseCollection<YumaAlmanacRecord>

A Yuma almanac describing GPS satellite positions.

Constructor Summary

Constructors

Constructor and Description
YumaAlmanac() Initializes a new instance containing no data.

Method Summary

Modifier and Type	Method and Description
PlatformCollection	createSatelliteCollection() Creates a GPS satellite for each record in the Yuma almanac.
YumaAlmanacRecord	findRecordByPrn(int prn) Finds the record corresponding to a particular PRN.
GlobalPositioningSystemDate	getEpoch() Gets the epoch of the almanac, which is the time at which the almanac curve fit was performed.
int	getNumberOfSatellites() Gets the number of satellites in the almanac.
static YumaAlmanac	readFrom(BufferedReader reader, int rolloverCount) Reads a Yuma almanac from the specified reader.
static YumaAlmanac	readFrom(String fileName, int rolloverCount) Reads a Yuma almanac 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

Constructor Detail

YumaAlmanac

public YumaAlmanac()

Initializes a new instance containing no data. Use YumaAlmanac.readFrom(String,int) to read data from a Yuma almanac file.

Method Detail

readFrom

@Nonnull
public static YumaAlmanac readFrom(@Nonnull
                                             String fileName,
                                             int rolloverCount)

Reads a Yuma almanac from the specified file.

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:

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

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

Returns:

The almanac read from the stream.

Throws:

ArgumentNullException - Thrown when fileName is null.

readFrom

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

Reads a Yuma almanac from the specified 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 from which to read the almanac.

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

Returns:

The almanac read from the stream.

Throws:

ArgumentNullException - Thrown when reader is null.

findRecordByPrn

@Nullable
public final YumaAlmanacRecord 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.

getNumberOfSatellites

public final int getNumberOfSatellites()

Gets the number of satellites in the almanac.

getEpoch

@Nonnull
public final GlobalPositioningSystemDate getEpoch()

Gets the epoch of the almanac, which is the time at which the almanac curve fit was performed. The epoch reported is from the first satellite entry in the Yuma almanac.

createSatelliteCollection

@Nonnull
public final PlatformCollection createSatelliteCollection()

Creates a GPS satellite for each record in the Yuma almanac.

Returns:

The collection of GPS satellites. There is a GpsSatelliteExtension instance for each record in the Yuma almanac, and they are found in the same order.