agi.foundation.navigation.datareaders

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

Class SatelliteOutageFile

java.lang.Object

agi.foundation.compatibility.BaseCollection<SatelliteOutage>

agi.foundation.navigation.datareaders.SatelliteOutageFile

All Implemented Interfaces:

Iterable<SatelliteOutage>, Collection<SatelliteOutage>, List<SatelliteOutage>

public class SatelliteOutageFile
extends BaseCollection<SatelliteOutage>

A Satellite Outage File (SOF) that describes the periods of time when the various GPS satellites were or are expected to be unavailable.

Constructor Summary

Constructors

Constructor and Description
SatelliteOutageFile() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
static String	downloadLatestRawSatelliteOutageFile() Downloads the latest Satellite Outage File from an AGI server and returns the contents of the file as a string.
static String	downloadLatestRawSatelliteOutageFile(Proxy proxy) Downloads the latest Satellite Outage File from an AGI server and returns the contents of the file as a string.
static SatelliteOutageFile	downloadLatestSatelliteOutageFile() Downloads the latest Satellite Outage File from an AGI server and returns the contents of the file as a SatelliteOutageFile.
static SatelliteOutageFile	downloadLatestSatelliteOutageFile(Proxy proxy) Downloads the latest Satellite Outage File from an AGI server and returns the contents of the file as a SatelliteOutageFile.
SatelliteOutageCollection	findOutages(int prn) Finds all satellite outages for a given Pseudo Random Number.
SatelliteOutageCollection	findOutages(int prn, TimeInterval date) Finds satellite outages with a given Pseudo Random Number and within a specified TimeInterval.
SatelliteOutageCollection	findOutages(TimeInterval date) Finds all outages within a given TimeInterval.
ZonedDateTime	getCreationDate() Gets the creation date of the SOF file.
JulianDate	getCreationJulianDate() Gets the creation date of the SOF file expressed as a JulianDate.
String	getFileId() Gets the FILEID of the SOF file.
ZonedDateTime	getReferenceDate() Gets the reference date of the SOF file.
JulianDate	getReferenceJulianDate() Gets the reference date of the SOF file expressed as a JulianDate.
String	getSystemId() Gets the SYSID of the SOF file.
void	populateConstellationOutageData(PlatformCollection gpsConstellation) Populates a GPS constellation with the information about satellite outages contained in this outage file.
static SatelliteOutageFile	readFrom(BufferedReader reader) Reads a SatelliteOutageFile from a reader.
static SatelliteOutageFile	readFrom(InputStream stream) Reads a SatelliteOutageFile from a stream.
static SatelliteOutageFile	readFrom(String fileName) Reads a SatelliteOutageFile from a file.
void	setCreationDate(ZonedDateTime value) Sets the creation date of the SOF file.
void	setFileId(String value) Sets the FILEID of the SOF file.
void	setReferenceDate(ZonedDateTime value) Sets the reference date of the SOF file.
void	setSystemId(String value) Sets the SYSID of the SOF 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

SatelliteOutageFile

public SatelliteOutageFile()

Initializes a new instance.

Method Detail

readFrom

@Nonnull
public static SatelliteOutageFile readFrom(@Nonnull
                                                     String fileName)

Reads a SatelliteOutageFile from a file.

Parameters:

fileName - The name of the SatelliteOutageFile from which to read.

Returns:

A SatelliteOutageFile instance containing the data read from the file.

Throws:

ArgumentNullException - Thrown when fileName is null.

readFrom

@Nonnull
public static SatelliteOutageFile readFrom(@Nonnull
                                                     InputStream stream)

Reads a SatelliteOutageFile from a stream.

Parameters:

stream - A stream from which to read the SatelliteOutageFile.

Returns:

A SatelliteOutageFile instance containing the data read from the stream.

Throws:

ArgumentNullException - Thrown when stream is null.

readFrom

@Nonnull
public static SatelliteOutageFile readFrom(@Nonnull
                                                     BufferedReader reader)

Reads a SatelliteOutageFile from a reader.

Parameters:

reader - The reader from which to read the SatelliteOutageFile.

Returns:

A SatelliteOutageFile instance containing the data read from the reader.

Throws:

ArgumentNullException - Thrown when reader is null.

downloadLatestSatelliteOutageFile

@Nonnull
public static SatelliteOutageFile downloadLatestSatelliteOutageFile()

Downloads the latest Satellite Outage File from an AGI server and returns the contents of the file as a SatelliteOutageFile. This method connects via HTTPS to ftp.agi.com.

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

Returns:

A SatelliteOutageFile populated with the data returned from the server.

Throws:

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

downloadLatestSatelliteOutageFile

@Nonnull
public static SatelliteOutageFile downloadLatestSatelliteOutageFile(@Nullable
                                                                              Proxy proxy)

Downloads the latest Satellite Outage File from an AGI server and returns the contents of the file as a SatelliteOutageFile. 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 SatelliteOutageFile populated with the data returned from the server.

Throws:

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

downloadLatestRawSatelliteOutageFile

@Nonnull
public static String downloadLatestRawSatelliteOutageFile()

Downloads the latest Satellite Outage 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 Satellite Outage File returned from the server.

Throws:

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

downloadLatestRawSatelliteOutageFile

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

Downloads the latest Satellite Outage 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 Satellite Outage File returned from the server.

Throws:

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

getFileId

public final String getFileId()

Gets the FILEID of the SOF file.

setFileId

public final void setFileId(String value)

Sets the FILEID of the SOF file.

getSystemId

public final String getSystemId()

Gets the SYSID of the SOF file.

setSystemId

public final void setSystemId(String value)

Sets the SYSID of the SOF file.

getReferenceDate

@Nonnull
public final ZonedDateTime getReferenceDate()

Gets the reference date of the SOF file.

setReferenceDate

public final void setReferenceDate(@Nonnull
                                   ZonedDateTime value)

Sets the reference date of the SOF file.

getReferenceJulianDate

@Nonnull
public final JulianDate getReferenceJulianDate()

Gets the reference date of the SOF file expressed as a JulianDate.

getCreationDate

@Nonnull
public final ZonedDateTime getCreationDate()

Gets the creation date of the SOF file.

setCreationDate

public final void setCreationDate(@Nonnull
                                  ZonedDateTime value)

Sets the creation date of the SOF file.

getCreationJulianDate

@Nonnull
public final JulianDate getCreationJulianDate()

Gets the creation date of the SOF file expressed as a JulianDate.

populateConstellationOutageData

public final void populateConstellationOutageData(@Nonnull
                                                  PlatformCollection gpsConstellation)

Populates a GPS constellation with the information about satellite outages contained in this outage file. Specifically, OutageIntervals (get / set) for each satellite is replaced with all of the outages in this file.

Each platform in the collection must have a GpsSatelliteExtension attached to it. The PseudoRandomNumber (get / set) property of the extension is used to determine which outage information to associate with which Platform.

Parameters:

gpsConstellation - The GPS constellation to populate.

Throws:

ArgumentException - Thrown when one or more of the platforms in the gpsConstellation does not have a pseudo-random number (PRN) associated with it.

findOutages

@Nonnull
public final SatelliteOutageCollection findOutages(int prn)

Finds all satellite outages for a given Pseudo Random Number.

Parameters:

prn - The Pseudo Random Number (PRN) of the navigation satellite.

Returns:

SatelliteOutageCollection containing the outages for this PRN.

findOutages

@Nonnull
public final SatelliteOutageCollection findOutages(TimeInterval date)

Finds all outages within a given TimeInterval.

Parameters:

date - The TimeInterval to consider when looking for outages.

Returns:

SatelliteOutageCollection containing the outages for this TimeInterval.

findOutages

@Nonnull
public final SatelliteOutageCollection findOutages(int prn,
                                                             TimeInterval date)

Finds satellite outages with a given Pseudo Random Number and within a specified TimeInterval.

Parameters:

prn - The Pseudo Random Number (PRN) of the navigation satellite.

date - The TimeInterval to consider when looking for outages.

Returns:

SatelliteOutageCollection containing the outages for this PRN, during the specified time.