CivilianNavigationMessage (OREKIT 12.0.1 API)

java.lang.Object
- org.orekit.propagation.analytical.gnss.data.CommonGnssData
- - org.orekit.propagation.analytical.gnss.data.AbstractNavigationMessage
  - - org.orekit.propagation.analytical.gnss.data.CivilianNavigationMessage

All Implemented Interfaces:

GNSSClockElements, GNSSOrbitalElements, TimeStamped

Direct Known Subclasses:

GPSCivilianNavigationMessage, QZSSCivilianNavigationMessage
```
public class CivilianNavigationMessage
extends AbstractNavigationMessage
implements GNSSClockElements
```
Container for data contained in a GPS/QZNSS civilian navigation message.

Since:

12.0

Author:

Luc Maisonobe

Field Summary

Fields
Modifier and Type Field and Description

static String CNAV
Identifier for message type.

static String CNV2
Identifier for message type.

Fields
Modifier and Type	Field and Description
`static String`	`CNAV` Identifier for message type.
`static String`	`CNV2` Identifier for message type.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`CivilianNavigationMessage(boolean cnv2, double mu, double angularVelocity, int weekNumber)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getADot()` Getter for the change rate in semi-major axis.
`double`	`getDeltaN0Dot()` Getter for change rate in Δn₀.
`double`	`getIscL1CA()` Getter for inter Signal Delay for L1 C/A.
`double`	`getIscL1CD()` Getter for inter Signal Delay for L1 CD.
`double`	`getIscL1CP()` Getter for inter Signal Delay for L1 CP.
`double`	`getIscL2C()` Getter for inter Signal Delay for L2 C.
`double`	`getIscL5I5()` Getter for inter Signal Delay for L5I.
`double`	`getIscL5Q5()` Getter for inter Signal Delay for L5Q.
`double`	`getSvAccuracy()` Getter for the user SV accuray (meters).
`int`	`getSvHealth()` Getter for the satellite health status.
`double`	`getTGD()` Getter for the Group Delay Differential (s).
`int`	`getUraiEd()` Getter for Elevation-Dependent User Range Accuracy.
`int`	`getUraiNed0()` Getter for term 0 of Non-Elevation-Dependent User Range Accuracy.
`int`	`getUraiNed1()` Getter for term 1 of Non-Elevation-Dependent User Range Accuracy.
`int`	`getUraiNed2()` Getter for term 2 of Non-Elevation-Dependent User Range Accuracy.
`boolean`	`isCnv2()` Check it message is a CNV2 message.
`void`	`setADot(double value)` Setter for the change rate in semi-major axis.
`void`	`setDeltaN0Dot(double deltaN0Dot)` Setter for change rate in Δn₀.
`void`	`setIscL1CA(double delay)` Setter for inter Signal Delay for L1 C/A.
`void`	`setIscL1CD(double delay)` Setter for inter Signal Delay for L1 CD.
`void`	`setIscL1CP(double delay)` Setter for inter Signal Delay for L1 CP.
`void`	`setIscL2C(double delay)` Setter for inter Signal Delay for L2 C.
`void`	`setIscL5I5(double delay)` Setter for inter Signal Delay for L5I.
`void`	`setIscL5Q5(double delay)` Setter for inter Signal Delay for L5Q.
`void`	`setSvAccuracy(double svAccuracy)` Setter for the user SV accuracy.
`void`	`setSvHealth(int svHealth)` Setter for the satellite health status.
`void`	`setTGD(double time)` Setter for the Group Delay Differential (s).
`void`	`setUraiEd(int uraiEd)` Setter for Elevation-Dependent User Range Accuracy.
`void`	`setUraiNed0(int uraiNed0)` Setter for term 0 of Non-Elevation-Dependent User Range Accuracy.
`void`	`setUraiNed1(int uraiNed1)` Setter for term 1 of Non-Elevation-Dependent User Range Accuracy.
`void`	`setUraiNed2(int uraiNed2)` Setter for term 2 of Non-Elevation-Dependent User Range Accuracy.

Methods inherited from class org.orekit.propagation.analytical.gnss.data.AbstractNavigationMessage
getAf2, getCic, getCis, getCrc, getCrs, getCuc, getCus, getDeltaN, getEpochToc, getIDot, getMeanMotion, getSqrtA, getTransmissionTime, setAf2, setCic, setCis, setCrc, setCrs, setCuc, setCus, setDeltaN, setEpochToc, setIDot, setSqrtA, setTransmissionTime

Methods inherited from class org.orekit.propagation.analytical.gnss.data.CommonGnssData
getAf0, getAf1, getAngularVelocity, getCycleDuration, getDate, getE, getI0, getM0, getMu, getOmega0, getOmegaDot, getPa, getPRN, getSma, getTime, getWeek, setAf0, setAf1, setDate, setE, setI0, setM0, setOmega0, setOmegaDot, setPa, setPRN, setSma, setTime, setWeek

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

Methods inherited from interface org.orekit.propagation.analytical.gnss.data.GNSSClockElements
getAf0, getAf1, getAf2, getCycleDuration, getToc

Methods inherited from interface org.orekit.time.TimeStamped
durationFrom, getDate

Methods inherited from interface org.orekit.propagation.analytical.gnss.data.GNSSOrbitalElements
getAngularVelocity, getCycleDuration, getE, getI0, getM0, getMu, getOmega0, getOmegaDot, getPa, getPRN, getPropagator, getPropagator, getPropagator, getSma, getTime, getWeek

- Field Detail
  - CNAV
```
public static final String CNAV
```
    Identifier for message type.
    
    See Also:
    
    Constant Field Values
  - CNV2
```
public static final String CNV2
```
    Identifier for message type.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CivilianNavigationMessage
```
protected CivilianNavigationMessage(boolean cnv2,
                                    double mu,
                                    double angularVelocity,
                                    int weekNumber)
```
    Constructor.
    
    Parameters:
    
    cnv2 - indicator for CNV2 messages
    
    mu - Earth's universal gravitational parameter
    
    angularVelocity - mean angular velocity of the Earth for the GNSS model
    
    weekNumber - number of weeks in the GNSS cycle
- Method Detail
  - isCnv2
```
public boolean isCnv2()
```
    Check it message is a CNV2 message.
    
    Returns:
    
    true if message is a CNV2 message
  - getADot
```
public double getADot()
```
    Getter for the change rate in semi-major axis.
    
    Returns:
    
    the change rate in semi-major axis
  - setADot
```
public void setADot(double value)
```
    Setter for the change rate in semi-major axis.
    
    Parameters:
    
    value - the change rate in semi-major axis
  - getDeltaN0Dot
```
public double getDeltaN0Dot()
```
    Getter for change rate in Δn₀.
    
    Returns:
    
    change rate in Δn₀
  - setDeltaN0Dot
```
public void setDeltaN0Dot(double deltaN0Dot)
```
    Setter for change rate in Δn₀.
    
    Parameters:
    
    deltaN0Dot - change rate in Δn₀
  - getTGD
```
public double getTGD()
```
    Getter for the Group Delay Differential (s).
    
    Specified by:
    
    getTGD in interface GNSSClockElements
    
    Returns:
    
    the Group Delay Differential in seconds
  - setTGD
```
public void setTGD(double time)
```
    Setter for the Group Delay Differential (s).
    
    Parameters:
    
    time - the group delay differential to set
  - getSvAccuracy
```
public double getSvAccuracy()
```
    Getter for the user SV accuray (meters).
    
    Returns:
    
    the user SV accuracy
  - setSvAccuracy
```
public void setSvAccuracy(double svAccuracy)
```
    Setter for the user SV accuracy.
    
    Parameters:
    
    svAccuracy - the value to set
  - getSvHealth
```
public int getSvHealth()
```
    Getter for the satellite health status.
    
    Returns:
    
    the satellite health status
  - setSvHealth
```
public void setSvHealth(int svHealth)
```
    Setter for the satellite health status.
    
    Parameters:
    
    svHealth - the value to set
  - getIscL1CA
```
public double getIscL1CA()
```
    Getter for inter Signal Delay for L1 C/A.
    
    Returns:
    
    inter signal delay
  - setIscL1CA
```
public void setIscL1CA(double delay)
```
    Setter for inter Signal Delay for L1 C/A.
    
    Parameters:
    
    delay - delay to set
  - getIscL1CD
```
public double getIscL1CD()
```
    Getter for inter Signal Delay for L1 CD.
    
    Returns:
    
    inter signal delay
  - setIscL1CD
```
public void setIscL1CD(double delay)
```
    Setter for inter Signal Delay for L1 CD.
    
    Parameters:
    
    delay - delay to set
  - getIscL1CP
```
public double getIscL1CP()
```
    Getter for inter Signal Delay for L1 CP.
    
    Returns:
    
    inter signal delay
  - setIscL1CP
```
public void setIscL1CP(double delay)
```
    Setter for inter Signal Delay for L1 CP.
    
    Parameters:
    
    delay - delay to set
  - getIscL2C
```
public double getIscL2C()
```
    Getter for inter Signal Delay for L2 C.
    
    Returns:
    
    inter signal delay
  - setIscL2C
```
public void setIscL2C(double delay)
```
    Setter for inter Signal Delay for L2 C.
    
    Parameters:
    
    delay - delay to set
  - getIscL5I5
```
public double getIscL5I5()
```
    Getter for inter Signal Delay for L5I.
    
    Returns:
    
    inter signal delay
  - setIscL5I5
```
public void setIscL5I5(double delay)
```
    Setter for inter Signal Delay for L5I.
    
    Parameters:
    
    delay - delay to set
  - getIscL5Q5
```
public double getIscL5Q5()
```
    Getter for inter Signal Delay for L5Q.
    
    Returns:
    
    inter signal delay
  - setIscL5Q5
```
public void setIscL5Q5(double delay)
```
    Setter for inter Signal Delay for L5Q.
    
    Parameters:
    
    delay - delay to set
  - getUraiEd
```
public int getUraiEd()
```
    Getter for Elevation-Dependent User Range Accuracy.
    
    Returns:
    
    Elevation-Dependent User Range Accuracy
  - setUraiEd
```
public void setUraiEd(int uraiEd)
```
    Setter for Elevation-Dependent User Range Accuracy.
    
    Parameters:
    
    uraiEd - Elevation-Dependent User Range Accuracy
  - getUraiNed0
```
public int getUraiNed0()
```
    Getter for term 0 of Non-Elevation-Dependent User Range Accuracy.
    
    Returns:
    
    term 0 of Non-Elevation-Dependent User Range Accuracy
  - setUraiNed0
```
public void setUraiNed0(int uraiNed0)
```
    Setter for term 0 of Non-Elevation-Dependent User Range Accuracy.
    
    Parameters:
    
    uraiNed0 - term 0 of Non-Elevation-Dependent User Range Accuracy
  - getUraiNed1
```
public int getUraiNed1()
```
    Getter for term 1 of Non-Elevation-Dependent User Range Accuracy.
    
    Returns:
    
    term 1 of Non-Elevation-Dependent User Range Accuracy
  - setUraiNed1
```
public void setUraiNed1(int uraiNed1)
```
    Setter for term 1 of Non-Elevation-Dependent User Range Accuracy.
    
    Parameters:
    
    uraiNed1 - term 1 of Non-Elevation-Dependent User Range Accuracy
  - getUraiNed2
```
public int getUraiNed2()
```
    Getter for term 2 of Non-Elevation-Dependent User Range Accuracy.
    
    Returns:
    
    term 2 of Non-Elevation-Dependent User Range Accuracy
  - setUraiNed2
```
public void setUraiNed2(int uraiNed2)
```
    Setter for term 2 of Non-Elevation-Dependent User Range Accuracy.
    
    Parameters:
    
    uraiNed2 - term 2 of Non-Elevation-Dependent User Range Accuracy

Class CivilianNavigationMessage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.orekit.propagation.analytical.gnss.data.AbstractNavigationMessage

Methods inherited from class org.orekit.propagation.analytical.gnss.data.CommonGnssData

Methods inherited from class java.lang.Object

Methods inherited from interface org.orekit.propagation.analytical.gnss.data.GNSSClockElements

Methods inherited from interface org.orekit.time.TimeStamped

Methods inherited from interface org.orekit.propagation.analytical.gnss.data.GNSSOrbitalElements

Field Detail

CNAV

CNV2

Constructor Detail

CivilianNavigationMessage

Method Detail

isCnv2

getADot

setADot

getDeltaN0Dot

setDeltaN0Dot

getTGD

setTGD

getSvAccuracy

setSvAccuracy

getSvHealth

setSvHealth

getIscL1CA

setIscL1CA

getIscL1CD

setIscL1CD

getIscL1CP

setIscL1CP

getIscL2C

setIscL2C

getIscL5I5

setIscL5I5

getIscL5Q5

setIscL5Q5

getUraiEd

setUraiEd

getUraiNed0

setUraiNed0

getUraiNed1

setUraiNed1

getUraiNed2

setUraiNed2