RinexObservationHeader | DME Component Libraries for Java 2024 r3

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

```
public class RinexObservationHeader
extends Object
```
This class contains information from the header of the RINEX observation file. Since the header is subject to change throughout the file, an instance of this class will be held by each RinexObservationRecord in the file, with the header being populated with the valid information up to that point in time.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAgency()` Gets the Agency property for the RINEX header
`double`	`getAntennaDeltaE()` Gets the value of the antenna delta E for the RINEX observation file.
`double`	`getAntennaDeltaH()` Gets the value of the antenna delta H for the RINEX observation file.
`double`	`getAntennaDeltaN()` Gets the value of the antenna delta N for the RINEX observation file.
`String`	`getAntennaNumber()` Gets the antenna number property for the RINEX header.
`String`	`getAntennaType()` Gets the antenna type property for the RINEX header.
`double`	`getApproximateMarkerPositionX()` Gets the X value of the approximate marker position for the RINEX observation file.
`double`	`getApproximateMarkerPositionY()` Gets the Y value of the approximate marker position for the RINEX observation file.
`double`	`getApproximateMarkerPositionZ()` Gets the Z value of the approximate marker position for the RINEX observation file.
`String`	`getDate()` Gets the Date property for the RINEX header
`RinexObservationSatRecord`	`getDefaultSatellite()` Gets the default satellite property for the RINEX header.
`double`	`getInterval()` Gets the Interval property for the RINEX header.
`int`	`getLeapSeconds()` Gets the leap seconds property for the RINEX header.
`String`	`getMarkerName()` Gets the marker name for the RINEX observation file.
`String`	`getMarkerNumber()` Gets the marker number for the RINEX observation file.
`int`	`getNumberOfSatellites()` Gets the number of satellites property for the RINEX header.
`char`	`getObservationCharacter()` Gets the observation character property for the RINEX header.
`String`	`getObserver()` Gets the Observer property for the RINEX header
`String`	`getProgram()` Gets the program property for the RINEX header.
`int`	`getReceiverClockOffset()` Gets the receiver clock offset property for the RINEX header.
`String`	`getReceiverNumber()` Gets the receiver number property for the RINEX header.
`String`	`getReceiverType()` Gets the receiver type property for the RINEX header.
`String`	`getReceiverVersion()` Gets the receiver version property for the RINEX header.
`String`	`getRunBy()` Gets the RunBy property for the RINEX header.
`RinexObservationSatRecord`	`getSatelliteRecord(int prn)` Get the header record for this satellite.
`RinexObservationSatRecord`	`getSatelliteRecord(int prn, boolean returnCopy)` Get the header record for this satellite.
`char`	`getSatelliteSystemCharacter()` Gets the satellite system character property for the RINEX header.
`JulianDate`	`getTimeOfFirstObservation()` Gets the time of first observation property for the RINEX header.
`JulianDate`	`getTimeOfLastObservation()` Gets the time of last observation property for the RINEX header.
`TimeStandard`	`getTimeStandard()` Gets the time standard property for the RINEX header.
`double`	`getVersion()` Gets the Version property for the RINEX header.
`void`	`readHeader(BufferedReader reader)` Parse the header of a RINEX observation file.

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

- Method Detail
  - readHeader
```
public final void readHeader(BufferedReader reader)
```
    Parse the header of a RINEX observation file.
    
    Parameters:
    
    reader - A reader pointing to the beginning of a RINEX observation file.
    
    Throws:
    
    InvalidDataException - Thrown when any of the required fields in the header are missing, or invalid information is defined for these fields.
  - getSatelliteRecord
```
public final RinexObservationSatRecord getSatelliteRecord(int prn)
```
    Get the header record for this satellite. If none exists, a default record will be returned.
    
    Parameters:
    
    prn - The PRN of the satellite.
    
    Returns:
    
    A header record for this satellite, or blank if the PRN doesn't exist.
  - getSatelliteRecord
```
@Nonnull
public final RinexObservationSatRecord getSatelliteRecord(int prn,
                                                                    boolean returnCopy)
```
    Get the header record for this satellite. If none exists, a default record will be returned.
    
    Parameters:
    
    prn - The PRN of the satellite.
    
    returnCopy - Whether to return a copy of the satellite object, or a reference to the original object.
    
    Returns:
    
    A header record for this satellite, or blank if the PRN doesn't exist.
  - getMarkerName
```
public final String getMarkerName()
```
    Gets the marker name for the RINEX observation file.
  - getMarkerNumber
```
public final String getMarkerNumber()
```
    Gets the marker number for the RINEX observation file.
  - getAntennaDeltaH
```
public final double getAntennaDeltaH()
```
    Gets the value of the antenna delta H for the RINEX observation file.
  - getAntennaDeltaE
```
public final double getAntennaDeltaE()
```
    Gets the value of the antenna delta E for the RINEX observation file.
  - getAntennaDeltaN
```
public final double getAntennaDeltaN()
```
    Gets the value of the antenna delta N for the RINEX observation file.
  - getApproximateMarkerPositionX
```
public final double getApproximateMarkerPositionX()
```
    Gets the X value of the approximate marker position for the RINEX observation file.
  - getApproximateMarkerPositionY
```
public final double getApproximateMarkerPositionY()
```
    Gets the Y value of the approximate marker position for the RINEX observation file.
  - getApproximateMarkerPositionZ
```
public final double getApproximateMarkerPositionZ()
```
    Gets the Z value of the approximate marker position for the RINEX observation file.
  - getVersion
```
public final double getVersion()
```
    Gets the Version property for the RINEX header.
  - getSatelliteSystemCharacter
```
public final char getSatelliteSystemCharacter()
```
    Gets the satellite system character property for the RINEX header.
  - getObservationCharacter
```
public final char getObservationCharacter()
```
    Gets the observation character property for the RINEX header.
  - getProgram
```
public final String getProgram()
```
    Gets the program property for the RINEX header.
  - getRunBy
```
public final String getRunBy()
```
    Gets the RunBy property for the RINEX header.
  - getDate
```
public final String getDate()
```
    Gets the Date property for the RINEX header
    Since there is no definition in the RINEX specification defining the formatting of this date, the date is returned as a string.
  - getObserver
```
public final String getObserver()
```
    Gets the Observer property for the RINEX header
  - getAgency
```
public final String getAgency()
```
    Gets the Agency property for the RINEX header
  - getReceiverNumber
```
public final String getReceiverNumber()
```
    Gets the receiver number property for the RINEX header.
  - getReceiverType
```
public final String getReceiverType()
```
    Gets the receiver type property for the RINEX header.
  - getReceiverVersion
```
public final String getReceiverVersion()
```
    Gets the receiver version property for the RINEX header.
  - getAntennaNumber
```
public final String getAntennaNumber()
```
    Gets the antenna number property for the RINEX header.
  - getAntennaType
```
public final String getAntennaType()
```
    Gets the antenna type property for the RINEX header.
  - getInterval
```
public final double getInterval()
```
    Gets the Interval property for the RINEX header.
  - getReceiverClockOffset
```
public final int getReceiverClockOffset()
```
    Gets the receiver clock offset property for the RINEX header.
  - getLeapSeconds
```
public final int getLeapSeconds()
```
    Gets the leap seconds property for the RINEX header.
  - getNumberOfSatellites
```
public final int getNumberOfSatellites()
```
    Gets the number of satellites property for the RINEX header.
  - getTimeOfFirstObservation
```
@Nonnull
public final JulianDate getTimeOfFirstObservation()
```
    Gets the time of first observation property for the RINEX header.
  - getTimeOfLastObservation
```
@Nonnull
public final JulianDate getTimeOfLastObservation()
```
    Gets the time of last observation property for the RINEX header.
  - getDefaultSatellite
```
public final RinexObservationSatRecord getDefaultSatellite()
```
    Gets the default satellite property for the RINEX header.
  - getTimeStandard
```
public final TimeStandard getTimeStandard()
```
    Gets the time standard property for the RINEX header.

Class RinexObservationHeader

Method Summary

Methods inherited from class java.lang.Object

Method Detail

readHeader

getSatelliteRecord

getSatelliteRecord

getMarkerName

getMarkerNumber

getAntennaDeltaH

getAntennaDeltaE

getAntennaDeltaN

getApproximateMarkerPositionX

getApproximateMarkerPositionY

getApproximateMarkerPositionZ

getVersion

getSatelliteSystemCharacter

getObservationCharacter

getProgram

getRunBy

getDate

getObserver

getAgency

getReceiverNumber

getReceiverType

getReceiverVersion

getAntennaNumber

getAntennaType

getInterval

getReceiverClockOffset

getLeapSeconds

getNumberOfSatellites

getTimeOfFirstObservation

getTimeOfLastObservation

getDefaultSatellite

getTimeStandard