agi.foundation.navigation.datareaders

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

Class GpsDataFile

java.lang.Object

agi.foundation.navigation.datareaders.GpsDataFile

public final class GpsDataFile
extends Object

Reads data from the GPSData.txt file hosted by AGI. This file contains the history of each PRN, which type of satellite has had that PRN and their active dates, block types, etc.

The GPSData.txt file is available from: https://ftp.agi.com/pub/Catalog/Almanacs/SEM/GPSData.txt. This file is updated daily.

Method Summary

Modifier and Type	Method and Description
static ArrayList<GpsSatelliteInformation>	downloadActive() Downloads and reads data for only the active GPS satellites from an AGI server.
static ArrayList<GpsSatelliteInformation>	downloadActive(Proxy proxy) Downloads and reads data for only the active GPS satellites from an AGI server.
static ArrayList<GpsSatelliteInformation>	downloadAll() Downloads and reads data for all GPS satellites from an AGI server.
static ArrayList<GpsSatelliteInformation>	downloadAll(Proxy proxy) Downloads and reads data for all GPS satellites from an AGI server.
static String	downloadRawFile() Downloads the GPS data file from an AGI server and returns the contents of the file as a string.
static String	downloadRawFile(Proxy proxy) Downloads the GPS data file from an AGI server and returns the contents of the file as a string.
static ArrayList<GpsSatelliteInformation>	readActive(BufferedReader source) Reads data for only the active GPS satellites from the specified reader.
static ArrayList<GpsSatelliteInformation>	readActive(String fileName) Reads data for only the active GPS satellites from the specified file.
static ArrayList<GpsSatelliteInformation>	readAll(BufferedReader source) Reads data for all GPS satellites from the specified reader.
static ArrayList<GpsSatelliteInformation>	readAll(String fileName) Reads data for all GPS satellites from the specified file.

Methods inherited from class java.lang.Object

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

Method Detail

readActive

@Nonnull
public static ArrayList<GpsSatelliteInformation> readActive(@Nonnull
                                                                      String fileName)

Reads data for only the active GPS satellites from the specified file.

Parameters:

fileName - Location of GPSData.txt file.

Returns:

A list of GpsSatelliteInformation for only the active satellites in the file.

Throws:

ArgumentNullException - Thrown when fileName is null.

readActive

@Nonnull
public static ArrayList<GpsSatelliteInformation> readActive(@Nonnull
                                                                      BufferedReader source)

Reads data for only the active GPS satellites from the specified reader.

Parameters:

source - The reader from which to read.

Returns:

A list of GpsSatelliteInformation for only active satellites in the file.

Throws:

ArgumentNullException - Thrown when source is null.

readAll

@Nonnull
public static ArrayList<GpsSatelliteInformation> readAll(@Nonnull
                                                                   String fileName)

Reads data for all GPS satellites from the specified file.

Parameters:

fileName - File location of GPSData.txt

Returns:

A list of GpsSatelliteInformation for all satellites in the file.

Throws:

ArgumentNullException - Thrown when fileName is null.

readAll

@Nonnull
public static ArrayList<GpsSatelliteInformation> readAll(@Nonnull
                                                                   BufferedReader source)

Reads data for all GPS satellites from the specified reader.

Parameters:

source - The reader from which to read.

Returns:

A list of GpsSatelliteInformation for all satellites in the file.

Throws:

ArgumentNullException - Thrown when source is null.

downloadAll

@Nonnull
public static ArrayList<GpsSatelliteInformation> downloadAll()

Downloads and reads data for all GPS satellites 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 list of GpsSatelliteInformation for all satellites in the file.

Throws:

InvalidDataException - Thrown when there is an error parsing data from the file.

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

downloadAll

@Nonnull
public static ArrayList<GpsSatelliteInformation> downloadAll(@Nullable
                                                                       Proxy proxy)

Downloads and reads data for all GPS satellites 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 list of GpsSatelliteInformation for all satellites in the file.

Throws:

InvalidDataException - Thrown when there is an error parsing data from the file.

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

downloadActive

@Nonnull
public static ArrayList<GpsSatelliteInformation> downloadActive()

Downloads and reads data for only the active GPS satellites 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 list of GpsSatelliteInformation for only the active satellites in the file.

Throws:

InvalidDataException - Thrown when there is an error parsing data from the file.

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

downloadActive

@Nonnull
public static ArrayList<GpsSatelliteInformation> downloadActive(@Nullable
                                                                          Proxy proxy)

Downloads and reads data for only the active GPS satellites 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 list of GpsSatelliteInformation for only the active satellites in the file.

Throws:

InvalidDataException - Thrown when there is an error parsing data from the file.

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

downloadRawFile

@Nonnull
public static String downloadRawFile()

Downloads the GPS data file 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 containing the contents of the GPS data file returned from the server.

Throws:

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

downloadRawFile

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

Downloads the GPS data file 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 containing the contents of the GPS data file returned from the server.

Throws:

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