agi.foundation.navigation.datareaders

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

Class SemAlmanac

java.lang.Object

agi.foundation.compatibility.BaseCollection<SemAlmanacRecord>

agi.foundation.navigation.datareaders.SemAlmanac

All Implemented Interfaces:

Iterable<SemAlmanacRecord>, Collection<SemAlmanacRecord>, List<SemAlmanacRecord>

public final class SemAlmanac
extends BaseCollection<SemAlmanacRecord>

A SEM almanac describing GPS satellites.

Constructor Summary

Constructors

Constructor and Description
SemAlmanac() 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 SEM almanac.
static SemAlmanac	downloadAlmanac(JulianDate dateOfAlmanac) Downloads the SEM Almanac which was most recently published before the given date from an AGI server and returns the contents of the file as a SemAlmanac.
static SemAlmanac	downloadAlmanac(JulianDate dateOfAlmanac, Proxy proxy) Downloads the SEM Almanac which was most recently published before the given date from an AGI server and returns the contents of the file as a SemAlmanac.
static SemAlmanac	downloadLatestAlmanac() Downloads the latest almanac from an AGI server.
static SemAlmanac	downloadLatestAlmanac(Proxy proxy) Downloads the latest almanac from an AGI server.
static String	downloadLatestRawAlmanac() Downloads the SEM Almanac from an AGI server and returns the contents of the file as a string.
static String	downloadLatestRawAlmanac(Proxy proxy) Downloads the SEM Almanac from an AGI server and returns the contents of the file as a string.
static String	downloadRawAlmanac(JulianDate dateOfAlmanac) Downloads the SEM Almanac which was most recently published before the given date from an AGI server and returns the contents of the file as a string.
static String	downloadRawAlmanac(JulianDate dateOfAlmanac, Proxy proxy) Downloads the SEM Almanac which was most recently published before the given date from an AGI server and returns the contents of the file as a string.
SemAlmanacRecord	findRecordByPrn(int prn) Finds the record corresponding to a particular PRN.
String	getAlmanacName() Gets the name of the almanac as defined in the almanac file.
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 SVs in the almanac.
static SemAlmanac	readFrom(BufferedReader reader, int rolloverCount) Reads a SEM almanac from the specified reader.
static SemAlmanac	readFrom(String fileName, int rolloverCount) Reads a SEM 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

SemAlmanac

public SemAlmanac()

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

Method Detail

readFrom

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

Reads a SEM 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 file.

Throws:

ArgumentNullException - Thrown when fileName is null.

InvalidDataException - Thrown when the SEM almanac data has an invalid format.

readFrom

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

Reads a SEM 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.

InvalidDataException - Thrown when the SEM almanac data has an invalid format.

downloadLatestAlmanac

@Nonnull
public static SemAlmanac downloadLatestAlmanac()

Downloads the latest almanac from an AGI server. This method connects via HTTPS to ftp.agi.com.

Note that an internet connection is required to use this method successfully.

Returns:

A SemAlmanac that contains data from the latest almanac.

Throws:

DataUnavailableException - Thrown when the data cannot be retrieved from the server.

downloadLatestAlmanac

@Nonnull
public static SemAlmanac downloadLatestAlmanac(@Nullable
                                                         Proxy proxy)

Downloads the latest almanac from an AGI server. This method connects via HTTPS to ftp.agi.com.

Note that an internet connection is required to use this method successfully.

Parameters:

proxy - Proxy to use when connecting.

Returns:

A SemAlmanac that contains data from the latest almanac.

Throws:

DataUnavailableException - Thrown when the data cannot be retrieved from the server.

downloadLatestRawAlmanac

@Nonnull
public static String downloadLatestRawAlmanac()

Downloads the SEM Almanac from an AGI server and returns the contents of the file as a string. This method connects via HTTPS to ftp.agi.com.

Note that an internet connection is required to use this method successfully.

Returns:

A string that contains data from the latest almanac.

Throws:

DataUnavailableException - Thrown when the data cannot be retrieved from the server.

downloadLatestRawAlmanac

@Nonnull
public static String downloadLatestRawAlmanac(@Nullable
                                                        Proxy proxy)

Downloads the SEM Almanac from an AGI server and returns the contents of the file as a string. This method connects via HTTPS to ftp.agi.com.

Note that an internet connection is required to use this method successfully.

Parameters:

proxy - Proxy to use when connecting.

Returns:

A string that contains data from the latest almanac.

Throws:

DataUnavailableException - Thrown when the data cannot be retrieved from the server.

downloadAlmanac

@Nonnull
public static SemAlmanac downloadAlmanac(@Nonnull
                                                   JulianDate dateOfAlmanac)

Downloads the SEM Almanac which was most recently published before the given date from an AGI server and returns the contents of the file as a SemAlmanac. This method connects via HTTPS to ftp.agi.com.

Note that an internet connection is required to use this method successfully.

Parameters:

dateOfAlmanac - The date for which the almanac is needed.

Returns:

A SemAlmanac that contains data from the almanac most recently published before dateOfAlmanac.

Throws:

DataUnavailableException - Thrown when the data cannot be retrieved from the server.

downloadAlmanac

@Nonnull
public static SemAlmanac downloadAlmanac(@Nonnull
                                                   JulianDate dateOfAlmanac,
                                                   @Nullable
                                                   Proxy proxy)

Downloads the SEM Almanac which was most recently published before the given date from an AGI server and returns the contents of the file as a SemAlmanac. This method connects via HTTPS to ftp.agi.com.

Note that an internet connection is required to use this method successfully.

Parameters:

dateOfAlmanac - The date for which the almanac is needed.

proxy - Proxy to use when connecting.

Returns:

A SemAlmanac that contains data from the almanac most recently published before dateOfAlmanac.

Throws:

DataUnavailableException - Thrown when the data cannot be retrieved from the server.

downloadRawAlmanac

@Nonnull
public static String downloadRawAlmanac(@Nonnull
                                                  JulianDate dateOfAlmanac)

Downloads the SEM Almanac which was most recently published before the given date from an AGI server and returns the contents of the file as a string. This method connects via HTTPS to ftp.agi.com.

Note that an internet connection is required to use this method successfully.

Parameters:

dateOfAlmanac - The date for which the almanac is needed.

Returns:

A string that contains data from the almanac most recently published before dateOfAlmanac.

Throws:

DataUnavailableException - Thrown when the data cannot be retrieved from the server.

downloadRawAlmanac

@Nonnull
public static String downloadRawAlmanac(@Nonnull
                                                  JulianDate dateOfAlmanac,
                                                  @Nullable
                                                  Proxy proxy)

Downloads the SEM Almanac which was most recently published before the given date from an AGI server and returns the contents of the file as a string. This method connects via HTTPS to ftp.agi.com.

Note that an internet connection is required to use this method successfully.

Parameters:

dateOfAlmanac - The date for which the almanac is needed.

proxy - Proxy to use when connecting.

Returns:

A string that contains data from the almanac most recently published before dateOfAlmanac.

Throws:

DataUnavailableException - Thrown when the data cannot be retrieved from the server.

findRecordByPrn

@Nullable
public final SemAlmanacRecord 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 SVs in the almanac.

getAlmanacName

public final String getAlmanacName()

Gets the name of the almanac as defined in the almanac file.

getEpoch

@Nonnull
public final GlobalPositioningSystemDate getEpoch()

Gets the epoch of the almanac, which is the time at which the almanac curve fit was performed.

createSatelliteCollection

@Nonnull
public final PlatformCollection createSatelliteCollection()

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

Returns:

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