SemAlmanacRecord

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

All Implemented Interfaces:

IGpsElements
```
public class SemAlmanacRecord
extends Object
implements IGpsElements
```
A record in a SEM almanac, corresponding to a single space vehicle (SV).

Constructor Summary

Constructors
Constructor and Description

SemAlmanacRecord()
Initializes a new instance.

Constructors
Constructor and Description
`SemAlmanacRecord()` Initializes a new instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Platform`	`createSatellite()` Creates a GPS satellite for this SEM almanac record.
`double`	`getArgumentOfPerigee()` Gets the argument of perigee.
`double`	`getArgumentOfPerigeeSemicircles()` Gets the argument of perigee, in semicircles.
`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.
`double`	`getEccentricity()` Gets eccentricity.
`GlobalPositioningSystemDate`	`getEpoch()` Gets the epoch at which these elements are specified.
`double`	`getFirstOrderClockCorrection()` Gets the first order clock correction.
`int`	`getHealth()` Gets the satellite health code.
`double`	`getInclinationAngle()` Gets the inclination angle.
`double`	`getInclinationOffset()` Gets the orbit inclination angle offset in semicircles.
`double`	`getIssueOfData()` Gets the issue of data ephemeris (IODE).
`double`	`getLongitudeOfAscendingNode()` Gets the longitude of ascending node of orbit plane at weekly epoch.
`double`	`getLongitudeOfAscendingNodeSemicircles()` Gets the geographic longitude of the orbital plane at the weekly epoch, in semicircles.
`double`	`getMeanAnomaly()` Gets the mean anomaly.
`double`	`getMeanAnomalySemicircles()` Gets the mean anomaly, in semicircles.
`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`	`getRateOfRightAscensionSemicircles()` Gets the rate of right ascension, in semicircles per second.
`int`	`getSatelliteConfiguration()` Gets the satellite configuration code.
`int`	`getSatelliteVehicleNumber()` Gets the satellite vehicle number (SVN).
`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)).
`int`	`getUserRangeAccuracy()` Gets the average User Range Accuracy (URA) number.
`double`	`getZerothOrderClockCorrection()` Gets the zeroth order clock correction.
`static SemAlmanacRecord`	`readFrom(GlobalPositioningSystemDate almanacEpoch, BufferedReader reader)` Reads a record from a stream.
`void`	`setArgumentOfPerigeeSemicircles(double value)` Sets the argument of perigee, in semicircles.
`void`	`setEccentricity(double value)` Sets eccentricity.
`void`	`setEpoch(GlobalPositioningSystemDate value)` Sets the epoch at which these elements are specified.
`void`	`setFirstOrderClockCorrection(double value)` Sets the first order clock correction.
`void`	`setHealth(int value)` Sets the satellite health code.
`void`	`setInclinationOffset(double value)` Sets the orbit inclination angle offset in semicircles.
`void`	`setLongitudeOfAscendingNodeSemicircles(double value)` Sets the geographic longitude of the orbital plane at the weekly epoch, in semicircles.
`void`	`setMeanAnomalySemicircles(double value)` Sets the mean anomaly, in semicircles.
`void`	`setPseudoRandomNumber(int value)` Sets the Pseudo Random Number (PRN).
`void`	`setRateOfRightAscensionSemicircles(double value)` Sets the rate of right ascension, in semicircles per second.
`void`	`setSatelliteConfiguration(int value)` Sets the satellite configuration code.
`void`	`setSatelliteVehicleNumber(int value)` Sets the satellite vehicle number (SVN).
`void`	`setSquareRootOfSemimajorAxis(double value)` Sets the square root of the semi-major axis (sqrt(meters)).
`void`	`setUserRangeAccuracy(int value)` Sets the average User Range Accuracy (URA) number.
`void`	`setZerothOrderClockCorrection(double value)` Sets the zeroth order clock correction.

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

- Constructor Detail
  - SemAlmanacRecord
```
public SemAlmanacRecord()
```
    Initializes a new instance.
- Method Detail
  - readFrom
```
@Nonnull
public static SemAlmanacRecord readFrom(@Nonnull
                                                  GlobalPositioningSystemDate almanacEpoch,
                                                  @Nonnull
                                                  BufferedReader reader)
```
    Reads a record from a stream.
    
    Parameters:
    
    almanacEpoch - The epoch of the SEM almanac that this record is being read from.
    
    reader - The stream to read from.
    
    Returns:
    
    A record read from the stream.
    
    Throws:
    
    ArgumentNullException - Thrown when the reader is null.
  - getEpoch
```
@Nonnull
public final GlobalPositioningSystemDate getEpoch()
```
    Gets the epoch at which these elements are specified.
    
    Specified by:
    
    getEpoch in interface IGpsElements
  - setEpoch
```
public final void setEpoch(@Nonnull
                           GlobalPositioningSystemDate value)
```
    Sets the epoch at which these elements are specified.
  - getPseudoRandomNumber
```
public final int getPseudoRandomNumber()
```
    Gets the Pseudo Random Number (PRN).
  - setPseudoRandomNumber
```
public final void setPseudoRandomNumber(int value)
```
    Sets the Pseudo Random Number (PRN).
  - getSatelliteVehicleNumber
```
public final int getSatelliteVehicleNumber()
```
    Gets the satellite vehicle number (SVN).
  - setSatelliteVehicleNumber
```
public final void setSatelliteVehicleNumber(int value)
```
    Sets the satellite vehicle number (SVN).
  - getUserRangeAccuracy
```
public final int getUserRangeAccuracy()
```
    Gets the average User Range Accuracy (URA) number.
  - setUserRangeAccuracy
```
public final void setUserRangeAccuracy(int value)
```
    Sets the average User Range Accuracy (URA) number.
  - getZerothOrderClockCorrection
```
public final double getZerothOrderClockCorrection()
```
    Gets the zeroth order clock correction.
  - setZerothOrderClockCorrection
```
public final void setZerothOrderClockCorrection(double value)
```
    Sets the zeroth order clock correction.
  - getFirstOrderClockCorrection
```
public final double getFirstOrderClockCorrection()
```
    Gets the first order clock correction.
  - setFirstOrderClockCorrection
```
public final void setFirstOrderClockCorrection(double value)
```
    Sets the first order clock correction.
  - getInclinationOffset
```
public final double getInclinationOffset()
```
    Gets the orbit inclination angle offset in semicircles.
    This is the actual value from the almanac. It does not include the 0.30 semicircle reference value (NavstarISGps200D.IZero). InclinationAngle (get) returns the complete inclination angle in radians.
  - setInclinationOffset
```
public final void setInclinationOffset(double value)
```
    Sets the orbit inclination angle offset in semicircles.
    This is the actual value from the almanac. It does not include the 0.30 semicircle reference value (NavstarISGps200D.IZero). InclinationAngle (get) returns the complete inclination angle in radians.
  - getInclinationAngle
```
public final double getInclinationAngle()
```
    Gets the inclination angle. Units: rad
    This property includes the 0.30 semicircle reference value (NavstarISGps200D.IZero) and has been converted to radians. Use InclinationOffset (get / set) to obtain the original value from the almanac.
    
    Specified by:
    
    getInclinationAngle in interface IGpsElements
  - getMeanAnomalySemicircles
```
public final double getMeanAnomalySemicircles()
```
    Gets the mean anomaly, in semicircles.
    This is the actual value from the almanac. MeanAnomaly (get) returns the mean anomaly in radians.
  - setMeanAnomalySemicircles
```
public final void setMeanAnomalySemicircles(double value)
```
    Sets the mean anomaly, in semicircles.
    This is the actual value from the almanac. MeanAnomaly (get) returns the mean anomaly in radians.
  - getMeanAnomaly
```
public final double getMeanAnomaly()
```
    Gets the mean anomaly. Units: rad
    This property is the mean anomaly converted to radians. Use MeanAnomalySemicircles (get / set) to obtain the original value from the almanac.
    
    Specified by:
    
    getMeanAnomaly in interface IGpsElements
  - getArgumentOfPerigeeSemicircles
```
public final double getArgumentOfPerigeeSemicircles()
```
    Gets the argument of perigee, in semicircles.
    This is the actual value from the almanac. ArgumentOfPerigee (get) returns the argument of perigee in radians.
  - setArgumentOfPerigeeSemicircles
```
public final void setArgumentOfPerigeeSemicircles(double value)
```
    Sets the argument of perigee, in semicircles.
    This is the actual value from the almanac. ArgumentOfPerigee (get) returns the argument of perigee in radians.
  - getArgumentOfPerigee
```
public final double getArgumentOfPerigee()
```
    Gets the argument of perigee. Units: rad
    This property is the argument of perigee converted to radians. Use ArgumentOfPerigeeSemicircles (get / set) to obtain the original value from the almanac.
    
    Specified by:
    
    getArgumentOfPerigee in interface IGpsElements
  - getRateOfRightAscensionSemicircles
```
public final double getRateOfRightAscensionSemicircles()
```
    Gets the rate of right ascension, in semicircles per second.
    This is the actual value from the almanac. RateOfRightAscension (get) returns the rate of right ascension in radians per second.
  - setRateOfRightAscensionSemicircles
```
public final void setRateOfRightAscensionSemicircles(double value)
```
    Sets the rate of right ascension, in semicircles per second.
    This is the actual value from the almanac. RateOfRightAscension (get) returns the rate of right ascension in radians per second.
  - getRateOfRightAscension
```
public final double getRateOfRightAscension()
```
    Gets the rate of right ascension. Units: rad / s
    This property is the rate of right ascension converted to radians per second. Use RateOfRightAscensionSemicircles (get / set) to obtain the original value from the almanac.
    
    Specified by:
    
    getRateOfRightAscension in interface IGpsElements
  - getLongitudeOfAscendingNodeSemicircles
```
public final double getLongitudeOfAscendingNodeSemicircles()
```
    Gets the geographic longitude of the orbital plane at the weekly epoch, in semicircles.
    This is the actual value from the almanac LongitudeOfAscendingNode (get) returns the longitude of the orbital plane in radians.
  - setLongitudeOfAscendingNodeSemicircles
```
public final void setLongitudeOfAscendingNodeSemicircles(double value)
```
    Sets the geographic longitude of the orbital plane at the weekly epoch, in semicircles.
    This is the actual value from the almanac LongitudeOfAscendingNode (get) returns the longitude of the orbital plane in radians.
  - getLongitudeOfAscendingNode
```
public final double getLongitudeOfAscendingNode()
```
    Gets the longitude of ascending node of orbit plane at weekly epoch. Units: rad
    This property is the longitude converted to radians. Use LongitudeOfAscendingNodeSemicircles (get / set) to obtain the original value from the almanac.
    
    Specified by:
    
    getLongitudeOfAscendingNode in interface IGpsElements
  - getHealth
```
public final int getHealth()
```
    Gets the satellite health code.
  - setHealth
```
public final void setHealth(int value)
```
    Sets the satellite health code.
  - getSatelliteConfiguration
```
public final int getSatelliteConfiguration()
```
    Gets the satellite configuration code.
  - setSatelliteConfiguration
```
public final void setSatelliteConfiguration(int value)
```
    Sets the satellite configuration code.
  - createSatellite
```
@Nonnull
public final Platform createSatellite()
```
    Creates a GPS satellite for this SEM almanac record.
    
    Returns:
    
    The satellite created from this record.
  - getCosineCorrectionToArgumentOfLatitude
```
public final double getCosineCorrectionToArgumentOfLatitude()
```
    Gets the amplitude of the cosine harmonic correction term to the Argument of Latitude. Units: rad
    This property always returns 0.0 because SEM almanacs do not include this information.
    
    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
    This property always returns 0.0 because SEM almanacs do not include this information.
    
    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
    This property always returns 0.0 because SEM almanacs do not include this information.
    
    Specified by:
    
    getCosineCorrectionToOrbitRadius in interface IGpsElements
  - getEccentricity
```
public final double getEccentricity()
```
    Gets eccentricity. Units: unitless
    
    Specified by:
    
    getEccentricity in interface IGpsElements
  - setEccentricity
```
public final void setEccentricity(double value)
```
    Sets eccentricity. Units: unitless
  - getIssueOfData
```
public final double getIssueOfData()
```
    Gets the issue of data ephemeris (IODE).
    This property always returns 0 because SEM almanacs do not include this information.
    
    Specified by:
    
    getIssueOfData in interface IGpsElements
  - getMeanMotionDifference
```
public final double getMeanMotionDifference()
```
    Gets the mean motion difference from computed value. Units: rad / s
    This property always returns 0.0 because SEM almanacs do not include this information.
    
    Specified by:
    
    getMeanMotionDifference in interface IGpsElements
  - getRateOfInclinationAngle
```
public final double getRateOfInclinationAngle()
```
    Gets the rate of inclination angle (IDOT). Units: rad / s
    This property always returns 0.0 because SEM almanacs do not include this information.
    
    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
    This property always returns 0.0 because SEM almanacs do not include this information.
    
    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
    This property always returns 0.0 because SEM almanacs do not include this information.
    
    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
    This property always returns 0.0 because SEM almanacs do not include this information.
    
    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
  - setSquareRootOfSemimajorAxis
```
public final void setSquareRootOfSemimajorAxis(double value)
```
    Sets the square root of the semi-major axis (sqrt(meters)). Units: sqrt(m)

Class SemAlmanacRecord

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

readFrom

getEpoch

setEpoch

getPseudoRandomNumber

setPseudoRandomNumber

getSatelliteVehicleNumber

setSatelliteVehicleNumber

getUserRangeAccuracy

setUserRangeAccuracy

getZerothOrderClockCorrection

setZerothOrderClockCorrection

getFirstOrderClockCorrection

setFirstOrderClockCorrection

getInclinationOffset

setInclinationOffset

getInclinationAngle

getMeanAnomalySemicircles

setMeanAnomalySemicircles

getMeanAnomaly

getArgumentOfPerigeeSemicircles

setArgumentOfPerigeeSemicircles

getArgumentOfPerigee

getRateOfRightAscensionSemicircles

setRateOfRightAscensionSemicircles

getRateOfRightAscension

getLongitudeOfAscendingNodeSemicircles

setLongitudeOfAscendingNodeSemicircles

getLongitudeOfAscendingNode

getHealth

setHealth

getSatelliteConfiguration

setSatelliteConfiguration

createSatellite

getCosineCorrectionToArgumentOfLatitude

getCosineCorrectionToInclination

getCosineCorrectionToOrbitRadius

getEccentricity

setEccentricity

getIssueOfData

getMeanMotionDifference

getRateOfInclinationAngle

getSineCorrectionToArgumentOfLatitude

getSineCorrectionToInclination

getSineCorrectionToOrbitRadius

getSquareRootOfSemimajorAxis

setSquareRootOfSemimajorAxis