Package org.orekit.time

Class TimeScalesFactory

java.lang.Object

org.orekit.time.TimeScalesFactory

All Implemented Interfaces:

Serializable

public class TimeScalesFactory
extends Object
implements Serializable

Factory for predefined time scales.

This is a utility class, so its constructor is private.

Author:

Luc Maisonobe

See Also:

TimeScales, LazyLoadedTimeScales, Serialized Form

Method Summary

Modifier and Type	Method	Description
static void	addDefaultUTCTAIOffsetsLoaders()	Add the default loaders for UTC-TAI offsets history files (both IERS and USNO).
static void	addUTCTAIOffsetsLoader(UTCTAIOffsetsLoader loader)	Add a loader for UTC-TAI offsets history files.
static void	clearUTCTAIOffsetsLoaders()	Clear loaders for UTC-TAI offsets history files.
static BDTScale	getBDT()	Get the BeiDou Navigation Satellite System time scale.
static GLONASSScale	getGLONASS()	Get the GLObal NAvigation Satellite System time scale.
static GMSTScale	getGMST(IERSConventions conventions, boolean simpleEOP)	Get the Greenwich Mean Sidereal Time scale.
static GPSScale	getGPS()	Get the Global Positioning System scale.
static GalileoScale	getGST()	Get the Galileo System Time scale.
static NavicScale	getNavIC()	Get the Navigation with Indian Constellation time scale.
static QZSSScale	getQZSS()	Get the Quasi-Zenith Satellite System time scale.
static TAIScale	getTAI()	Get the International Atomic Time scale.
static TCBScale	getTCB()	Get the Barycentric Coordinate Time scale.
static TCGScale	getTCG()	Get the Geocentric Coordinate Time scale.
static TDBScale	getTDB()	Get the Barycentric Dynamic Time scale.
static LazyLoadedTimeScales	getTimeScales()	Get the instance of TimeScales that is called by all of the static methods in this class.
static TTScale	getTT()	Get the Terrestrial Time scale.
static UT1Scale	getUT1(EOPHistory history)	Get the Universal Time 1 scale.
static UT1Scale	getUT1(IERSConventions conventions, boolean simpleEOP)	Get the Universal Time 1 scale.
static UTCScale	getUTC()	Get the Universal Time Coordinate scale.

Methods inherited from class java.lang.Object

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

Method Detail

getTimeScales

@DefaultDataContext
public static LazyLoadedTimeScales getTimeScales()

Get the instance of TimeScales that is called by all of the static methods in this class.

Returns:

the time scales used by this factory.

addUTCTAIOffsetsLoader

@DefaultDataContext
public static void addUTCTAIOffsetsLoader(UTCTAIOffsetsLoader loader)

Add a loader for UTC-TAI offsets history files.

Parameters:

loader - custom loader to add

Since:

7.1

See Also:

TAIUTCDatFilesLoader, UTCTAIHistoryFilesLoader, UTCTAIBulletinAFilesLoader, getUTC(), clearUTCTAIOffsetsLoaders()

addDefaultUTCTAIOffsetsLoaders

@DefaultDataContext
public static void addDefaultUTCTAIOffsetsLoaders()

Add the default loaders for UTC-TAI offsets history files (both IERS and USNO).

The default loaders are TAIUTCDatFilesLoader that looks for a file named tai-utc.dat that must be in USNO format and UTCTAIHistoryFilesLoader that looks fir a file named UTC-TAI.history that must be in the IERS format. The UTCTAIBulletinAFilesLoader is not added by default as it is not recommended. USNO warned us that the TAI-UTC data present in bulletin A was for convenience only and was not reliable, there have been errors in several bulletins regarding these data.

Since:

7.1

See Also:

USNO tai-utc.dat file, IERS UTC-TAI.history file, TAIUTCDatFilesLoader, UTCTAIHistoryFilesLoader, getUTC(), clearUTCTAIOffsetsLoaders()

clearUTCTAIOffsetsLoaders

@DefaultDataContext
public static void clearUTCTAIOffsetsLoaders()

Clear loaders for UTC-TAI offsets history files.

Since:

7.1

See Also:

getUTC(), addUTCTAIOffsetsLoader(UTCTAIOffsetsLoader), addDefaultUTCTAIOffsetsLoaders()

getTAI

@DefaultDataContext
public static TAIScale getTAI()

Get the International Atomic Time scale.

Returns:

International Atomic Time scale

getUTC

@DefaultDataContext
public static UTCScale getUTC()

Get the Universal Time Coordinate scale.

If no UTCTAIOffsetsLoader has been added by calling addUTCTAIOffsetsLoader or if clearUTCTAIOffsetsLoaders has been called afterwards, the addDefaultUTCTAILoaders method will be called automatically.

Returns:

Universal Time Coordinate scale

See Also:

addDefaultUTCTAIOffsetsLoaders()

getUT1

@DefaultDataContext
public static UT1Scale getUT1(IERSConventions conventions,
                              boolean simpleEOP)

Get the Universal Time 1 scale.

UT1 scale depends on both UTC scale and Earth Orientation Parameters, so this method loads these data sets. See the TimeScalesFactory.getUTC() and LazyLoadedEop.getEOPHistory(IERSConventions, boolean, TimeScales) methods for an explanation of how the corresponding data loaders can be configured.

Parameters:

conventions - IERS conventions for which EOP parameters will provide dUT1

simpleEOP - if true, tidal effects are ignored when interpolating EOP

Returns:

Universal Time 1 scale

See Also:

getUTC(), LazyLoadedEop.getEOPHistory(IERSConventions, boolean, TimeScales)

getUT1

@DefaultDataContext
public static UT1Scale getUT1(EOPHistory history)

Get the Universal Time 1 scale.

As this method allow associating any history with the time scale, it may involve large data sets. So this method does not cache the resulting UT1Scale instance, a new instance will be returned each time. In order to avoid wasting memory, calling getUT1(IERSConventions, boolean) with the single enumerate corresponding to the conventions may be a better solution. This method is made available only for expert use.

Parameters:

history - EOP parameters providing dUT1 (may be null if no correction is desired)

Returns:

Universal Time 1 scale

See Also:

getUT1(IERSConventions, boolean)

getTT

@DefaultDataContext
public static TTScale getTT()

Get the Terrestrial Time scale.

Returns:

Terrestrial Time scale

getGST

@DefaultDataContext
public static GalileoScale getGST()

Get the Galileo System Time scale.

Returns:

Galileo System Time scale

getGLONASS

@DefaultDataContext
public static GLONASSScale getGLONASS()

Get the GLObal NAvigation Satellite System time scale.

Returns:

GLObal NAvigation Satellite System time scale

getQZSS

@DefaultDataContext
public static QZSSScale getQZSS()

Get the Quasi-Zenith Satellite System time scale.

Returns:

Quasi-Zenith Satellite System time scale

getGPS

@DefaultDataContext
public static GPSScale getGPS()

Get the Global Positioning System scale.

Returns:

Global Positioning System scale

getTCG

@DefaultDataContext
public static TCGScale getTCG()

Get the Geocentric Coordinate Time scale.

Returns:

Geocentric Coordinate Time scale

getTDB

@DefaultDataContext
public static TDBScale getTDB()

Get the Barycentric Dynamic Time scale.

Returns:

Barycentric Dynamic Time scale

getTCB

@DefaultDataContext
public static TCBScale getTCB()

Get the Barycentric Coordinate Time scale.

Returns:

Barycentric Coordinate Time scale

getGMST

@DefaultDataContext
public static GMSTScale getGMST(IERSConventions conventions,
                                boolean simpleEOP)

Get the Greenwich Mean Sidereal Time scale.

Parameters:

conventions - IERS conventions for which EOP parameters will provide dUT1

simpleEOP - if true, tidal effects are ignored when interpolating EOP

Returns:

Greenwich Mean Sidereal Time scale

Since:

7.0

getNavIC

@DefaultDataContext
public static NavicScale getNavIC()

Get the Navigation with Indian Constellation time scale.

Returns:

Navigation with Indian Constellation time scale

getBDT

@DefaultDataContext
public static BDTScale getBDT()

Get the BeiDou Navigation Satellite System time scale.

Returns:

BeiDou Navigation Satellite System time scale