Package org.orekit.files.rinex.clock

Class RinexClockHeader

java.lang.Object

org.orekit.files.rinex.section.RinexBaseHeader

org.orekit.files.rinex.section.RinexClockObsBaseHeader

org.orekit.files.rinex.clock.RinexClockHeader

public class RinexClockHeader
extends RinexClockObsBaseHeader

Header for Rinex Clock.

Since:

14.0

Author:

Luc Maisonobe

Field Summary

Fields

Modifier and Type	Field	Description
static int	LABEL_INDEX_300_302	Index of label in header lines before 3.04.
static int	LABEL_INDEX_304_PLUS	Index of label in header lines for version 3.04 and later.

Constructor Summary

Constructors

Constructor	Description
RinexClockHeader()	Simple constructor.

Method Summary

Modifier and Type	Method	Description
void	addClockDataType(ClockDataType clockDataType)	Add a clock data types.
void	addReceiver(Receiver receiver)	Add a new receiver to the list of stored receivers.
void	addReferenceClockList(List<ReferenceClock> referenceClockList, AbsoluteDate startDate, AbsoluteDate endDate)	Add a list of reference clocks which will be used after a specified date.
void	addSatellite(SatInSystem satId)	Add a new satellite with a given identifier to the list of stored satellites.
void	addSystemObservationType(SatelliteSystem satSystem, ObservationType observationType)	Add an observation type for a specified satellite system.
void	checkType(String line, String name)	Check file type.
String	getAnalysisCenterID()	Getter for the analysis center ID.
String	getAnalysisCenterName()	Getter for the analysis center name.
List<ClockDataType>	getClockDataTypes()	Getter for the different clock data types.
String	getExternalClockReference()	Getter for the external clock reference.
Frame	getFrame()	Get the reference frame for the station positions.
String	getFrameName()	Getter for the frame name.
int	getLabelIndex()	Get the index of the header label.
int	getLeapSecondsTAI()	Get the Number of leap seconds separating UTC and TAI.
int	getNumberOfClockDataTypes()	Get the number of different clock data types in the file.
int	getNumberOfReceivers()	Get the number of receivers that are considered in the file.
int	getNumberOfSatellites()	Get the number of satellites that are considered in the file.
List<Receiver>	getReceivers()	Getter for the receivers.
TimeSpanMap<List<ReferenceClock>>	getReferenceClocks()	Getter for the reference clocks.
List<SatInSystem>	getSatellites()	Getter for the satellites.
String	getStationIdentifier()	Getter for the station identifier.
String	getStationName()	Getter for the station name.
Map<SatelliteSystem,List<ObservationType>>	getSystemObservationTypes()	Getter for the different observation type for each satellite system.
TimeScale	getTimeScale()	Get the system time scale.
TimeSystem	getTimeSystem()	Getter for the file time system.
boolean	matchFound(Label label, String line)	Check if a label is found in a line.
int	numberOfObsTypes(SatelliteSystem system)	Get the number of observation types for a given system.
void	parseProgramRunByDate(String line, TimeScales timeScales)	Parse program, run/by and date.
SatelliteSystem	parseSatelliteSystem(String line, SatelliteSystem defaultSatelliteSystem)	Parse satellite system.
void	setAnalysisCenterID(String analysisCenterID)	Setter for the analysis center ID.
void	setAnalysisCenterName(String analysisCenterName)	Setter for the analysis center name.
void	setExternalClockReference(String externalClockReference)	Setter for the external clock reference.
void	setFormatVersion(double formatVersion)	Setter for the format version.
void	setFrame(Frame frame)	Set the reference frame for the station positions.
void	setFrameName(String frameName)	Setter for the frame name.
void	setLeapSecondsTAI(int leapSecondsTAI)	Set the Number of leap seconds separating UTC and TAI.
void	setStationIdentifier(String stationIdentifier)	Setter for the station identifier.
void	setStationName(String stationName)	Setter for the station name.
void	setTimeScale(TimeScale timeScale)	Set the system time scale.
void	setTimeSystem(TimeSystem timeSystem)	Setter for the file time system.

Methods inherited from class org.orekit.files.rinex.section.RinexClockObsBaseHeader

addAppliedDCBS, addAppliedPCVS, getListAppliedDCBS, getListAppliedPCVS, getTypeObs, setTypeObs

Methods inherited from class org.orekit.files.rinex.section.RinexBaseHeader

checkType, getCreationDate, getCreationDateComponents, getCreationTimeZone, getDoi, getFileType, getFormatVersion, getLeapSecondsDayNum, getLeapSecondsFuture, getLeapSecondsGNSS, getLeapSecondsWeekNum, getLicense, getProgramName, getReceiverNumber, getReceiverType, getReceiverVersion, getRunByName, getSatelliteSystem, getStationInformation, parseProgramRunByDate, parseVersionFileTypeSatelliteSystem, setCreationDate, setCreationDateComponents, setCreationTimeZone, setDoi, setLeapSecondsDayNum, setLeapSecondsFuture, setLeapSecondsGNSS, setLeapSecondsWeekNum, setLicense, setProgramName, setReceiverNumber, setReceiverType, setReceiverVersion, setRunByName, setSatelliteSystem, setStationInformation

Methods inherited from class java.lang.Object

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

Field Detail

LABEL_INDEX_300_302

public static final int LABEL_INDEX_300_302

Index of label in header lines before 3.04.

See Also:

Constant Field Values

LABEL_INDEX_304_PLUS

public static final int LABEL_INDEX_304_PLUS

Index of label in header lines for version 3.04 and later.

See Also:

Constant Field Values

Constructor Detail

RinexClockHeader

public RinexClockHeader()

Simple constructor.

Method Detail

setFormatVersion

public void setFormatVersion(double formatVersion)

Setter for the format version.

Overrides:

setFormatVersion in class RinexBaseHeader

Parameters:

formatVersion - the format version to set

parseSatelliteSystem

public SatelliteSystem parseSatelliteSystem(String line,
                                            SatelliteSystem defaultSatelliteSystem)

Parse satellite system.

Specified by:

parseSatelliteSystem in class RinexBaseHeader

Parameters:

line - header line

defaultSatelliteSystem - satellite system to use if string is null or empty

Returns:

parsed satellite system

parseProgramRunByDate

public void parseProgramRunByDate(String line,
                                  TimeScales timeScales)

Parse program, run/by and date.

Specified by:

parseProgramRunByDate in class RinexBaseHeader

Parameters:

line - line to parse

timeScales - the set of time scales used for parsing dates

getTimeSystem

public TimeSystem getTimeSystem()

Getter for the file time system.

Returns:

the file time system

setTimeSystem

public void setTimeSystem(TimeSystem timeSystem)

Setter for the file time system.

Parameters:

timeSystem - the file time system to set

getTimeScale

public TimeScale getTimeScale()

Get the system time scale.

Returns:

system time scale

setTimeScale

public void setTimeScale(TimeScale timeScale)

Set the system time scale.

Parameters:

timeScale - system time scale

getStationName

public String getStationName()

Getter for the station name.

Returns:

the station name

setStationName

public void setStationName(String stationName)

Setter for the station name.

Parameters:

stationName - the station name to set

getStationIdentifier

public String getStationIdentifier()

Getter for the station identifier.

Returns:

the station identifier

setStationIdentifier

public void setStationIdentifier(String stationIdentifier)

Setter for the station identifier.

Parameters:

stationIdentifier - the station identifier to set

getExternalClockReference

public String getExternalClockReference()

Getter for the external clock reference.

Returns:

the external clock reference

setExternalClockReference

public void setExternalClockReference(String externalClockReference)

Setter for the external clock reference.

Parameters:

externalClockReference - the external clock reference to set

getAnalysisCenterID

public String getAnalysisCenterID()

Getter for the analysis center ID.

Returns:

the analysis center ID

setAnalysisCenterID

public void setAnalysisCenterID(String analysisCenterID)

Setter for the analysis center ID.

Parameters:

analysisCenterID - the analysis center ID to set

getAnalysisCenterName

public String getAnalysisCenterName()

Getter for the analysis center name.

Returns:

the analysis center name

setAnalysisCenterName

public void setAnalysisCenterName(String analysisCenterName)

Setter for the analysis center name.

Parameters:

analysisCenterName - the analysis center name to set

getReferenceClocks

public TimeSpanMap<List<ReferenceClock>> getReferenceClocks()

Getter for the reference clocks.

Returns:

the time span map of the different refence clocks

addReferenceClockList

public void addReferenceClockList(List<ReferenceClock> referenceClockList,
                                  AbsoluteDate startDate,
                                  AbsoluteDate endDate)

Add a list of reference clocks which will be used after a specified date. If the reference map has not been already created, it will be.

Parameters:

referenceClockList - the reference clock list

startDate - start date of list validity

endDate - end date of validity

getSystemObservationTypes

public Map<SatelliteSystem,List<ObservationType>> getSystemObservationTypes()

Getter for the different observation type for each satellite system.

Returns:

the map of the different observation type per satellite system

addSystemObservationType

public void addSystemObservationType(SatelliteSystem satSystem,
                                     ObservationType observationType)

Add an observation type for a specified satellite system.

Parameters:

satSystem - the satellite system to add observation type

observationType - the system observation type to set

numberOfObsTypes

public int numberOfObsTypes(SatelliteSystem system)

Get the number of observation types for a given system.

Parameters:

system - the satellite system to consider

Returns:

the number of observation types for a given system

getClockDataTypes

public List<ClockDataType> getClockDataTypes()

Getter for the different clock data types.

Returns:

the list of the different clock data types

addClockDataType

public void addClockDataType(ClockDataType clockDataType)

Add a clock data types.

Parameters:

clockDataType - the clock data types to add

getNumberOfClockDataTypes

public int getNumberOfClockDataTypes()

Get the number of different clock data types in the file.

Returns:

the number of different clock data types

setLeapSecondsTAI

public void setLeapSecondsTAI(int leapSecondsTAI)

Set the Number of leap seconds separating UTC and TAI.

Parameters:

leapSecondsTAI - Number of leap seconds separating UTC and TAI

getLeapSecondsTAI

public int getLeapSecondsTAI()

Get the Number of leap seconds separating UTC and TAI.

Returns:

Number of leap seconds separating UTC and TAI

getFrame

public Frame getFrame()

Get the reference frame for the station positions.

Returns:

the reference frame for station positions

setFrame

public void setFrame(Frame frame)

Set the reference frame for the station positions.

Parameters:

frame - reference frame for station positions

getFrameName

public String getFrameName()

Getter for the frame name.

Returns:

the frame name

setFrameName

public void setFrameName(String frameName)

Setter for the frame name.

Parameters:

frameName - the frame name to set

addSatellite

public void addSatellite(SatInSystem satId)

Add a new satellite with a given identifier to the list of stored satellites.

Parameters:

satId - the satellite identifier

addReceiver

public void addReceiver(Receiver receiver)

Add a new receiver to the list of stored receivers.

Parameters:

receiver - the receiver

getNumberOfReceivers

public int getNumberOfReceivers()

Get the number of receivers that are considered in the file.

Returns:

the number of receivers that are considered in the file

getNumberOfSatellites

public int getNumberOfSatellites()

Get the number of satellites that are considered in the file.

Returns:

the number of satellites that are considered in the file

getReceivers

public List<Receiver> getReceivers()

Getter for the receivers.

Returns:

the list of the receivers

getSatellites

public List<SatInSystem> getSatellites()

Getter for the satellites.

Returns:

the list of the satellites

checkType

public void checkType(String line,
                      String name)

Check file type.

Specified by:

checkType in class RinexBaseHeader

Parameters:

line - header line

name - file name (for error message)

getLabelIndex

public int getLabelIndex()

Get the index of the header label.

Specified by:

getLabelIndex in class RinexBaseHeader

Returns:

index of the header label

matchFound

public boolean matchFound(Label label,
                          String line)

Check if a label is found in a line.

Specified by:

matchFound in class RinexBaseHeader

Parameters:

label - label to check

line - header line

Returns:

true if label is found in the header line