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:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
static void	addDefaultUTCTAILoader() Add the default loader for UTC-TAI offsets history files.
static void	addUTCTAILoader(UTCTAILoader loader) Add a loader for UTC-TAI offsets history files.
static void	clearUTCTAILoaders() Clear loaders for UTC-TAI offsets history files.
static GMSTScale	getGMST() 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 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 TTScale	getTT() Get the Terrestrial Time scale.
static UT1Scale	getUT1() Deprecated. as of 6.1 replaced with getUT1(IERSConventions, boolean)
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

addUTCTAILoader

public static void addUTCTAILoader(UTCTAILoader loader)

Add a loader for UTC-TAI offsets history files.

Parameters:

loader - custom loader to add

See Also:

getUTC(), clearUTCTAILoaders()

addDefaultUTCTAILoader

public static void addDefaultUTCTAILoader()

Add the default loader for UTC-TAI offsets history files.

The default loader looks for a file named UTC-TAI.history that must be in the IERS format.

See Also:

IERS UTC-TAI.history file, getUTC(), clearUTCTAILoaders()

clearUTCTAILoaders

public static void clearUTCTAILoaders()

Clear loaders for UTC-TAI offsets history files.

See Also:

getUTC(), addUTCTAILoader(UTCTAILoader), addDefaultUTCTAILoader()

getTAI

public static TAIScale getTAI()

Get the International Atomic Time scale.

Returns:

International Atomic Time scale

getUTC

public static UTCScale getUTC()
                       throws OrekitException

Get the Universal Time Coordinate scale.

If no UTCTAILoader has been added by calling addUTCTAILoader or if clearUTCTAILoaders has been called afterwards, the addDefaultUTCTAILoader method will be called automatically.

Returns:

Universal Time Coordinate scale

Throws:

OrekitException - if some data can't be read or some file content is corrupted

See Also:

addUTCTAILoader(UTCTAILoader), clearUTCTAILoaders(), addDefaultUTCTAILoader()

getUT1

@Deprecated
public static UT1Scale getUT1()
                       throws OrekitException

Deprecated. as of 6.1 replaced with getUT1(IERSConventions, boolean)

Get the Universal Time 1 scale.

Returns:

Universal Time 1 scale

Throws:

OrekitException - if some data can't be read or some file content is corrupted

See Also:

getUTC(), FramesFactory.getEOPHistory(IERSConventions, boolean)

getUT1

public static UT1Scale getUT1(IERSConventions conventions,
              boolean simpleEOP)
                       throws OrekitException

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 FramesFactory.getEOPHistory(IERSConventions, boolean) 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

Throws:

OrekitException - if some data can't be read or some file content is corrupted

See Also:

getUTC(), FramesFactory.getEOPHistory(IERSConventions, boolean)

getUT1

public static UT1Scale getUT1(EOPHistory history)
                       throws OrekitException

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

Throws:

OrekitException - if some data can't be read or some file content is corrupted

See Also:

getUT1(IERSConventions, boolean)

getTT

public static TTScale getTT()

Get the Terrestrial Time scale.

Returns:

Terrestrial Time scale

getGST

public static GalileoScale getGST()

Get the Galileo System Time scale.

Returns:

Galileo System Time scale

getGPS

public static GPSScale getGPS()

Get the Global Positioning System scale.

Returns:

Global Positioning System scale

getTCG

public static TCGScale getTCG()

Get the Geocentric Coordinate Time scale.

Returns:

Geocentric Coordinate Time scale

getTDB

public static TDBScale getTDB()

Get the Barycentric Dynamic Time scale.

Returns:

Barycentric Dynamic Time scale

getTCB

public static TCBScale getTCB()

Get the Barycentric Coordinate Time scale.

Returns:

Barycentric Coordinate Time scale

getGMST

public static GMSTScale getGMST()
                         throws OrekitException

Get the Greenwich Mean Sidereal Time scale.

Returns:

Greenwich Mean Sidereal Time scale

Throws:

OrekitException - if some data can't be read or some file content is corrupted