Package org.orekit.gnss.metric.messages.rtcm.ephemeris

Class Rtcm1020Data

java.lang.Object

org.orekit.gnss.metric.messages.rtcm.RtcmData

org.orekit.gnss.metric.messages.rtcm.ephemeris.RtcmEphemerisData

org.orekit.gnss.metric.messages.rtcm.ephemeris.Rtcm1020Data

public class Rtcm1020Data
extends RtcmEphemerisData

Container for RTCM 1020 data.

Spacecraft coordinates read from this RTCM message are given in PZ-90.02 frame.

Since:

11.0

Author:

Bryan Cazabonne

Constructor Summary

Constructors

Constructor	Description
Rtcm1020Data()	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	areAdditionalDataAvailable()	Get the flag indicating if additional parameters are in the message.
int	getBN()	Get the GLONASS Bn Word.
double	getDeltaTN()	Get the deltaTauN value.
int	getEn()	Get the GLONASS En Word.
int	getFT()	Get the GLONASS FT Word.
GLONASSFdmaNavigationMessage	getGlonassNavigationMessage()	Get the Glonass navigation message corresponding to the current RTCM data.
GLONASSFdmaNavigationMessage	getGlonassNavigationMessage(TimeScales timeScales)	Get the Glonass navigation message corresponding to the current RTCM data.
int	getLNFifthString()	Get the GLONASS ln Word extracted from fifth string of the subframe.
int	getLNThirdString()	Get the GLONASS ln Word extracted from third string of the subframe.
int	getM()	Get the GLONASS M Word.
int	getN4()	Get the four-year interval number starting from 1996.
int	getNA()	Get the GLONASS NA Word.
int	getNt()	Get the current date.
int	getP()	Get the GLONASS P Word.
int	getP1()	Get the GLONASS P1 Word.
int	getP2()	Get the GLONASS P2 Word.
int	getP3()	Get the GLONASS P3 Word.
int	getP4()	Get the GLONASS P4 Word.
double	getTauC()	Get the GLONASS time scale correction to UTC time.
double	getTauGps()	Get the correction to GPS time relative to GLONASS time.
double	getTk()	Get the time referenced to the beginning of the frame within the current day.
boolean	isHealthAvailable()	Get the flag indicating if GLONASS almanac health is available.
void	setAreAdditionalDataAvailable(boolean areAdditionalDataAvailable)	Set the flag indicating if additional parameters are in the message.
void	setBN(int word)	Set the GLONASS Bn Word.
void	setDeltaTN(double deltaTN)	Set the deltaTauN value.
void	setEn(int word)	Get the GLONASS En Word.
void	setFT(int word)	Set the GLONASS FT Word.
void	setGlonassNavigationMessage(GLONASSFdmaNavigationMessage glonassNavigationMessage)	Set the Glonass navigation message.
void	setHealthAvailabilityIndicator(boolean healthAvailabilityIndicator)	Set the flag indicating if GLONASS almanac health is available.
void	setLNFifthString(int word)	Set the GLONASS ln Word extracted from fifth string of the subframe.
void	setLNThirdString(int word)	Set the GLONASS ln Word extracted from third string of the subframe.
void	setM(int m)	Set the GLONASS M Word.
void	setN4(int n4)	Set the four-year interval number starting from 1996.
void	setNA(int word)	Set the GLONASS NA Word.
void	setNt(int nt)	Set the current date.
void	setP(int p)	Set the GLONASS P Word.
void	setP1(int p1)	Set the GLONASS P1 Word.
void	setP2(int p2)	Set the GLONASS P2 Word.
void	setP3(int p3)	Set the the GLONASS P3 Word.
void	setP4(int p4)	Set the GLONASS P4 Word.
void	setTauC(double tauC)	Set the GLONASS time scale correction to UTC time.
void	setTauGps(double tauGps)	Set the correction to GPS time relative to GLONASS time.
void	setTk(double tk)	Set the time referenced to the beginning of the frame within the current day.

Methods inherited from class org.orekit.gnss.metric.messages.rtcm.ephemeris.RtcmEphemerisData

getAccuracyProvider, getSatelliteID, setAccuracyProvider, setSatelliteID

Methods inherited from class java.lang.Object

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

Constructor Details

Rtcm1020Data

public Rtcm1020Data()

Constructor.

Method Details

getGlonassNavigationMessage

@DefaultDataContext
public GLONASSFdmaNavigationMessage getGlonassNavigationMessage()

Get the Glonass navigation message corresponding to the current RTCM data.

This object can be used to initialize a GLONASSNumericalPropagator

This method uses the DataContext.getDefault() to initialize the time scales used to configure the reference epochs of the navigation message.

Returns:

the Glonass navigation message

getGlonassNavigationMessage

public GLONASSFdmaNavigationMessage getGlonassNavigationMessage(TimeScales timeScales)

Get the Glonass navigation message corresponding to the current RTCM data.

This object can be used to initialize a GLONASSNumericalPropagator

When calling this method, the reference epochs of the navigation message (i.e. ephemeris and clock epochs) are initialized using the provided time scales.

Parameters:

timeScales - time scales to use for initializing epochs

Returns:

the Glonass navigation message

setGlonassNavigationMessage

public void setGlonassNavigationMessage(GLONASSFdmaNavigationMessage glonassNavigationMessage)

Set the Glonass navigation message.

Parameters:

glonassNavigationMessage - the Glonass navigation message to set

getN4

public int getN4()

Get the four-year interval number starting from 1996.

Returns:

the four-year interval number starting from 1996

setN4

public void setN4(int n4)

Set the four-year interval number starting from 1996.

Parameters:

n4 - the number to set

getNt

public int getNt()

Get the current date.

Current date is a calendar number of day within four-year interval starting from the 1-st of January in a leap year

Returns:

the current date

setNt

public void setNt(int nt)

Set the current date.

Parameters:

nt - the current date to set

isHealthAvailable

public boolean isHealthAvailable()

Get the flag indicating if GLONASS almanac health is available.

Returns:

true if GLONASS almanac health is available

setHealthAvailabilityIndicator

public void setHealthAvailabilityIndicator(boolean healthAvailabilityIndicator)

Set the flag indicating if GLONASS almanac health is available.

Parameters:

healthAvailabilityIndicator - true if GLONASS almanac health is available

getP1

public int getP1()

Get the GLONASS P1 Word.

Word P1 is a flag of the immediate data updating. It indicates a time interval between two adjacent values of tb parameter (in seconds).

Returns:

the GLONASS P1 Word

setP1

public void setP1(int p1)

Set the GLONASS P1 Word.

Parameters:

p1 - the GLONASS P1 Word to set

getTk

public double getTk()

Get the time referenced to the beginning of the frame within the current day.

Returns:

the time in seconds

setTk

public void setTk(double tk)

Set the time referenced to the beginning of the frame within the current day.

Parameters:

tk - the time to set in seconds

getBN

public int getBN()

Get the GLONASS B_n Word.

Word B_n is the health flag

Returns:

the GLONASS B_n Word

setBN

public void setBN(int word)

Set the GLONASS B_n Word.

Parameters:

word - the word to set

getP2

public int getP2()

Get the GLONASS P2 Word.

Word P2 is flag of oddness ("1") or evenness ("0") of the value of tb.

Returns:

the GLONASS P2 Word

setP2

public void setP2(int p2)

Set the GLONASS P2 Word.

Parameters:

p2 - the GLONASS P2 Word to set

getP3

public int getP3()

Get the GLONASS P3 Word.

Word P3 is flag indicating a number of satellites for which almanac is transmitted within given frame

Returns:

the GLONASS P3 Word

setP3

public void setP3(int p3)

Set the the GLONASS P3 Word.

Parameters:

p3 - the GLONASS P3 Word to set

getP

public int getP()

Get the GLONASS P Word.

Word P is a technological parameter of control segment, indication the satellite operation mode in respect of time parameters.

Returns:

the GLONASS P Word

setP

public void setP(int p)

Set the GLONASS P Word.

Parameters:

p - the GLONASS P Word to set

getLNThirdString

public int getLNThirdString()

Get the GLONASS l_n Word extracted from third string of the subframe.

Returns:

the GLONASS l_n (third string)

setLNThirdString

public void setLNThirdString(int word)

Set the GLONASS l_n Word extracted from third string of the subframe.

Parameters:

word - the word to set

getDeltaTN

public double getDeltaTN()

Get the deltaTauN value.

It represents the GLONASS time difference between navigation RF signal transmitted in L2 sub-band and navigation RF signal transmitted in L1 sub-band.

Returns:

deltaTauN

setDeltaTN

public void setDeltaTN(double deltaTN)

Set the deltaTauN value.

Parameters:

deltaTN - the value to set

getEn

public int getEn()

Get the GLONASS E_n Word.

It characterises the "age" of a current information.

Returns:

the GLONASS E_n Word in days

setEn

public void setEn(int word)

Get the GLONASS E_n Word.

Parameters:

word - the word to set

getP4

public int getP4()

Get the GLONASS P4 Word.

GLONASS P4 Word is a flag to show that ephemeris parameters are present. "1" indicates that updated ephemeris or frequency/time parameters have been uploaded by the control segment

Returns:

the GLONASS P4 Word

setP4

public void setP4(int p4)

Set the GLONASS P4 Word.

Parameters:

p4 - the GLONASS P4 Word to set

getFT

public int getFT()

Get the GLONASS F_T Word.

It is a parameter that provides the predicted satellite user range accuracy at time tb.

Returns:

the GLONASS F_T Word

setFT

public void setFT(int word)

Set the GLONASS F_T Word.

Parameters:

word - the word to set

getM

public int getM()

Get the GLONASS M Word.

Word M represents the type of satellite transmitting navigation signal. "0" refers to GLONASS satellite, "1" refers to a GLONASS-M satellite.

Returns:

the GLONASS M Word

setM

public void setM(int m)

Set the GLONASS M Word.

Parameters:

m - the GLONASS M Word to set

areAdditionalDataAvailable

public boolean areAdditionalDataAvailable()

Get the flag indicating if additional parameters are in the message.

Returns:

true if additional parameters are in the message

setAreAdditionalDataAvailable

public void setAreAdditionalDataAvailable(boolean areAdditionalDataAvailable)

Set the flag indicating if additional parameters are in the message.

Parameters:

areAdditionalDataAvailable - true if additional parameters are in the message

getNA

public int getNA()

Get the GLONASS N^A Word.

It is the calendar day number within the four-year period beginning since the leap year. It is used for almanac data.

Returns:

the GLONASS N^A Word

setNA

public void setNA(int word)

Set the GLONASS N^A Word.

Parameters:

word - the word to set

getTauC

public double getTauC()

Get the GLONASS time scale correction to UTC time.

Returns:

the GLONASS time scale correction to UTC time in seconds

setTauC

public void setTauC(double tauC)

Set the GLONASS time scale correction to UTC time.

Parameters:

tauC - the value to set in seconds.

getTauGps

public double getTauGps()

Get the correction to GPS time relative to GLONASS time.

Returns:

the correction to GPS time relative to GLONASS time in seconds

setTauGps

public void setTauGps(double tauGps)

Set the correction to GPS time relative to GLONASS time.

Parameters:

tauGps - the value to set in seconds

getLNFifthString

public int getLNFifthString()

Get the GLONASS l_n Word extracted from fifth string of the subframe.

Returns:

the GLONASS l_n (fifth string)

setLNFifthString

public void setLNFifthString(int word)

Set the GLONASS l_n Word extracted from fifth string of the subframe.

Parameters:

word - the word to set