agi.foundation.navigation.datareaders

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

Class PerformanceAssessmentFile

java.lang.Object

agi.foundation.compatibility.BaseCollection<PerformanceAssessmentRecord>

agi.foundation.navigation.datareaders.PerformanceAssessmentFile

All Implemented Interfaces:

IFreezable, Iterable<PerformanceAssessmentRecord>, Collection<PerformanceAssessmentRecord>, List<PerformanceAssessmentRecord>

public class PerformanceAssessmentFile
extends BaseCollection<PerformanceAssessmentRecord>
implements IFreezable

A Performance Assessment File (PAF) containing ephemeris and clock errors for the GPS satellites over a period of time.

Constructor Summary

Constructors

Constructor and Description
PerformanceAssessmentFile() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	clearItems() Removes all elements from the BaseCollection.
static PerformanceAssessmentFile	downloadPerformanceAssessmentFile(JulianDate dateOfPaf) Downloads the Performance Assessment File from an AGI server and returns the contents of the file as a PerformanceAssessmentFile.
static PerformanceAssessmentFile	downloadPerformanceAssessmentFile(JulianDate dateOfPaf, Proxy proxy) Downloads the Performance Assessment File from an AGI server and returns the contents of the file as a PerformanceAssessmentFile.
static String	downloadRawPerformanceAssessmentFile(JulianDate dateOfPaf) Downloads the Performance Assessment File from an AGI server and returns the contents of the file as a string.
static String	downloadRawPerformanceAssessmentFile(JulianDate dateOfPaf, Proxy proxy) Downloads the Performance Assessment File from an AGI server and returns the contents of the file as a string.
void	freeze() Freezes this object.
ZonedDateTime	getCreationDate() Gets the date the PAF file was created.
JulianDate	getCreationJulianDate() Gets the date the PAF file was created, represented as a JulianDate.
boolean	getDefaultAllowExtrapolation() Gets a value indicating whether the evaluator created by this instance is allowed, by default, to extrapolate assessed performance before the first record or after the last one.
Duration	getDefaultAvailabilityThreshold() Gets the default availability threshold used when evaluating assessed performance.
Evaluator<PerformanceAssessmentField>	getEvaluator(int prn) Gets an evaluator that can be used to find assessed performance data over time for a given GPS satellite.
Evaluator<PerformanceAssessmentField>	getEvaluator(int prn, Duration availabilityThreshold, boolean allowExtrapolation, EvaluatorGroup group) Gets an evaluator that can be used to find assessed performance data over time for a given GPS satellite.
Evaluator<PerformanceAssessmentField>	getEvaluator(int prn, EvaluatorGroup group) Gets an evaluator that can be used to find assessed performance data over time for a given GPS satellite.
String	getFileId() Gets the FILEID of the PAF file.
boolean	getIsFrozen() Gets a value indicating whether this object is frozen.
ZonedDateTime	getReferenceDate() Gets the date the PAF file is referenced to.
JulianDate	getReferenceJulianDate() Gets the date the PAF file is referenced to.
Evaluator<SatelliteGlobalUserRangeError>	getSatelliteGlobalUserRangeErrorEvaluator(IServiceProvider satellite) Returns an evaluator which can compute the SatelliteGlobalUserRangeError for this Performance Assessment File at a given time.
Evaluator<SatelliteGlobalUserRangeError>	getSatelliteGlobalUserRangeErrorEvaluator(IServiceProvider satellite, EvaluatorGroup group) Returns an evaluator which can compute the SatelliteGlobalUserRangeError for this Performance Assessment File at a given time.
String	getSource() Gets the source of the PAF file.
String	getSystemId() Gets the SYSID of the PAF file.
int	getVersion() Gets the version of the PAF file
protected void	insertItem(int index, PerformanceAssessmentRecord item) Inserts an element into the BaseCollection at the specified index.
static PerformanceAssessmentFile	readFrom(BufferedReader reader) Reads a PerformanceAssessmentFile from a reader.
static PerformanceAssessmentFile	readFrom(InputStream stream) Reads a PerformanceAssessmentFile from a stream.
static PerformanceAssessmentFile	readFrom(String fileName) Reads a PerformanceAssessmentFile from a file.
protected void	removeItem(int index) Removes the element at the specified index of the BaseCollection.
void	setCreationDate(ZonedDateTime value) Sets the date the PAF file was created.
void	setDefaultAllowExtrapolation(boolean value) Sets a value indicating whether the evaluator created by this instance is allowed, by default, to extrapolate assessed performance before the first record or after the last one.
void	setDefaultAvailabilityThreshold(Duration value) Sets the default availability threshold used when evaluating assessed performance.
void	setFileId(String value) Sets the FILEID of the PAF file.
protected void	setItem(int index, PerformanceAssessmentRecord item) Replaces the element at the specified index.
void	setReferenceDate(ZonedDateTime value) Sets the date the PAF file is referenced to.
void	setSource(String value) Sets the source of the PAF file.
void	setSystemId(String value) Sets the SYSID of the PAF file.
void	setVersion(int value) Sets the version of the PAF file

Methods inherited from class agi.foundation.compatibility.BaseCollection

add, add, addAll, addAll, clear, contains, containsAll, get, getItems, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, 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

PerformanceAssessmentFile

public PerformanceAssessmentFile()

Initializes a new instance.

Method Detail

freeze

public final void freeze()

Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.

Specified by:

freeze in interface IFreezable

getIsFrozen

public final boolean getIsFrozen()

Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so.

Specified by:

getIsFrozen in interface IFreezable

readFrom

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

Reads a PerformanceAssessmentFile from a file.

Parameters:

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

Returns:

A PerformanceAssessmentFile instance containing the data read from the file.

Throws:

ArgumentNullException - Thrown when fileName is null.

readFrom

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

Reads a PerformanceAssessmentFile from a stream.

Parameters:

stream - A stream from which to read the PerformanceAssessmentFile.

Returns:

A PerformanceAssessmentFile instance containing the data read from the stream.

Throws:

ArgumentNullException - Thrown when stream is null.

readFrom

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

Reads a PerformanceAssessmentFile from a reader.

Parameters:

reader - The reader from which to read the PerformanceAssessmentFile.

Returns:

A PerformanceAssessmentFile instance containing the data read from the reader.

Throws:

ArgumentNullException - Thrown when reader is null.

downloadPerformanceAssessmentFile

@Nonnull
public static PerformanceAssessmentFile downloadPerformanceAssessmentFile(@Nonnull
                                                                                    JulianDate dateOfPaf)

Downloads the Performance Assessment File from an AGI server and returns the contents of the file as a PerformanceAssessmentFile. This method connects via HTTPS to ftp.agi.com.

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

Parameters:

dateOfPaf - Date for which the PerformanceAssessmentFile is needed.

Returns:

A PerformanceAssessmentFile populated with the data returned from the server.

Throws:

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

downloadPerformanceAssessmentFile

@Nonnull
public static PerformanceAssessmentFile downloadPerformanceAssessmentFile(@Nonnull
                                                                                    JulianDate dateOfPaf,
                                                                                    @Nullable
                                                                                    Proxy proxy)

Downloads the Performance Assessment File from an AGI server and returns the contents of the file as a PerformanceAssessmentFile. This method connects via HTTPS to ftp.agi.com.

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

Parameters:

dateOfPaf - Date for which the PerformanceAssessmentFile is needed.

proxy - Proxy to use when connecting.

Returns:

A PerformanceAssessmentFile populated with the data returned from the server.

Throws:

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

downloadRawPerformanceAssessmentFile

@Nonnull
public static String downloadRawPerformanceAssessmentFile(@Nonnull
                                                                    JulianDate dateOfPaf)

Downloads the Performance Assessment 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:

dateOfPaf - Date for which the PerformanceAssessmentFile is needed.

Returns:

A string containing the contents of the Performance Assessment File returned from the server.

Throws:

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

downloadRawPerformanceAssessmentFile

@Nonnull
public static String downloadRawPerformanceAssessmentFile(@Nonnull
                                                                    JulianDate dateOfPaf,
                                                                    @Nullable
                                                                    Proxy proxy)

Downloads the Performance Assessment 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:

dateOfPaf - Date for which the PerformanceAssessmentFile is needed.

proxy - Proxy to use when connecting.

Returns:

A string containing the contents of the Performance Assessment File returned from the server.

Throws:

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

getCreationDate

@Nonnull
public final ZonedDateTime getCreationDate()

Gets the date the PAF file was created.

setCreationDate

public final void setCreationDate(@Nonnull
                                  ZonedDateTime value)

Sets the date the PAF file was created.

getCreationJulianDate

@Nonnull
public final JulianDate getCreationJulianDate()

Gets the date the PAF file was created, represented as a JulianDate.

getReferenceDate

@Nonnull
public final ZonedDateTime getReferenceDate()

Gets the date the PAF file is referenced to. This is typically the last time in the file for which records are present.

setReferenceDate

public final void setReferenceDate(@Nonnull
                                   ZonedDateTime value)

Sets the date the PAF file is referenced to. This is typically the last time in the file for which records are present.

getReferenceJulianDate

@Nonnull
public final JulianDate getReferenceJulianDate()

Gets the date the PAF file is referenced to. This is typically the last time in the file for which records are present.

getFileId

public final String getFileId()

Gets the FILEID of the PAF file. Usually "PAF".

setFileId

public final void setFileId(String value)

Sets the FILEID of the PAF file. Usually "PAF".

getSystemId

public final String getSystemId()

Gets the SYSID of the PAF file. Usually the navigation constellation that generated the error data (GPS, GLONASS, etc.)

setSystemId

public final void setSystemId(String value)

Sets the SYSID of the PAF file. Usually the navigation constellation that generated the error data (GPS, GLONASS, etc.)

getSource

public final String getSource()

Gets the source of the PAF file. Typically the organization that generated the PAF data.

setSource

public final void setSource(String value)

Sets the source of the PAF file. Typically the organization that generated the PAF data.

getVersion

public final int getVersion()

Gets the version of the PAF file

setVersion

public final void setVersion(int value)

Sets the version of the PAF file

getDefaultAvailabilityThreshold

@Nonnull
public final Duration getDefaultAvailabilityThreshold()

Gets the default availability threshold used when evaluating assessed performance. If two records in the file are separated by a duration longer than this availability threshold, the evaluator will report that it is not available between the two records.

setDefaultAvailabilityThreshold

public final void setDefaultAvailabilityThreshold(@Nonnull
                                                  Duration value)

Sets the default availability threshold used when evaluating assessed performance. If two records in the file are separated by a duration longer than this availability threshold, the evaluator will report that it is not available between the two records.

getDefaultAllowExtrapolation

public final boolean getDefaultAllowExtrapolation()

Gets a value indicating whether the evaluator created by this instance is allowed, by default, to extrapolate assessed performance before the first record or after the last one.

setDefaultAllowExtrapolation

public final void setDefaultAllowExtrapolation(boolean value)

Sets a value indicating whether the evaluator created by this instance is allowed, by default, to extrapolate assessed performance before the first record or after the last one.

getEvaluator

@Nonnull
public final Evaluator<PerformanceAssessmentField> getEvaluator(int prn)

Gets an evaluator that can be used to find assessed performance data over time for a given GPS satellite.

Availability is computed using the DefaultAvailabilityThreshold (get / set). Data extrapolation is controlled by the DefaultAllowExtrapolation (get / set) property.

Parameters:

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

Returns:

An evaluator to find the assessed performance data over time for a given GPS satellite.

getEvaluator

@Nonnull
public final Evaluator<PerformanceAssessmentField> getEvaluator(int prn,
                                                                          EvaluatorGroup group)

Gets an evaluator that can be used to find assessed performance data over time for a given GPS satellite.

Availability is computed using the DefaultAvailabilityThreshold (get / set). Data extrapolation is controlled by the DefaultAllowExtrapolation (get / set) property.

Parameters:

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

group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.

Returns:

An evaluator to find the assessed performance data over time for a given GPS satellite.

getEvaluator

@Nonnull
public final Evaluator<PerformanceAssessmentField> getEvaluator(int prn,
                                                                          @Nonnull
                                                                          Duration availabilityThreshold,
                                                                          boolean allowExtrapolation,
                                                                          @Nonnull
                                                                          EvaluatorGroup group)

Gets an evaluator that can be used to find assessed performance data over time for a given GPS satellite.

Parameters:

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

availabilityThreshold - The availability threshold used when evaluating assessed performance. If two records in the file are separated by a duration longer than this availability threshold, the evaluator will report that it is not available between the two records.

allowExtrapolation - Indicates whether the returned evaluator is allowed to extrapolate assessed performance before the first record or after the last one.

group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.

Returns:

An evaluator to find the assessed performance data over time for a given GPS satellite.

Throws:

ArgumentNullException - Thrown when group is null.

getSatelliteGlobalUserRangeErrorEvaluator

@Nonnull
public final Evaluator<SatelliteGlobalUserRangeError> getSatelliteGlobalUserRangeErrorEvaluator(@Nonnull
                                                                                                          IServiceProvider satellite)

Returns an evaluator which can compute the SatelliteGlobalUserRangeError for this Performance Assessment File at a given time.

Parameters:

satellite - The GPS satellite for which to obtain the global user range error. The satellite instance must provide IGpsPrnService and IOrientationAxesService.

Returns:

An evaluator that will return the global user range errors at a specified time.

Throws:

ArgumentNullException - Thrown when satellite is null.

getSatelliteGlobalUserRangeErrorEvaluator

@Nonnull
public final Evaluator<SatelliteGlobalUserRangeError> getSatelliteGlobalUserRangeErrorEvaluator(@Nonnull
                                                                                                          IServiceProvider satellite,
                                                                                                          @Nonnull
                                                                                                          EvaluatorGroup group)

Returns an evaluator which can compute the SatelliteGlobalUserRangeError for this Performance Assessment File at a given time.

Parameters:

satellite - The GPS satellite for which to obtain the global user range error. The satellite instance must provide IGpsPrnService and IOrientationAxesService.

group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.

Returns:

An evaluator that will return the global user range errors at a specified time.

Throws:

ArgumentNullException - Thrown when satellite or group is null.

clearItems

protected void clearItems()

Removes all elements from the BaseCollection.

Overrides:

clearItems in class BaseCollection<PerformanceAssessmentRecord>

insertItem

protected void insertItem(int index,
                          PerformanceAssessmentRecord item)

Inserts an element into the BaseCollection at the specified index.

Overrides:

insertItem in class BaseCollection<PerformanceAssessmentRecord>

Parameters:

index - Index where the item is inserted.

item - The object that will be inserted.

removeItem

protected void removeItem(int index)

Removes the element at the specified index of the BaseCollection.

Overrides:

removeItem in class BaseCollection<PerformanceAssessmentRecord>

Parameters:

index - Index where the item is removed.

setItem

protected void setItem(int index,
                       PerformanceAssessmentRecord item)

Replaces the element at the specified index.

Overrides:

setItem in class BaseCollection<PerformanceAssessmentRecord>

Parameters:

index - Index where the item will be replaced.

item - The new value for the element at the specified index.