RinexNavigationEphemeris | DME Component Libraries for Java 2024 r2

java.lang.Object
- agi.foundation.navigation.datareaders.RinexNavigationEphemeris

All Implemented Interfaces:

IEquatable<RinexNavigationEphemeris>, IGpsElements, IAvailability
```
public class RinexNavigationEphemeris
extends Object
implements IGpsElements, IAvailability, IEquatable<RinexNavigationEphemeris>
```
Contains the data for a single ephemeris defining the GPS satellite corresponding to PseudoRandomNumber (get).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Indicates whether another object is exactly equal to this instance.
`static boolean`	`equals(RinexNavigationEphemeris left, RinexNavigationEphemeris right)` Returns `true` if the two instances are exactly equal.
`boolean`	`equalsType(RinexNavigationEphemeris other)` Indicates whether another instance of this type is exactly equal to this instance.
`double`	`getAccuracy()` Gets the Sv accuracy.
`double`	`getArgumentOfPerigee()` Gets the argument of perigee.
`TimeIntervalCollection`	`getAvailabilityIntervals()` Gets a `TimeIntervalCollection` over which data is available.
`TimeIntervalCollection`	`getAvailabilityIntervals(TimeIntervalCollection consideredIntervals)` Gets the intervals over which data is available.
`double`	`getClockBias()` Gets the clock bias.
`double`	`getClockDrift()` Gets the clock drift.
`double`	`getClockDriftRate()` Gets the clock drift rate.
`double`	`getCosineCorrectionToArgumentOfLatitude()` Gets the amplitude of the cosine harmonic correction term to the Argument of Latitude.
`double`	`getCosineCorrectionToInclination()` Gets the amplitude of the cosine harmonic correction term to the angle of inclination.
`double`	`getCosineCorrectionToOrbitRadius()` Gets the amplitude of the sine harmonic correction term to the orbit radius.
`boolean`	`getDefaultValuesUsed()` Gets a value indicating whether or not the default value is used for any parameter.
`double`	`getEccentricity()` Gets eccentricity.
`GlobalPositioningSystemDate`	`getEpoch()` Gets the epoch at which these elements are specified.
`double`	`getFitInterval()` Gets the fit interval representing the duration in hours for which this ephemeris is valid.
`double`	`getGpsWeek()` Gets the GPS Week # (to go with `TimeOfEphemeris` (`get`)).
`double`	`getGroupDelayDifferential()` Gets the group delay differential (tgd) in seconds.
`double`	`getHealth()` Gets the Sv health (bits 17-22 w 3 sf 1).
`double`	`getInclinationAngle()` Gets the inclination angle.
`double`	`getIssueOfData()` Gets the issue of data ephemeris (IODE).
`double`	`getIssueOfDataClock()` Gets the issue of data clock (IODC).
`double`	`getL2Channel()` Gets the codes on L2 channel.
`double`	`getL2PDataFlag()` Gets the L2 P data flag.
`double`	`getLongitudeOfAscendingNode()` Gets the longitude of ascending node of orbit plane at weekly epoch.
`double`	`getMeanAnomaly()` Gets the mean anomaly.
`double`	`getMeanMotionDifference()` Gets the mean motion difference from computed value.
`int`	`getPseudoRandomNumber()` Gets the Pseudo Random Number (PRN).
`double`	`getRateOfInclinationAngle()` Gets the rate of inclination angle (IDOT).
`double`	`getRateOfRightAscension()` Gets the rate of right ascension.
`double`	`getSineCorrectionToArgumentOfLatitude()` Gets the amplitude of the sine harmonic correction term to the Argument of Latitude.
`double`	`getSineCorrectionToInclination()` Gets the amplitude of the sine harmonic correction term to the angle of inclination.
`double`	`getSineCorrectionToOrbitRadius()` Gets the amplitude of the sine harmonic correction term to the orbit radius.
`double`	`getSquareRootOfSemimajorAxis()` Gets the square root of the semi-major axis (sqrt(meters)).
`JulianDate`	`getTimeOfClock()` Gets GPS date of the time of clock of the message.
`double`	`getTimeOfEphemeris()` Gets the time of ephemeris (TOE).
`GlobalPositioningSystemDate`	`getTimeOfEphemerisGpsDate()` Gets the GPS date of the time of ephemeris of the message.
`double`	`getTransmissionTime()` Gets the transmission time of the message in seconds of the `GpsWeek` (`get`).
`GlobalPositioningSystemDate`	`getTransmissionTimeGpsDate()` Gets the GPS date of the transmission time of the message.
`int`	`hashCode()` Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
`boolean`	`isAvailable(JulianDate date)` Determines if valid data is available for the given `JulianDate`.
`static boolean`	`notEquals(RinexNavigationEphemeris left, RinexNavigationEphemeris right)` Returns `true` if the two instances are not exactly equal.
`static RinexNavigationEphemeris`	`readEphemeris(String[] ephemerisBlock)` Parse a block of eight lines representing a single ephemeris block formatted according to the RINEX Navigation file 2.10 standard.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getAvailabilityIntervals
```
public final TimeIntervalCollection getAvailabilityIntervals(TimeIntervalCollection consideredIntervals)
```
    Gets the intervals over which data is available.
    
    Specified by:
    
    getAvailabilityIntervals in interface IAvailability
    
    Parameters:
    
    consideredIntervals - The intervals over which availability information is needed. Note that the returned availability intervals may indicate availability outside of these intervals of consideration.
    
    Returns:
    
    The collection of availability intervals.
  - isAvailable
```
public final boolean isAvailable(@Nonnull
                                 JulianDate date)
```
    Determines if valid data is available for the given JulianDate.
    
    Specified by:
    
    isAvailable in interface IAvailability
    
    Parameters:
    
    date - The date for which to check availability.
    
    Returns:
    
    true if valid data is available for this date; otherwise false.
  - getAvailabilityIntervals
```
public final TimeIntervalCollection getAvailabilityIntervals()
```
    Gets a TimeIntervalCollection over which data is available. If the availability interval is infinite, this returns Infinite (get).
    It is recommended that you call RinexNavigationEphemeris.isAvailable(agi.foundation.time.JulianDate) to determine availability instead of calling this method and checking for yourself.
    
    Returns:
    
    The collection of availability intervals.
  - readEphemeris
```
@Nonnull
public static RinexNavigationEphemeris readEphemeris(@Nonnull
                                                               String[] ephemerisBlock)
```
    Parse a block of eight lines representing a single ephemeris block formatted according to the RINEX Navigation file 2.10 standard.
    
    Parameters:
    
    ephemerisBlock - A block of eight lines to parse.
    
    Returns:
    
    The instance read from the strings.
    
    Throws:
    
    IllegalStateException - Thrown when an invalid PRN is read from the block of data
    
    ArgumentNullException - Thrown when ephemerisBlock is null.
  - getPseudoRandomNumber
```
public final int getPseudoRandomNumber()
```
    Gets the Pseudo Random Number (PRN).
  - getEpoch
```
@Nonnull
public final GlobalPositioningSystemDate getEpoch()
```
    Gets the epoch at which these elements are specified.
    
    Specified by:
    
    getEpoch in interface IGpsElements
  - getClockBias
```
public final double getClockBias()
```
    Gets the clock bias.
  - getClockDrift
```
public final double getClockDrift()
```
    Gets the clock drift.
  - getClockDriftRate
```
public final double getClockDriftRate()
```
    Gets the clock drift rate.
  - getInclinationAngle
```
public final double getInclinationAngle()
```
    Gets the inclination angle. Units: rad
    
    Specified by:
    
    getInclinationAngle in interface IGpsElements
  - getMeanAnomaly
```
public final double getMeanAnomaly()
```
    Gets the mean anomaly. Units: rad
    
    Specified by:
    
    getMeanAnomaly in interface IGpsElements
  - getArgumentOfPerigee
```
public final double getArgumentOfPerigee()
```
    Gets the argument of perigee. Units: rad
    
    Specified by:
    
    getArgumentOfPerigee in interface IGpsElements
  - getRateOfRightAscension
```
public final double getRateOfRightAscension()
```
    Gets the rate of right ascension. Units: rad / s
    
    Specified by:
    
    getRateOfRightAscension in interface IGpsElements
  - getLongitudeOfAscendingNode
```
public final double getLongitudeOfAscendingNode()
```
    Gets the longitude of ascending node of orbit plane at weekly epoch. Units: rad
    
    Specified by:
    
    getLongitudeOfAscendingNode in interface IGpsElements
  - getCosineCorrectionToArgumentOfLatitude
```
public final double getCosineCorrectionToArgumentOfLatitude()
```
    Gets the amplitude of the cosine harmonic correction term to the Argument of Latitude. Units: rad
    
    Specified by:
    
    getCosineCorrectionToArgumentOfLatitude in interface IGpsElements
  - getCosineCorrectionToInclination
```
public final double getCosineCorrectionToInclination()
```
    Gets the amplitude of the cosine harmonic correction term to the angle of inclination. Units: rad
    
    Specified by:
    
    getCosineCorrectionToInclination in interface IGpsElements
  - getCosineCorrectionToOrbitRadius
```
public final double getCosineCorrectionToOrbitRadius()
```
    Gets the amplitude of the sine harmonic correction term to the orbit radius. Units: m
    
    Specified by:
    
    getCosineCorrectionToOrbitRadius in interface IGpsElements
  - getEccentricity
```
public final double getEccentricity()
```
    Gets eccentricity. Units: unitless
    
    Specified by:
    
    getEccentricity in interface IGpsElements
  - getIssueOfData
```
public final double getIssueOfData()
```
    Gets the issue of data ephemeris (IODE).
    
    Specified by:
    
    getIssueOfData in interface IGpsElements
  - getIssueOfDataClock
```
public final double getIssueOfDataClock()
```
    Gets the issue of data clock (IODC).
  - getMeanMotionDifference
```
public final double getMeanMotionDifference()
```
    Gets the mean motion difference from computed value. Units: rad / s
    
    Specified by:
    
    getMeanMotionDifference in interface IGpsElements
  - getRateOfInclinationAngle
```
public final double getRateOfInclinationAngle()
```
    Gets the rate of inclination angle (IDOT). Units: rad / s
    
    Specified by:
    
    getRateOfInclinationAngle in interface IGpsElements
  - getSineCorrectionToArgumentOfLatitude
```
public final double getSineCorrectionToArgumentOfLatitude()
```
    Gets the amplitude of the sine harmonic correction term to the Argument of Latitude. Units: rad
    
    Specified by:
    
    getSineCorrectionToArgumentOfLatitude in interface IGpsElements
  - getSineCorrectionToInclination
```
public final double getSineCorrectionToInclination()
```
    Gets the amplitude of the sine harmonic correction term to the angle of inclination. Units: rad
    
    Specified by:
    
    getSineCorrectionToInclination in interface IGpsElements
  - getSineCorrectionToOrbitRadius
```
public final double getSineCorrectionToOrbitRadius()
```
    Gets the amplitude of the sine harmonic correction term to the orbit radius. Units: m
    
    Specified by:
    
    getSineCorrectionToOrbitRadius in interface IGpsElements
  - getSquareRootOfSemimajorAxis
```
public final double getSquareRootOfSemimajorAxis()
```
    Gets the square root of the semi-major axis (sqrt(meters)). Units: sqrt(m)
    
    Specified by:
    
    getSquareRootOfSemimajorAxis in interface IGpsElements
  - getTimeOfEphemeris
```
public final double getTimeOfEphemeris()
```
    Gets the time of ephemeris (TOE).
  - getL2Channel
```
public final double getL2Channel()
```
    Gets the codes on L2 channel.
  - getGpsWeek
```
public final double getGpsWeek()
```
    Gets the GPS Week # (to go with TimeOfEphemeris (get)).
  - getTransmissionTime
```
public final double getTransmissionTime()
```
    Gets the transmission time of the message in seconds of the GpsWeek (get).
    Derived e.g. from Z-count in Hand Over Word (HOW).
  - getTransmissionTimeGpsDate
```
@Nonnull
public final GlobalPositioningSystemDate getTransmissionTimeGpsDate()
```
    Gets the GPS date of the transmission time of the message.
    This date is adjusted for GPS week rollovers. If there is a difference of more than 302400 seconds between the transmission time and the TimeOfEphemerisGpsDate (get), the transmission time will be adjusted. See IS GPS-200D, page 97 for details.
  - getTimeOfEphemerisGpsDate
```
@Nonnull
public final GlobalPositioningSystemDate getTimeOfEphemerisGpsDate()
```
    Gets the GPS date of the time of ephemeris of the message.
  - getTimeOfClock
```
@Nonnull
public final JulianDate getTimeOfClock()
```
    Gets GPS date of the time of clock of the message.
  - getFitInterval
```
public final double getFitInterval()
```
    Gets the fit interval representing the duration in hours for which this ephemeris is valid. Note that, according to ICD-GPS-200D, if the fit interval in the RINEX file is zero (or absent) the default fit interval is set to 4 hours.
  - getL2PDataFlag
```
public final double getL2PDataFlag()
```
    Gets the L2 P data flag.
  - getAccuracy
```
public final double getAccuracy()
```
    Gets the Sv accuracy. Units: m
  - getHealth
```
public final double getHealth()
```
    Gets the Sv health (bits 17-22 w 3 sf 1).
  - getGroupDelayDifferential
```
public final double getGroupDelayDifferential()
```
    Gets the group delay differential (tgd) in seconds.
  - getDefaultValuesUsed
```
public final boolean getDefaultValuesUsed()
```
    Gets a value indicating whether or not the default value is used for any parameter. This may result because of a parse failure for a particular item.
  - 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
  - equalsType
```
public final boolean equalsType(RinexNavigationEphemeris other)
```
    Indicates whether another instance of this type is exactly equal to this instance.
    
    Specified by:
    
    equalsType in interface IEquatable<RinexNavigationEphemeris>
    
    Parameters:
    
    other - The instance to compare to this instance.
    
    Returns:
    
    true if other represents the same value as this instance; otherwise false.
  - 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)
  - equals
```
public static boolean equals(RinexNavigationEphemeris left,
                             RinexNavigationEphemeris right)
```
    Returns true if the two instances are exactly equal.
    
    Parameters:
    
    left - The instance to compare to right.
    
    right - The instance to compare to left.
    
    Returns:
    
    true if left represents the same value as right; otherwise false.
  - notEquals
```
public static boolean notEquals(RinexNavigationEphemeris left,
                                RinexNavigationEphemeris right)
```
    Returns true if the two instances are not exactly equal.
    
    Parameters:
    
    left - The instance to compare to right.
    
    right - The instance to compare to left.
    
    Returns:
    
    true if left does not represent the same value as right; otherwise false.

Class RinexNavigationEphemeris

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getAvailabilityIntervals

isAvailable

getAvailabilityIntervals

readEphemeris

getPseudoRandomNumber

getEpoch

getClockBias

getClockDrift

getClockDriftRate

getInclinationAngle

getMeanAnomaly

getArgumentOfPerigee

getRateOfRightAscension

getLongitudeOfAscendingNode

getCosineCorrectionToArgumentOfLatitude

getCosineCorrectionToInclination

getCosineCorrectionToOrbitRadius

getEccentricity

getIssueOfData

getIssueOfDataClock

getMeanMotionDifference

getRateOfInclinationAngle

getSineCorrectionToArgumentOfLatitude

getSineCorrectionToInclination

getSineCorrectionToOrbitRadius

getSquareRootOfSemimajorAxis

getTimeOfEphemeris

getL2Channel

getGpsWeek

getTransmissionTime

getTransmissionTimeGpsDate

getTimeOfEphemerisGpsDate

getTimeOfClock

getFitInterval

getL2PDataFlag

getAccuracy

getHealth

getGroupDelayDifferential

getDefaultValuesUsed

equals

equalsType

hashCode

equals

notEquals