fr.cnes.sirius.patrius.time

Class TimeScalesFactory

java.lang.Object

fr.cnes.sirius.patrius.time.TimeScalesFactory

All Implemented Interfaces:

Serializable

public final class TimeScalesFactory
extends Object
implements Serializable

Factory for predefined time scales.

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

Loading of UTC-TAIL data follows PATRIUS standard way of handling data:

Data are automatically loaded based on provided UTCTAILoader.

User can provide its own implementation of these loaders and provide them using addUTCTAILoader(UTCTAILoader).

By default some loaders are added (see below). Loaders are used in the defined order below. These loaders will use data provided by DataProvidersManager.

List of loaders can be cleared and reordered using clearUTCTAILoaders().

By default, some loaders are added in the following order:

• UTCTAIHistoryFilesLoader: UTC-TAI file in IERS format (file UTC-TAI.history). See IERS UTC-TAI.history file for more information

There is no included data in PATRIUS by default.
Once loaded, data are stored in static variables and are used for UTC time scale through getUTC() method.

Author:

Luc Maisonobe

See Also:

Serialized Form

Method Summary

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	clearTimeScales() Clear the time scales (UTC, UT1 and GMST).
static void	clearUTCTAILoaders() Clear loaders for UTC-TAI offsets history files.
static TimeScale	get(String timescale) Returns the TimeScale corresponding to the string representation of time scale.
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() 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 PatriusException

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:

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

See Also:

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

getUT1

public static UT1Scale getUT1()
                       throws PatriusException

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 EOPHistoryFactory.getEOP2000History() methods for an explanation of how the corresponding data loaders can be configured.

Returns:

Universal Time 1 scale

Throws:

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

See Also:

getUTC()

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 PatriusException

Get the Greenwich Mean Sidereal Time scale.

Returns:

Greenwich Mean Sidereal Time scale

Throws:

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

get

public static TimeScale get(String timescale)
                     throws PatriusException

Returns the TimeScale corresponding to the string representation of time scale. For instance:

• Calling get("UTC") will return UTCScale and is equivalent to calling getUTC(),
• Calling get("TAI") will return TAIScale and is equivalent to calling getTAI().

Parameters:

timescale - time scale as string

Returns:

time scale as TimeScale

Throws:

PatriusException - thrown if string matches no known time scale

clearTimeScales

public static void clearTimeScales()

Clear the time scales (UTC, UT1 and GMST).