Package org.orekit.gnss

Enum PredefinedTimeSystem

java.lang.Object

java.lang.Enum<PredefinedTimeSystem>

org.orekit.gnss.PredefinedTimeSystem

All Implemented Interfaces:

Serializable, Comparable<PredefinedTimeSystem>, TimeSystem

public enum PredefinedTimeSystem
extends Enum<PredefinedTimeSystem>
implements TimeSystem

Enumerate for the time systems used in navigation files.

Since:

11.0

Author:

Thomas Neidhart, Evan Ward, Thomas Paulet

Enum Constant Summary

Enum Constants

Enum Constant	Description
BEIDOU	Beidou.
GALILEO	GALILEO.
GLONASS	GLONASS.
GMT	GMT (should only be used in RUN BY / DATE entries).
GPS	Global Positioning System.
NAVIC	NavIC.
QZSS	Quasi-Zenith System.
SBAS	SBAS.
TAI	International Atomic Time.
UNKNOWN	Unknown (should only be used in RUN BY / DATE entries).
UTC	Coordinated Universal Time.

Method Summary

Modifier and Type	Method	Description
String	getKey()	Get the 3 letters key of the time system.
String	getOneLetterCode()	Get the one letter code.
TimeScale	getTimeScale(TimeScales timeScales)	Get the time scale corresponding to time system.
String	getTwoLettersCode()	Get the two letters code.
static PredefinedTimeSystem	parseOneLetterCode(String code)	Parse a string to get the time system.
static PredefinedTimeSystem	parseTimeSystem(String s)	Parse a string to get the time system.
static PredefinedTimeSystem	parseTwoLettersCode(String code)	Parse a string to get the time system.
static PredefinedTimeSystem	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PredefinedTimeSystem[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GPS

public static final PredefinedTimeSystem GPS

Global Positioning System.

GLONASS

public static final PredefinedTimeSystem GLONASS

GLONASS.

GALILEO

public static final PredefinedTimeSystem GALILEO

GALILEO.

TAI

public static final PredefinedTimeSystem TAI

International Atomic Time.

UTC

public static final PredefinedTimeSystem UTC

Coordinated Universal Time.

QZSS

public static final PredefinedTimeSystem QZSS

Quasi-Zenith System.

BEIDOU

public static final PredefinedTimeSystem BEIDOU

Beidou.

NAVIC

public static final PredefinedTimeSystem NAVIC

NavIC.

SBAS

public static final PredefinedTimeSystem SBAS

SBAS.

Since:

12.0

GMT

public static final PredefinedTimeSystem GMT

GMT (should only be used in RUN BY / DATE entries).

Since:

12.0

UNKNOWN

public static final PredefinedTimeSystem UNKNOWN

Unknown (should only be used in RUN BY / DATE entries).

Method Detail

values

public static PredefinedTimeSystem[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PredefinedTimeSystem c : PredefinedTimeSystem.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PredefinedTimeSystem valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getKey

public String getKey()

Get the 3 letters key of the time system.

Specified by:

getKey in interface TimeSystem

Returns:

3 letters key

getTwoLettersCode

public String getTwoLettersCode()

Get the two letters code.

Specified by:

getTwoLettersCode in interface TimeSystem

Returns:

two letters code (may be null for non-GNSS time systems)

getOneLetterCode

public String getOneLetterCode()

Get the one letter code.

Specified by:

getOneLetterCode in interface TimeSystem

Returns:

one letter code (may be null for non-GNSS time systems)

getTimeScale

public TimeScale getTimeScale(TimeScales timeScales)

Get the time scale corresponding to time system.

Specified by:

getTimeScale in interface TimeSystem

Parameters:

timeScales - the set of time scales to use

Returns:

the time scale corresponding to time system in the set of time scales

parseTimeSystem

public static PredefinedTimeSystem parseTimeSystem(String s)
                                            throws OrekitIllegalArgumentException

Parse a string to get the time system.

The string must be the time system.

Parameters:

s - string to parse

Returns:

the time system

Throws:

OrekitIllegalArgumentException - if the string does not correspond to a time system key

parseTwoLettersCode

public static PredefinedTimeSystem parseTwoLettersCode(String code)
                                                throws OrekitIllegalArgumentException

Parse a string to get the time system.

The string must be the two letters code of the time system.

Parameters:

code - string to parse

Returns:

the time system

Throws:

OrekitIllegalArgumentException - if the string does not correspond to a time system key

parseOneLetterCode

public static PredefinedTimeSystem parseOneLetterCode(String code)
                                               throws OrekitIllegalArgumentException

Parse a string to get the time system.

The string must be the one letters code of the time system. The one letter code is the RINEX GNSS system flag.

Parameters:

code - string to parse

Returns:

the time system

Throws:

OrekitIllegalArgumentException - if the string does not correspond to a time system key