agi.foundation.navigation.datareaders

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

Class PerformanceAssessmentField

java.lang.Object

agi.foundation.navigation.datareaders.PerformanceAssessmentField

All Implemented Interfaces:

IEquatable<PerformanceAssessmentField>

public class PerformanceAssessmentField
extends Object
implements IEquatable<PerformanceAssessmentField>

A single field in a Performance Assessment File (PAF). It contains ephemeris and clock errors for one satellite at one time.

Constructor Summary

Constructors

Constructor and Description
PerformanceAssessmentField(int pseudoRandomNumber, boolean isDataAvailable, double positionErrorX, double positionErrorY, double positionErrorZ, double clockPhaseError, double velocityErrorX, double velocityErrorY, double velocityErrorZ, double clockFrequencyError, double ageOfData) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
boolean	equalsType(PerformanceAssessmentField other) Indicates whether another instance of this type is exactly equal to this instance.
double	getAgeOfData() Gets the Age of the navigation data on the satellite
double	getClockFrequencyError() Gets the Satellite Clock Phase error in meters/second
double	getClockPhaseError() Gets the Satellite Clock Phase error in meters
boolean	getDataAvailable() Gets a value indicating whether the data in this record should be used.
double	getPositionErrorX() Gets the ephemeris position error in the Earth-centered, Earth-Fixed X direction in meters
double	getPositionErrorY() Gets the ephemeris position error in the Earth-centered, Earth-Fixed Y direction in meters
double	getPositionErrorZ() Gets the ephemeris position error in the Earth-centered, Earth-Fixed Z direction in meters
int	getPseudoRandomNumber() Gets the PRN of this satellite
double	getVelocityErrorX() Gets the ephemeris velocity error in the Earth-centered, Earth-Fixed X direction in meters/second
double	getVelocityErrorY() Gets the ephemeris velocity error in the Earth-centered, Earth-Fixed Y direction in meters/second
double	getVelocityErrorZ() Gets the ephemeris velocity error in the Earth-centered, Earth-Fixed Z direction in meters/second
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Methods inherited from class java.lang.Object

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

Constructor Detail

PerformanceAssessmentField

public PerformanceAssessmentField(int pseudoRandomNumber,
                                  boolean isDataAvailable,
                                  double positionErrorX,
                                  double positionErrorY,
                                  double positionErrorZ,
                                  double clockPhaseError,
                                  double velocityErrorX,
                                  double velocityErrorY,
                                  double velocityErrorZ,
                                  double clockFrequencyError,
                                  double ageOfData)

Initializes a new instance.

Parameters:

pseudoRandomNumber - Pseudo Random Number (PRN) identifying the corresponding GPS spacecraft.

isDataAvailable - Flag indicating whether data is available.

positionErrorX - Position error in X.

positionErrorY - Position error in Y.

positionErrorZ - Position error in Z.

clockPhaseError - Clock phase error.

velocityErrorX - Velocity error in X.

velocityErrorY - Velocity error in Y.

velocityErrorZ - Velocity error in Z.

clockFrequencyError - Clock frequency error.

ageOfData - The age of the data.

Method Detail

equalsType

public final boolean equalsType(PerformanceAssessmentField other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<PerformanceAssessmentField>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

getPseudoRandomNumber

public final int getPseudoRandomNumber()

Gets the PRN of this satellite

getDataAvailable

public final boolean getDataAvailable()

Gets a value indicating whether the data in this record should be used. This should be checked prior to using any data in this record.

getPositionErrorX

public final double getPositionErrorX()

Gets the ephemeris position error in the Earth-centered, Earth-Fixed X direction in meters

getPositionErrorY

public final double getPositionErrorY()

Gets the ephemeris position error in the Earth-centered, Earth-Fixed Y direction in meters

getPositionErrorZ

public final double getPositionErrorZ()

Gets the ephemeris position error in the Earth-centered, Earth-Fixed Z direction in meters

getClockPhaseError

public final double getClockPhaseError()

Gets the Satellite Clock Phase error in meters

getVelocityErrorX

public final double getVelocityErrorX()

Gets the ephemeris velocity error in the Earth-centered, Earth-Fixed X direction in meters/second

getVelocityErrorY

public final double getVelocityErrorY()

Gets the ephemeris velocity error in the Earth-centered, Earth-Fixed Y direction in meters/second

getVelocityErrorZ

public final double getVelocityErrorZ()

Gets the ephemeris velocity error in the Earth-centered, Earth-Fixed Z direction in meters/second

getClockFrequencyError

public final double getClockFrequencyError()

Gets the Satellite Clock Phase error in meters/second

getAgeOfData

public final double getAgeOfData()

Gets the Age of the navigation data on the satellite