agi.foundation.navigation.advanced

(agi.foundation.navigation.advanced-2023r1.jar)

Class GpsCommunicationsConstellation

java.lang.Object

agi.foundation.navigation.advanced.GpsCommunicationsConstellation

public final class GpsCommunicationsConstellation
extends Object

Provides methods that create a constellation of GPS satellites with transmitters and antennas for use with a GpsCommunicationsFrontEnd.

Method Summary

Modifier and Type	Method and Description
static PlatformCollection	create(SemAlmanac almanac, ArrayList<GpsSatelliteInformation> gpsSatelliteInfo) Create a GPS communications constellation from an almanac and a set of GPS constellation information.
static PlatformCollection	create(SemAlmanac almanac, String gpsDataFile) Create a GPS communications constellation from an almanac and a set of GPS constellation information.
static PlatformCollection	create(String semAlmanacFile, int rolloverCount, String gpsDataFile) Creates a GPS constellation that includes navigation signal transmitters specific to each satellite block type.
static PlatformCollection	download() Create a GPS communications constellation by downloading the latest data from an AGI server.
static PlatformCollection	download(Proxy proxy) Create a GPS communications constellation by downloading the latest data from an AGI server.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Nonnull
public static PlatformCollection create(@Nonnull
                                                  String semAlmanacFile,
                                                  int rolloverCount,
                                                  @Nonnull
                                                  String gpsDataFile)

Creates a GPS constellation that includes navigation signal transmitters specific to each satellite block type. Each platform will provide the following services: IGpsPrnService, IGpsSatelliteInformationService, ILocationPointService, IOrientationAxesService, and INavigationTransmitterService.

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).

Note that the latest GPSData.txt file should be used and can be downloaded from: https://ftp.agi.com/pub/Catalog/Almanacs/SEM/GPSData.txt.

Parameters:

semAlmanacFile - The location of the almanac file to use for GPS satellite positions.

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

gpsDataFile - The location of the GPSData.txt file to use that defines the GPS block and PRN information.

Returns:

A PlatformCollection representing GPS satellites and their transmitters.

Throws:

ArgumentNullException - Thrown when semAlmanacFile or gpsDataFile is null.

create

@Nonnull
public static PlatformCollection create(@Nonnull
                                                  SemAlmanac almanac,
                                                  @Nonnull
                                                  String gpsDataFile)

Create a GPS communications constellation from an almanac and a set of GPS constellation information. Each platform will provide the following services: IGpsPrnService, IGpsSatelliteInformationService, ILocationPointService, IOrientationAxesService, and INavigationTransmitterService.

Note that the latest GPSData.txt file should be used and can be downloaded from: https://ftp.agi.com/pub/Catalog/Almanacs/SEM/GPSData.txt.

Parameters:

almanac - The almanac used to describe the GPS constellation.

gpsDataFile - The location of the GPSData.txt file to use that defines the blocks and PRN information.

Returns:

A PlatformCollection representing GPS satellites and their transmitters.

Throws:

ArgumentNullException - Thrown when almanac or gpsDataFile is null.

create

@Nonnull
public static PlatformCollection create(@Nonnull
                                                  SemAlmanac almanac,
                                                  @Nonnull
                                                  ArrayList<GpsSatelliteInformation> gpsSatelliteInfo)

Create a GPS communications constellation from an almanac and a set of GPS constellation information. Each platform will provide the following services: IGpsPrnService, IGpsSatelliteInformationService, ILocationPointService, IOrientationAxesService, and INavigationTransmitterService.

GpsDataFile contains helper methods to load GPS satellite information from a file, or download data from an AGI server.

Parameters:

almanac - The almanac used to describe the GPS constellation.

gpsSatelliteInfo - A list of GpsSatelliteInformation objects containing information about the GPS constellation.

Returns:

A PlatformCollection representing GPS satellites and their transmitters.

Throws:

ArgumentNullException - Thrown when almanac or gpsSatelliteInfo is null.

download

@Nonnull
public static PlatformCollection download()

Create a GPS communications constellation by downloading the latest data from an AGI server. This method connects via HTTPS to ftp.agi.com. Each platform will provide the following services: IGpsPrnService, IGpsSatelliteInformationService, ILocationPointService, IOrientationAxesService, and INavigationTransmitterService.

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

Returns:

A PlatformCollection representing GPS satellites and their transmitters.

Throws:

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

download

@Nonnull
public static PlatformCollection download(@Nullable
                                                    Proxy proxy)

Create a GPS communications constellation by downloading the latest data from an AGI server. This method connects via HTTPS to ftp.agi.com. Each platform will provide the following services: IGpsPrnService, IGpsSatelliteInformationService, ILocationPointService, IOrientationAxesService, and INavigationTransmitterService.

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

Parameters:

proxy - Proxy to use when connecting.

Returns:

A PlatformCollection representing GPS satellites and their transmitters.

Throws:

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