RinexNavigation (ORbit Extrapolation KIT 11.0.1 API)

java.lang.Object
- org.orekit.gnss.navigation.RinexNavigation

```
public class RinexNavigation
extends Object
```
Represents a parsed RINEX navigation messages files.

Since:

11.0

Author:

Bryan Cazabonne

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RinexNavigation.TimeSystemCorrection
Container for time system corrections.

Nested Classes
Modifier and Type	Class and Description
`static class`	`RinexNavigation.TimeSystemCorrection` Container for time system corrections.

Constructor Summary

Constructors
Constructor and Description

RinexNavigation()
Constructor.

Constructors
Constructor and Description
`RinexNavigation()` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBeidouNavigationMessage(BeidouNavigationMessage message)` Add a Beidou navigation message to the list.
`void`	`addComment(String comment)` Add a comment line.
`void`	`addGalileoNavigationMessage(GalileoNavigationMessage message)` Add a Galileo navigation message to the list.
`void`	`addGlonassNavigationMessage(GLONASSNavigationMessage message)` Add a Glonass navigation message to the list.
`void`	`addGPSNavigationMessage(GPSNavigationMessage message)` Add a GPS navigation message to the list.
`void`	`addIRNSSNavigationMessage(IRNSSNavigationMessage message)` Add a IRNSS navigation message to the list.
`void`	`addQZSSNavigationMessage(QZSSNavigationMessage message)` Add a QZSS navigation message to the list.
`void`	`addSBASNavigationMessage(SBASNavigationMessage message)` Add a SBAS navigation message to the list.
`void`	`addTimeSystemCorrections(RinexNavigation.TimeSystemCorrection timeSystemCorrection)` Add a time system correction to the list.
`String`	`getAgencyName()` Getter for the agency name.
`Map<String,List<BeidouNavigationMessage>>`	`getBeidouNavigationMessages()` Get all the Beidou navigation messages contained in the file.
`List<BeidouNavigationMessage>`	`getBeidouNavigationMessages(String satId)` Get the Beidou navigation messages for the given satellite Id.
`String`	`getComments()` Getter for the comments.
`AbsoluteDate`	`getCreationDate()` Getter for the creation date.
`String`	`getCreationDateString()` Getter for the creation date of the file as a string.
`String`	`getCreationTimeString()` Getter for the creation time of the file as a string.
`String`	`getCreationTimeZoneString()` Getter for the creation time zone of the file as a string.
`String`	`getFileType()` Get the file type.
`double`	`getFormatVersion()` Getter for the format version.
`Map<String,List<GalileoNavigationMessage>>`	`getGalileoNavigationMessages()` Get all the Galileo navigation messages contained in the file.
`List<GalileoNavigationMessage>`	`getGalileoNavigationMessages(String satId)` Get the Galileo navigation messages for the given satellite Id.
`Map<String,List<GLONASSNavigationMessage>>`	`getGlonassNavigationMessages()` Get all the Glonass navigation messages contained in the file.
`List<GLONASSNavigationMessage>`	`getGlonassNavigationMessages(String satId)` Get the Glonass navigation messages for the given satellite Id.
`Map<String,List<GPSNavigationMessage>>`	`getGPSNavigationMessages()` Get all the GPS navigation messages contained in the file.
`List<GPSNavigationMessage>`	`getGPSNavigationMessages(String satId)` Get the GPS navigation messages for the given satellite Id.
`String`	`getIonosphericCorrectionType()` Getter for the ionospheric correction type.
`Map<String,List<IRNSSNavigationMessage>>`	`getIRNSSNavigationMessages()` Get all the IRNSS navigation messages contained in the file.
`List<IRNSSNavigationMessage>`	`getIRNSSNavigationMessages(String satId)` Get the IRNSS navigation messages for the given satellite Id.
`double[]`	`getKlobucharAlpha()` Get the "alpha" ionospheric parameters.
`double[]`	`getKlobucharBeta()` Get the "beta" ionospheric parameters.
`double[]`	`getNeQuickAlpha()` Get the "alpha" ionospheric parameters.
`int`	`getNumberOfLeapSeconds()` Getter for the current number of leap seconds.
`String`	`getProgramName()` Getter for the program name.
`Map<String,List<QZSSNavigationMessage>>`	`getQZSSNavigationMessages()` Get all the QZSS navigation messages contained in the file.
`List<QZSSNavigationMessage>`	`getQZSSNavigationMessages(String satId)` Get the QZSS navigation messages for the given satellite Id.
`SatelliteSystem`	`getSatelliteSystem()` Getter for the satellite system.
`Map<String,List<SBASNavigationMessage>>`	`getSBASNavigationMessages()` Get all the SBAS navigation messages contained in the file.
`List<SBASNavigationMessage>`	`getSBASNavigationMessages(String satId)` Get the SBAS navigation messages for the given satellite Id.
`List<RinexNavigation.TimeSystemCorrection>`	`getTimeSystemCorrections()` Getter for the time system corrections contained in the file header.
`void`	`setAgencyName(String agencyName)` Setter for the agency name.
`void`	`setCreationDate(AbsoluteDate creationDate)` Setter for the creation date.
`void`	`setCreationDateString(String creationDateString)` Setter for the creation date as a string.
`void`	`setCreationTimeString(String creationTimeString)` Setter for the creation time as a string.
`void`	`setCreationTimeZoneString(String creationTimeZoneString)` Setter for the creation time zone.
`void`	`setFileType(String fileType)` Setter for the file type.
`void`	`setFormatVersion(double formatVersion)` Setter for the format version.
`void`	`setIonosphericCorrectionType(String ionosphericCorrectionType)` Setter for the ionospheric correction type.
`void`	`setKlobucharAlpha(double[] klobucharAlpha)` Set the "alpha" ionspheric parameters.
`void`	`setKlobucharBeta(double[] klobucharBeta)` Set the "beta" ionospheric parameters.
`void`	`setNeQuickAlpha(double[] neQuickAlpha)` Set the "alpha" ionospheric parameters.
`void`	`setNumberOfLeapSeconds(int numberOfLeapSeconds)` Setter for the current number of leap seconds.
`void`	`setProgramName(String programName)` Setter for the program name.
`void`	`setSatelliteSystem(SatelliteSystem satelliteSystem)` Setter for the satellite system.

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

- Constructor Detail
  - RinexNavigation
```
public RinexNavigation()
```
    Constructor.
- Method Detail
  - getFormatVersion
```
public double getFormatVersion()
```
    Getter for the format version.
    
    Returns:
    
    the format version
  - setFormatVersion
```
public void setFormatVersion(double formatVersion)
```
    Setter for the format version.
    
    Parameters:
    
    formatVersion - the format version to set
  - getFileType
```
public String getFileType()
```
    Get the file type.
    
    Returns:
    
    'N' for navigation data.
  - setFileType
```
public void setFileType(String fileType)
```
    Setter for the file type.
    
    Parameters:
    
    fileType - must be 'N' for navigation data
  - getSatelliteSystem
```
public SatelliteSystem getSatelliteSystem()
```
    Getter for the satellite system.
    Not specified for RINEX 2.X versions (value is null).
    
    Returns:
    
    the satellite system
  - setSatelliteSystem
```
public void setSatelliteSystem(SatelliteSystem satelliteSystem)
```
    Setter for the satellite system.
    
    Parameters:
    
    satelliteSystem - the satellite system to set
  - getProgramName
```
public String getProgramName()
```
    Getter for the program name.
    
    Returns:
    
    the program name
  - setProgramName
```
public void setProgramName(String programName)
```
    Setter for the program name.
    
    Parameters:
    
    programName - the program name to set
  - getAgencyName
```
public String getAgencyName()
```
    Getter for the agency name.
    
    Returns:
    
    the agencyName
  - setAgencyName
```
public void setAgencyName(String agencyName)
```
    Setter for the agency name.
    
    Parameters:
    
    agencyName - the agency name to set
  - getCreationDateString
```
public String getCreationDateString()
```
    Getter for the creation date of the file as a string.
    
    Returns:
    
    the creation date as a string
  - setCreationDateString
```
public void setCreationDateString(String creationDateString)
```
    Setter for the creation date as a string.
    
    Parameters:
    
    creationDateString - the creation date as a string to set
  - getCreationTimeString
```
public String getCreationTimeString()
```
    Getter for the creation time of the file as a string.
    
    Returns:
    
    the creation time as a string
  - setCreationTimeString
```
public void setCreationTimeString(String creationTimeString)
```
    Setter for the creation time as a string.
    
    Parameters:
    
    creationTimeString - the creation time as a string to set
  - getCreationTimeZoneString
```
public String getCreationTimeZoneString()
```
    Getter for the creation time zone of the file as a string.
    
    Returns:
    
    the creation time zone as a string
  - setCreationTimeZoneString
```
public void setCreationTimeZoneString(String creationTimeZoneString)
```
    Setter for the creation time zone.
    
    Parameters:
    
    creationTimeZoneString - the creation time zone as a string to set
  - getCreationDate
```
public AbsoluteDate getCreationDate()
```
    Getter for the creation date.
    
    Returns:
    
    the creation date
  - setCreationDate
```
public void setCreationDate(AbsoluteDate creationDate)
```
    Setter for the creation date.
    
    Parameters:
    
    creationDate - the creation date to set
  - getComments
```
public String getComments()
```
    Getter for the comments.
    
    Returns:
    
    the comments
  - addComment
```
public void addComment(String comment)
```
    Add a comment line.
    
    Parameters:
    
    comment - the comment line to add
  - getIonosphericCorrectionType
```
public String getIonosphericCorrectionType()
```
    Getter for the ionospheric correction type.
    Only the three first characters are given (e.g. GAL, GPS, QZS, BDS, or IRN)
    
    Returns:
    
    the ionospheric correction type
  - setIonosphericCorrectionType
```
public void setIonosphericCorrectionType(String ionosphericCorrectionType)
```
    Setter for the ionospheric correction type.
    
    Parameters:
    
    ionosphericCorrectionType - the ionospheric correction type to set
  - getKlobucharAlpha
```
public double[] getKlobucharAlpha()
```
    Get the "alpha" ionospheric parameters.
    They are used to initialize the KlobucharIonoModel.
    
    Returns:
    
    the "alpha" ionospheric parameters
  - setKlobucharAlpha
```
public void setKlobucharAlpha(double[] klobucharAlpha)
```
    Set the "alpha" ionspheric parameters.
    
    Parameters:
    
    klobucharAlpha - the "alpha" ionspheric parameters to set
  - getKlobucharBeta
```
public double[] getKlobucharBeta()
```
    Get the "beta" ionospheric parameters.
    They are used to initialize the KlobucharIonoModel.
    
    Returns:
    
    the "beta" ionospheric parameters
  - setKlobucharBeta
```
public void setKlobucharBeta(double[] klobucharBeta)
```
    Set the "beta" ionospheric parameters.
    
    Parameters:
    
    klobucharBeta - the "beta" ionospheric parameters to set
  - getNeQuickAlpha
```
public double[] getNeQuickAlpha()
```
    Get the "alpha" ionospheric parameters.
    They are used to initialize the NeQuickModel.
    
    Returns:
    
    the "alpha" ionospheric parameters
  - setNeQuickAlpha
```
public void setNeQuickAlpha(double[] neQuickAlpha)
```
    Set the "alpha" ionospheric parameters.
    
    Parameters:
    
    neQuickAlpha - the "alpha" ionospheric parameters to set
  - getTimeSystemCorrections
```
public List<RinexNavigation.TimeSystemCorrection> getTimeSystemCorrections()
```
    Getter for the time system corrections contained in the file header.
    Corrections to transform the system time to UTC or oter time system.
    
    Returns:
    
    the list of time system corrections
  - addTimeSystemCorrections
```
public void addTimeSystemCorrections(RinexNavigation.TimeSystemCorrection timeSystemCorrection)
```
    Add a time system correction to the list.
    
    Parameters:
    
    timeSystemCorrection - the element to add
  - getNumberOfLeapSeconds
```
public int getNumberOfLeapSeconds()
```
    Getter for the current number of leap seconds.
    
    Returns:
    
    the current number of leap seconds
  - setNumberOfLeapSeconds
```
public void setNumberOfLeapSeconds(int numberOfLeapSeconds)
```
    Setter for the current number of leap seconds.
    
    Parameters:
    
    numberOfLeapSeconds - the number of leap seconds to set
  - getGPSNavigationMessages
```
public Map<String,List<GPSNavigationMessage>> getGPSNavigationMessages()
```
    Get all the GPS navigation messages contained in the file.
    
    Returns:
    
    an unmodifiable list of GPS navigation messages
  - getGPSNavigationMessages
```
public List<GPSNavigationMessage> getGPSNavigationMessages(String satId)
```
    Get the GPS navigation messages for the given satellite Id.
    
    Parameters:
    
    satId - satellite Id (i.e. Satellite System (e.g. G) + satellite number)
    
    Returns:
    
    an unmodifiable list of GPS navigation messages
  - addGPSNavigationMessage
```
public void addGPSNavigationMessage(GPSNavigationMessage message)
```
    Add a GPS navigation message to the list.
    
    Parameters:
    
    message - message to add
  - getGalileoNavigationMessages
```
public Map<String,List<GalileoNavigationMessage>> getGalileoNavigationMessages()
```
    Get all the Galileo navigation messages contained in the file.
    
    Returns:
    
    an unmodifiable list of Galileo navigation messages
  - getGalileoNavigationMessages
```
public List<GalileoNavigationMessage> getGalileoNavigationMessages(String satId)
```
    Get the Galileo navigation messages for the given satellite Id.
    
    Parameters:
    
    satId - satellite Id (i.e. Satellite System (e.g. E) + satellite number)
    
    Returns:
    
    an unmodifiable list of Galileo navigation messages
  - addGalileoNavigationMessage
```
public void addGalileoNavigationMessage(GalileoNavigationMessage message)
```
    Add a Galileo navigation message to the list.
    
    Parameters:
    
    message - message to add
  - getBeidouNavigationMessages
```
public Map<String,List<BeidouNavigationMessage>> getBeidouNavigationMessages()
```
    Get all the Beidou navigation messages contained in the file.
    
    Returns:
    
    an unmodifiable list of Beidou navigation messages
  - getBeidouNavigationMessages
```
public List<BeidouNavigationMessage> getBeidouNavigationMessages(String satId)
```
    Get the Beidou navigation messages for the given satellite Id.
    
    Parameters:
    
    satId - satellite Id (i.e. Satellite System (e.g. C) + satellite number)
    
    Returns:
    
    an unmodifiable list of Beidou navigation messages
  - addBeidouNavigationMessage
```
public void addBeidouNavigationMessage(BeidouNavigationMessage message)
```
    Add a Beidou navigation message to the list.
    
    Parameters:
    
    message - message to add
  - getQZSSNavigationMessages
```
public Map<String,List<QZSSNavigationMessage>> getQZSSNavigationMessages()
```
    Get all the QZSS navigation messages contained in the file.
    
    Returns:
    
    an unmodifiable list of QZSS navigation messages
  - getQZSSNavigationMessages
```
public List<QZSSNavigationMessage> getQZSSNavigationMessages(String satId)
```
    Get the QZSS navigation messages for the given satellite Id.
    
    Parameters:
    
    satId - satellite Id (i.e. Satellite System (e.g. J) + satellite number)
    
    Returns:
    
    an unmodifiable list of QZSS navigation messages
  - addQZSSNavigationMessage
```
public void addQZSSNavigationMessage(QZSSNavigationMessage message)
```
    Add a QZSS navigation message to the list.
    
    Parameters:
    
    message - message to add
  - getIRNSSNavigationMessages
```
public Map<String,List<IRNSSNavigationMessage>> getIRNSSNavigationMessages()
```
    Get all the IRNSS navigation messages contained in the file.
    
    Returns:
    
    an unmodifiable list of IRNSS navigation messages
  - getIRNSSNavigationMessages
```
public List<IRNSSNavigationMessage> getIRNSSNavigationMessages(String satId)
```
    Get the IRNSS navigation messages for the given satellite Id.
    
    Parameters:
    
    satId - satellite Id (i.e. Satellite System (e.g. I) + satellite number)
    
    Returns:
    
    an unmodifiable list of IRNSS navigation messages
  - addIRNSSNavigationMessage
```
public void addIRNSSNavigationMessage(IRNSSNavigationMessage message)
```
    Add a IRNSS navigation message to the list.
    
    Parameters:
    
    message - message to add
  - getGlonassNavigationMessages
```
public Map<String,List<GLONASSNavigationMessage>> getGlonassNavigationMessages()
```
    Get all the Glonass navigation messages contained in the file.
    
    Returns:
    
    an unmodifiable list of Glonass navigation messages
  - getGlonassNavigationMessages
```
public List<GLONASSNavigationMessage> getGlonassNavigationMessages(String satId)
```
    Get the Glonass navigation messages for the given satellite Id.
    
    Parameters:
    
    satId - satellite Id (i.e. Satellite System (e.g. R) + satellite number)
    
    Returns:
    
    an unmodifiable list of Glonass navigation messages
  - addGlonassNavigationMessage
```
public void addGlonassNavigationMessage(GLONASSNavigationMessage message)
```
    Add a Glonass navigation message to the list.
    
    Parameters:
    
    message - message to add
  - getSBASNavigationMessages
```
public Map<String,List<SBASNavigationMessage>> getSBASNavigationMessages()
```
    Get all the SBAS navigation messages contained in the file.
    
    Returns:
    
    an unmodifiable list of SBAS navigation messages
  - getSBASNavigationMessages
```
public List<SBASNavigationMessage> getSBASNavigationMessages(String satId)
```
    Get the SBAS navigation messages for the given satellite Id.
    
    Parameters:
    
    satId - satellite Id (i.e. Satellite System (e.g. S) + satellite number)
    
    Returns:
    
    an unmodifiable list of SBAS navigation messages
  - addSBASNavigationMessage
```
public void addSBASNavigationMessage(SBASNavigationMessage message)
```
    Add a SBAS navigation message to the list.
    
    Parameters:
    
    message - message to add

Class RinexNavigation

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RinexNavigation

Method Detail

getFormatVersion

setFormatVersion

getFileType

setFileType

getSatelliteSystem

setSatelliteSystem

getProgramName

setProgramName

getAgencyName

setAgencyName

getCreationDateString

setCreationDateString

getCreationTimeString

setCreationTimeString

getCreationTimeZoneString

setCreationTimeZoneString

getCreationDate

setCreationDate

getComments

addComment

getIonosphericCorrectionType

setIonosphericCorrectionType

getKlobucharAlpha

setKlobucharAlpha

getKlobucharBeta

setKlobucharBeta

getNeQuickAlpha

setNeQuickAlpha

getTimeSystemCorrections

addTimeSystemCorrections

getNumberOfLeapSeconds

setNumberOfLeapSeconds

getGPSNavigationMessages

getGPSNavigationMessages

addGPSNavigationMessage

getGalileoNavigationMessages

getGalileoNavigationMessages

addGalileoNavigationMessage

getBeidouNavigationMessages

getBeidouNavigationMessages

addBeidouNavigationMessage

getQZSSNavigationMessages

getQZSSNavigationMessages

addQZSSNavigationMessage

getIRNSSNavigationMessages

getIRNSSNavigationMessages

addIRNSSNavigationMessage

getGlonassNavigationMessages

getGlonassNavigationMessages

addGlonassNavigationMessage

getSBASNavigationMessages

getSBASNavigationMessages

addSBASNavigationMessage