org.orekit.gnss

Class GPSAlmanac

java.lang.Object

org.orekit.gnss.GPSAlmanac

All Implemented Interfaces:

GNSSOrbitalElements, GPSOrbitalElements, TimeStamped

public class GPSAlmanac
extends Object
implements GPSOrbitalElements

This class holds a GPS almanac as read from SEM or YUMA files.

Depending on the source (SEM or YUMA), some fields may be filled in or not. An almanac read from a YUMA file doesn't hold SVN number, average URA and satellite configuration.

Since:

8.0

Author:

Pascal Parraud

Field Summary

Fields inherited from interface org.orekit.propagation.analytical.gnss.GPSOrbitalElements

GPS_MU, GPS_PI, GPS_WEEK_IN_SECONDS, GPS_WEEK_NB

Constructor Summary

Constructors

Constructor and Description
GPSAlmanac(String source, int prn, int svn, int week, double toa, double sqa, double ecc, double inc, double om0, double dom, double aop, double anom, double af0, double af1, int health, int ura, int config) Constructor.
GPSAlmanac(String source, int prn, int svn, int week, double toa, double sqa, double ecc, double inc, double om0, double dom, double aop, double anom, double af0, double af1, int health, int ura, int config, AbsoluteDate date) Constructor.

Method Summary

Modifier and Type	Method and Description
double	getAf0() Gets the Zeroth Order Clock Correction.
double	getAf1() Gets the First Order Clock Correction.
double	getCic() Gets the Amplitude of the Cosine Harmonic Correction Term to the Angle of Inclination.
double	getCis() Gets the Amplitude of the Sine Harmonic Correction Term to the Angle of Inclination.
double	getCrc() Gets the Amplitude of the Cosine Harmonic Correction Term to the Orbit Radius.
double	getCrs() Gets the Amplitude of the Sine Harmonic Correction Term to the Orbit Radius.
double	getCuc() Gets the Amplitude of the Cosine Harmonic Correction Term to the Argument of Latitude.
double	getCus() Gets the Amplitude of the Sine Harmonic Correction Term to the Argument of Latitude.
AbsoluteDate	getDate() Get the date.
double	getE() Gets the Eccentricity.
int	getHealth() Gets the Health status.
double	getI0() Gets the Inclination Angle at Reference Time.
double	getIDot() Gets the Rate of Inclination Angle.
double	getM0() Gets the Mean Anomaly at Reference Time.
double	getMeanMotion() Gets the Mean Motion.
double	getOmega0() Gets the Longitude of Ascending Node of Orbit Plane at Weekly Epoch.
double	getOmegaDot() Gets the Rate of Right Ascension.
double	getPa() Gets the Argument of Perigee.
int	getPRN() Gets the PRN number of the GNSS satellite.
int	getSatConfiguration() Gets the satellite configuration.
double	getSma() Gets the Semi-Major Axis.
String	getSource() Gets the source of this GPS almanac.
int	getSVN() Gets the satellite "SVN" reference number.
double	getTime() Gets the Reference Time of the GNSS orbit as a duration from week start.
int	getURA() Gets the average URA number.
int	getWeek() Gets the Reference Week of the GNSS orbit.

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.GPSOrbitalElements

getIODC, getIODE, getTGD

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

getAf2, getToc

Constructor Detail

GPSAlmanac

@DefaultDataContext
public GPSAlmanac(String source,
                                      int prn,
                                      int svn,
                                      int week,
                                      double toa,
                                      double sqa,
                                      double ecc,
                                      double inc,
                                      double om0,
                                      double dom,
                                      double aop,
                                      double anom,
                                      double af0,
                                      double af1,
                                      int health,
                                      int ura,
                                      int config)

Constructor.

This method uses the default data context.

Parameters:

source - the source of the almanac (SEM, YUMA, user defined)

prn - the PRN number

svn - the SVN number

week - the GPS week

toa - the Time of Applicability

sqa - the Square Root of Semi-Major Axis (m^1/2)

ecc - the eccentricity

inc - the inclination (rad)

om0 - the geographic longitude of the orbital plane at the weekly epoch (rad)

dom - the Rate of Right Ascension (rad/s)

aop - the Argument of Perigee (rad)

anom - the Mean Anomaly (rad)

af0 - the Zeroth Order Clock Correction (s)

af1 - the First Order Clock Correction (s/s)

health - the Health status

ura - the average URA

config - the satellite configuration

See Also:

GPSAlmanac(String, int, int, int, double, double, double, double, double, double, double, double, double, double, int, int, int, AbsoluteDate)

GPSAlmanac

public GPSAlmanac(String source,
                  int prn,
                  int svn,
                  int week,
                  double toa,
                  double sqa,
                  double ecc,
                  double inc,
                  double om0,
                  double dom,
                  double aop,
                  double anom,
                  double af0,
                  double af1,
                  int health,
                  int ura,
                  int config,
                  AbsoluteDate date)

Constructor.

Parameters:

source - the source of the almanac (SEM, YUMA, user defined)

prn - the PRN number

svn - the SVN number

week - the GPS week

toa - the Time of Applicability

sqa - the Square Root of Semi-Major Axis (m^1/2)

ecc - the eccentricity

inc - the inclination (rad)

om0 - the geographic longitude of the orbital plane at the weekly epoch (rad)

dom - the Rate of Right Ascension (rad/s)

aop - the Argument of Perigee (rad)

anom - the Mean Anomaly (rad)

af0 - the Zeroth Order Clock Correction (s)

af1 - the First Order Clock Correction (s/s)

health - the Health status

ura - the average URA

config - the satellite configuration

date - built from the week and toa: new GNSSDate(week, toa * 1000., SatelliteSystem.GPS, timeScales).getDate()

Since:

10.1

Method Detail

getDate

public AbsoluteDate getDate()

Description copied from interface: TimeStamped

Get the date.

Specified by:

getDate in interface TimeStamped

Returns:

date attached to the object

getSource

public String getSource()

Gets the source of this GPS almanac.

Sources can be SEM or YUMA, when the almanac is read from a file.

Returns:

the source of this GPS almanac

getPRN

public int getPRN()

Description copied from interface: GNSSOrbitalElements

Gets the PRN number of the GNSS satellite.

Specified by:

getPRN in interface GNSSOrbitalElements

Returns:

the PRN number of the GNSS satellite

getSVN

public int getSVN()

Gets the satellite "SVN" reference number.

Returns:

the satellite "SVN" reference number

getWeek

public int getWeek()

Description copied from interface: GNSSOrbitalElements

Gets the Reference Week of the GNSS orbit.

Specified by:

getWeek in interface GNSSOrbitalElements

Returns:

the Reference Week of the GNSS orbit within [0, 1024[

getTime

public double getTime()

Description copied from interface: GNSSOrbitalElements

Gets the Reference Time of the GNSS orbit as a duration from week start.

Specified by:

getTime in interface GNSSOrbitalElements

Returns:

the Reference Time of the GNSS orbit (s)

getSma

public double getSma()

Description copied from interface: GNSSOrbitalElements

Gets the Semi-Major Axis.

Specified by:

getSma in interface GNSSOrbitalElements

Returns:

the Semi-Major Axis (m)

getMeanMotion

public double getMeanMotion()

Description copied from interface: GNSSOrbitalElements

Gets the Mean Motion.

Specified by:

getMeanMotion in interface GNSSOrbitalElements

Returns:

the Mean Motion (rad/s)

getE

public double getE()

Description copied from interface: GNSSOrbitalElements

Gets the Eccentricity.

Specified by:

getE in interface GNSSOrbitalElements

Returns:

the Eccentricity

getI0

public double getI0()

Description copied from interface: GNSSOrbitalElements

Gets the Inclination Angle at Reference Time.

Specified by:

getI0 in interface GNSSOrbitalElements

Returns:

the Inclination Angle at Reference Time (rad)

getIDot

public double getIDot()

Description copied from interface: GNSSOrbitalElements

Gets the Rate of Inclination Angle.

Specified by:

getIDot in interface GNSSOrbitalElements

Returns:

the Rate of Inclination Angle (rad/s)

getOmega0

public double getOmega0()

Description copied from interface: GNSSOrbitalElements

Gets the Longitude of Ascending Node of Orbit Plane at Weekly Epoch.

Specified by:

getOmega0 in interface GNSSOrbitalElements

Returns:

the Longitude of Ascending Node of Orbit Plane at Weekly Epoch (rad)

getOmegaDot

public double getOmegaDot()

Description copied from interface: GNSSOrbitalElements

Gets the Rate of Right Ascension.

Specified by:

getOmegaDot in interface GNSSOrbitalElements

Returns:

the Rate of Right Ascension (rad/s)

getPa

public double getPa()

Description copied from interface: GNSSOrbitalElements

Gets the Argument of Perigee.

Specified by:

getPa in interface GNSSOrbitalElements

Returns:

the Argument of Perigee (rad)

getM0

public double getM0()

Description copied from interface: GNSSOrbitalElements

Gets the Mean Anomaly at Reference Time.

Specified by:

getM0 in interface GNSSOrbitalElements

Returns:

the Mean Anomaly at Reference Time (rad)

getCuc

public double getCuc()

Description copied from interface: GNSSOrbitalElements

Gets the Amplitude of the Cosine Harmonic Correction Term to the Argument of Latitude.

Specified by:

getCuc in interface GNSSOrbitalElements

Returns:

the Amplitude of the Cosine Harmonic Correction Term to the Argument of Latitude (rad)

getCus

public double getCus()

Description copied from interface: GNSSOrbitalElements

Gets the Amplitude of the Sine Harmonic Correction Term to the Argument of Latitude.

Specified by:

getCus in interface GNSSOrbitalElements

Returns:

the Amplitude of the Sine Harmonic Correction Term to the Argument of Latitude (rad)

getCrc

public double getCrc()

Description copied from interface: GNSSOrbitalElements

Gets the Amplitude of the Cosine Harmonic Correction Term to the Orbit Radius.

Specified by:

getCrc in interface GNSSOrbitalElements

Returns:

the Amplitude of the Cosine Harmonic Correction Term to the Orbit Radius (m)

getCrs

public double getCrs()

Description copied from interface: GNSSOrbitalElements

Gets the Amplitude of the Sine Harmonic Correction Term to the Orbit Radius.

Specified by:

getCrs in interface GNSSOrbitalElements

Returns:

the Amplitude of the Sine Harmonic Correction Term to the Orbit Radius (m)

getCic

public double getCic()

Description copied from interface: GNSSOrbitalElements

Gets the Amplitude of the Cosine Harmonic Correction Term to the Angle of Inclination.

Specified by:

getCic in interface GNSSOrbitalElements

Returns:

the Amplitude of the Cosine Harmonic Correction Term to the Angle of Inclination (rad)

getCis

public double getCis()

Description copied from interface: GNSSOrbitalElements

Gets the Amplitude of the Sine Harmonic Correction Term to the Angle of Inclination.

Specified by:

getCis in interface GNSSOrbitalElements

Returns:

the Amplitude of the Sine Harmonic Correction Term to the Angle of Inclination (rad)

getAf0

public double getAf0()

Description copied from interface: GNSSOrbitalElements

Gets the Zeroth Order Clock Correction.

Specified by:

getAf0 in interface GNSSOrbitalElements

Returns:

the Zeroth Order Clock Correction (s)

See Also:

GNSSOrbitalElements.getAf1(), GNSSOrbitalElements.getAf2(), GNSSOrbitalElements.getToc()

getAf1

public double getAf1()

Description copied from interface: GNSSOrbitalElements

Gets the First Order Clock Correction.

Specified by:

getAf1 in interface GNSSOrbitalElements

Returns:

the First Order Clock Correction (s/s)

See Also:

GNSSOrbitalElements.getAf0(), GNSSOrbitalElements.getAf2(), GNSSOrbitalElements.getToc()

getHealth

public int getHealth()

Gets the Health status.

Returns:

the Health status

getURA

public int getURA()

Gets the average URA number.

Returns:

the average URA number

getSatConfiguration

public int getSatConfiguration()

Gets the satellite configuration.

Returns:

the satellite configuration