Package org.orekit.gnss

Enum TimeSystem

java.lang.Object

java.lang.Enum<TimeSystem>

org.orekit.gnss.TimeSystem

All Implemented Interfaces:

Serializable, Comparable<TimeSystem>

public enum TimeSystem
extends Enum<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.
IRNSS	IRNSS.
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 TimeSystem	parseOneLetterCode(String code)	Parse a string to get the time system.
static TimeSystem	parseTimeSystem(String s)	Parse a string to get the time system.
static TimeSystem	parseTwoLettersCode(String code)	Parse a string to get the time system.
static TimeSystem	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TimeSystem[]	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 TimeSystem GPS

Global Positioning System.

GLONASS

public static final TimeSystem GLONASS

GLONASS.

GALILEO

public static final TimeSystem GALILEO

GALILEO.

TAI

public static final TimeSystem TAI

International Atomic Time.

UTC

public static final TimeSystem UTC

Coordinated Universal Time.

QZSS

public static final TimeSystem QZSS

Quasi-Zenith System.

BEIDOU

public static final TimeSystem BEIDOU

Beidou.

IRNSS

public static final TimeSystem IRNSS

IRNSS.

SBAS

public static final TimeSystem SBAS

SBAS.

Since:

12.0

GMT

public static final TimeSystem GMT

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

Since:

12.0

UNKNOWN

public static final TimeSystem UNKNOWN

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

Method Detail

values

public static TimeSystem[] 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 (TimeSystem c : TimeSystem.values())
    System.out.println(c);

Returns:

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

valueOf

public static TimeSystem 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.

Returns:

3 letters key

Since:

12.0

getTwoLettersCode

public String getTwoLettersCode()

Get the two letters code.

Returns:

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

Since:

12.2

getOneLetterCode

public String getOneLetterCode()

Get the one letter code.

Returns:

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

Since:

12.2

parseTimeSystem

public static TimeSystem 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 TimeSystem 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 TimeSystem 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

getTimeScale

public TimeScale getTimeScale(TimeScales timeScales)

Get the time scale corresponding to time system.

Parameters:

timeScales - the set of time scales to use

Returns:

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