fr.cnes.sirius.patrius.frames.configuration.eop

Class EOPHistoryFactory

java.lang.Object

fr.cnes.sirius.patrius.frames.configuration.eop.EOPHistoryFactory

public final class EOPHistoryFactory
extends Object

Factory for EOPHistory.

Loading of EOP data follows PATRIUS standard way of handling data:

Data are automatically loaded based on provided EOP2000HistoryLoader and EOP1980HistoryLoader.

User can provide its own implementation of these loaders and provide them using addEOP2000HistoryLoader(EOP2000HistoryLoader) (and equivalent for 1980 data).

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 clearEOP2000HistoryLoaders() and equivalent for 1980 data.

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

• RapidDataAndPredictionColumnsLoader: IERS rapid data and prediction files in columns format (finals file). See IERS rapid data and prediction files for more information.
• RapidDataAndPredictionXMLLoader: IERS rapid data and prediction files in XML format (finals file). See IERS rapid data and prediction files for more information.
• EOPC04FilesLoader: IERS EOP 05 C04 files. See EOP 05 C04 for more information.
• BulletinBFilesLoader: IERS bulletin B files. See Bulletin B for more information.

There is no included data in PATRIUS by default.
Once loaded, data are stored in static variables and are used to retrieve EOP data (used in frame conversions) through various static method.

Since:

1.3

Version:

$Id: EOPHistoryFactory.java 18073 2017-10-02 16:48:07Z bignon $

Author:

Rami Houdroge

Field Summary

Fields

Modifier and Type	Field and Description
static String	BULLETINB_1980_FILENAME Default regular expression for the BulletinB files (IAU1980 compatibles).
static String	BULLETINB_2000_FILENAME Default regular expression for the BulletinB files (IAU2000 compatibles).
static String	EOPC04_1980_FILENAME Default regular expression for the EOPC04 files (IAU1980 compatibles).
static String	EOPC04_2000_FILENAME Default regular expression for the EOPC04 files (IAU2000 compatibles).
static String	RAPID_DATA_PREDICITON_COLUMNS_1980_FILENAME Default regular expression for the Rapid Data and Prediction EOP columns files (IAU1980 compatibles).
static String	RAPID_DATA_PREDICITON_COLUMNS_2000_FILENAME Default regular expression for the Rapid Data and Prediction EOP columns files (IAU2000 compatibles).
static String	RAPID_DATA_PREDICITON_XML_1980_FILENAME Default regular expression for the Rapid Data and Prediction EOP XML files (IAU1980 compatibles).
static String	RAPID_DATA_PREDICITON_XML_2000_FILENAME Default regular expression for the Rapid Data and Prediction EOP XML files (IAU2000 compatibles).

Method Summary

Modifier and Type	Method and Description
static void	addDefaultEOP1980HistoryLoaders(String rapidDataColumnsSupportedNames, String rapidDataXMLSupportedNames, String eopC04SupportedNames, String bulletinBSupportedNames) Add the default loaders for EOP 1980 history.
static void	addDefaultEOP2000HistoryLoaders(String rapidDataColumnsSupportedNames, String rapidDataXMLSupportedNames, String eopC04SupportedNames, String bulletinBSupportedNames) Add the default loaders for EOP 2000 history.
static void	addEOP1980HistoryLoader(EOP1980HistoryLoader loader) Add a loader for EOP 1980 history.
static void	addEOP2000HistoryLoader(EOP2000HistoryLoader loader) Add a loader for EOP 2000 history.
static void	clearEOP1980HistoryLoaders() Clear loaders for EOP 1980 history.
static void	clearEOP2000HistoryLoaders() Clear loaders for EOP 2000 history.
static EOP1980History	getEOP1980History() Get Earth Orientation Parameters history (IAU1980) data.
static EOP1980History	getEOP1980History(EOPInterpolators interpMethod) Get Earth Orientation Parameters history (IAU1980) data.
static EOP2000History	getEOP2000History() Get Earth Orientation Parameters history (IAU2000) data.
static EOP2000History	getEOP2000History(EOPInterpolators interpMethod) Get Earth Orientation Parameters history (IAU2000) data.
static EOP2000History	getEOP2000History(EOPInterpolators interpMethod, EOP2000HistoryLoader loader) Get Earth Orientation Parameters history (IAU2000) data using a specific loader.
static EOP2000HistoryConstantOutsideInterval	getEOP2000HistoryConstant() Get Earth Orientation Parameters history (IAU2000) data.
static EOP2000HistoryConstantOutsideInterval	getEOP2000HistoryConstant(EOPInterpolators interpMethod) Get Earth Orientation Parameters history (IAU2000) data.
static EOP2000HistoryConstantOutsideInterval	getEOP2000HistoryConstant(EOPInterpolators interpMethod, EOP2000HistoryLoader loader) Get Earth Orientation Parameters history (IAU2000) data using a specific loader.

Methods inherited from class java.lang.Object

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

Field Detail

RAPID_DATA_PREDICITON_COLUMNS_1980_FILENAME

public static final String RAPID_DATA_PREDICITON_COLUMNS_1980_FILENAME

Default regular expression for the Rapid Data and Prediction EOP columns files (IAU1980 compatibles).

See Also:

Constant Field Values

RAPID_DATA_PREDICITON_XML_1980_FILENAME

public static final String RAPID_DATA_PREDICITON_XML_1980_FILENAME

Default regular expression for the Rapid Data and Prediction EOP XML files (IAU1980 compatibles).

See Also:

Constant Field Values

EOPC04_1980_FILENAME

public static final String EOPC04_1980_FILENAME

Default regular expression for the EOPC04 files (IAU1980 compatibles).

See Also:

Constant Field Values

BULLETINB_1980_FILENAME

public static final String BULLETINB_1980_FILENAME

Default regular expression for the BulletinB files (IAU1980 compatibles).

See Also:

Constant Field Values

RAPID_DATA_PREDICITON_COLUMNS_2000_FILENAME

public static final String RAPID_DATA_PREDICITON_COLUMNS_2000_FILENAME

Default regular expression for the Rapid Data and Prediction EOP columns files (IAU2000 compatibles).

See Also:

Constant Field Values

RAPID_DATA_PREDICITON_XML_2000_FILENAME

public static final String RAPID_DATA_PREDICITON_XML_2000_FILENAME

Default regular expression for the Rapid Data and Prediction EOP XML files (IAU2000 compatibles).

See Also:

Constant Field Values

EOPC04_2000_FILENAME

public static final String EOPC04_2000_FILENAME

Default regular expression for the EOPC04 files (IAU2000 compatibles).

See Also:

Constant Field Values

BULLETINB_2000_FILENAME

public static final String BULLETINB_2000_FILENAME

Default regular expression for the BulletinB files (IAU2000 compatibles).

See Also:

Constant Field Values

Method Detail

addEOP1980HistoryLoader

public static void addEOP1980HistoryLoader(EOP1980HistoryLoader loader)

Add a loader for EOP 1980 history.

Parameters:

loader - custom loader to add for the EOP history

See Also:

addDefaultEOP1980HistoryLoaders(String, String, String, String), clearEOP1980HistoryLoaders(), addEOP2000HistoryLoader(EOP2000HistoryLoader)

addDefaultEOP1980HistoryLoaders

public static void addDefaultEOP1980HistoryLoaders(String rapidDataColumnsSupportedNames,
                                                   String rapidDataXMLSupportedNames,
                                                   String eopC04SupportedNames,
                                                   String bulletinBSupportedNames)

Add the default loaders for EOP 1980 history.

The default loaders look for IERS EOP 05 C04 and bulletins B files.

Parameters:

rapidDataColumnsSupportedNames - regular expression for supported rapid data columns EOP files names (may be null if the default IERS file names are used)

rapidDataXMLSupportedNames - regular expression for supported rapid data XML EOP files names (may be null if the default IERS file names are used)

eopC04SupportedNames - regular expression for supported EOP05 C04 files names (may be null if the default IERS file names are used)

bulletinBSupportedNames - regular expression for supported bulletin B files names (may be null if the default IERS file names are used)

See Also:

IERS EOP 05 C04 files, IERS bulletins B, addEOP1980HistoryLoader(EOP1980HistoryLoader), clearEOP1980HistoryLoaders(), addDefaultEOP2000HistoryLoaders(String, String, String, String)

clearEOP1980HistoryLoaders

public static void clearEOP1980HistoryLoaders()

Clear loaders for EOP 1980 history.

See Also:

addEOP1980HistoryLoader(fr.cnes.sirius.patrius.frames.configuration.eop.EOP1980HistoryLoader), addDefaultEOP1980HistoryLoaders(java.lang.String, java.lang.String, java.lang.String, java.lang.String), clearEOP2000HistoryLoaders()

getEOP1980History

public static EOP1980History getEOP1980History()
                                        throws PatriusException

Get Earth Orientation Parameters history (IAU1980) data.

If no EOP1980HistoryLoader has been added by calling addEOP1980HistoryLoader or if clearEOP1980HistoryLoaders has been called afterwards, the addDefaultEOP1980HistoryLoaders(java.lang.String, java.lang.String, java.lang.String, java.lang.String) method will be called automatically with two null parameters (supported file names).

Returns:

Earth Orientation Parameters history (IAU1980) data

Throws:

PatriusException - if the data cannot be loaded

getEOP1980History

public static EOP1980History getEOP1980History(EOPInterpolators interpMethod)
                                        throws PatriusException

Get Earth Orientation Parameters history (IAU1980) data.

If no EOP1980HistoryLoader has been added by calling addEOP1980HistoryLoader or if clearEOP1980HistoryLoaders has been called afterwards, the addDefaultEOP1980HistoryLoaders(java.lang.String, java.lang.String, java.lang.String, java.lang.String) method will be called automatically with two null parameters (supported file names).

Parameters:

interpMethod - : interpolation method for EOP data

Returns:

Earth Orientation Parameters history (IAU1980) data

Throws:

PatriusException - if the data cannot be loaded

addEOP2000HistoryLoader

public static void addEOP2000HistoryLoader(EOP2000HistoryLoader loader)

Add a loader for EOP 2000 history.

Parameters:

loader - custom loader to add for the EOP history

See Also:

addDefaultEOP2000HistoryLoaders(String, String, String, String), clearEOP2000HistoryLoaders(), addEOP1980HistoryLoader(fr.cnes.sirius.patrius.frames.configuration.eop.EOP1980HistoryLoader)

addDefaultEOP2000HistoryLoaders

public static void addDefaultEOP2000HistoryLoaders(String rapidDataColumnsSupportedNames,
                                                   String rapidDataXMLSupportedNames,
                                                   String eopC04SupportedNames,
                                                   String bulletinBSupportedNames)

Add the default loaders for EOP 2000 history.

The default loaders look for IERS EOP 05 C04 and bulletins B files.

Parameters:

rapidDataColumnsSupportedNames - regular expression for supported rapid data columns EOP files names (may be null if the default IERS file names are used)

rapidDataXMLSupportedNames - regular expression for supported rapid data XML EOP files names (may be null if the default IERS file names are used)

eopC04SupportedNames - regular expression for supported EOP05 C04 files names (may be null if the default IERS file names are used)

bulletinBSupportedNames - regular expression for supported bulletin B files names (may be null if the default IERS file names are used)

See Also:

IERS EOP 05 C04 files, IERS bulletins B, addEOP2000HistoryLoader(fr.cnes.sirius.patrius.frames.configuration.eop.EOP2000HistoryLoader), clearEOP2000HistoryLoaders(), addDefaultEOP1980HistoryLoaders(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

clearEOP2000HistoryLoaders

public static void clearEOP2000HistoryLoaders()

Clear loaders for EOP 2000 history.

See Also:

addEOP2000HistoryLoader(fr.cnes.sirius.patrius.frames.configuration.eop.EOP2000HistoryLoader), addDefaultEOP2000HistoryLoaders(java.lang.String, java.lang.String, java.lang.String, java.lang.String), clearEOP1980HistoryLoaders()

getEOP2000History

public static EOP2000History getEOP2000History()
                                        throws PatriusException

Get Earth Orientation Parameters history (IAU2000) data.

If no EOP2000HistoryLoader has been added by calling addEOP2000HistoryLoader or if clearEOP2000HistoryLoaders has been called afterwards, the addDefaultEOP2000HistoryLoaders(java.lang.String, java.lang.String, java.lang.String, java.lang.String) method will be called automatically with two null parameters (supported file names).

Returns:

Earth Orientation Parameters history (IAU2000) data

Throws:

PatriusException - if the data cannot be loaded

getEOP2000History

public static EOP2000History getEOP2000History(EOPInterpolators interpMethod)
                                        throws PatriusException

Get Earth Orientation Parameters history (IAU2000) data.

If no EOP2000HistoryLoader has been added by calling addEOP2000HistoryLoader or if clearEOP2000HistoryLoaders has been called afterwards, the addDefaultEOP2000HistoryLoaders(java.lang.String, java.lang.String, java.lang.String, java.lang.String) method will be called automatically with two null parameters (supported file names).

Parameters:

interpMethod - : interpolation method for EOP data

Returns:

Earth Orientation Parameters history (IAU2000) data

Throws:

PatriusException - if the data cannot be loaded

getEOP2000History

public static EOP2000History getEOP2000History(EOPInterpolators interpMethod,
                                               EOP2000HistoryLoader loader)
                                        throws PatriusException

Get Earth Orientation Parameters history (IAU2000) data using a specific loader.

Parameters:

interpMethod - : interpolation method for EOP data

loader - : EOP data loader to feed

Returns:

Earth Orientation Parameters history (IAU2000) data

Throws:

PatriusException - if the data cannot be loaded

getEOP2000HistoryConstant

public static EOP2000HistoryConstantOutsideInterval getEOP2000HistoryConstant()
                                                                       throws PatriusException

Get Earth Orientation Parameters history (IAU2000) data.

If no EOP2000HistoryLoader has been added by calling addEOP2000HistoryLoader or if clearEOP2000HistoryLoaders has been called afterwards, the addDefaultEOP2000HistoryLoaders(java.lang.String, java.lang.String, java.lang.String, java.lang.String) method will be called automatically with two null parameters (supported file names).

Returns:

Earth Orientation Parameters history (IAU2000) data. Data are extended outside the history interval: the extended values are those of the interval's bounds.

Throws:

PatriusException - if the data cannot be loaded

getEOP2000HistoryConstant

public static EOP2000HistoryConstantOutsideInterval getEOP2000HistoryConstant(EOPInterpolators interpMethod)
                                                                       throws PatriusException

Get Earth Orientation Parameters history (IAU2000) data.

If no EOP2000HistoryLoader has been added by calling addEOP2000HistoryLoader or if clearEOP2000HistoryLoaders has been called afterwards, the addDefaultEOP2000HistoryLoaders(java.lang.String, java.lang.String, java.lang.String, java.lang.String) method will be called automatically with two null parameters (supported file names).

Parameters:

interpMethod - : interpolation method for EOP data

Returns:

Earth Orientation Parameters history (IAU2000) data. Data are extended outside the history interval: the extended values are those of the interval's bounds.

Throws:

PatriusException - if the data cannot be loaded

getEOP2000HistoryConstant

public static EOP2000HistoryConstantOutsideInterval getEOP2000HistoryConstant(EOPInterpolators interpMethod,
                                                                              EOP2000HistoryLoader loader)
                                                                       throws PatriusException

Get Earth Orientation Parameters history (IAU2000) data using a specific loader.

Parameters:

interpMethod - : interpolation method for EOP data

loader - : EOP data loader to feed

Returns:

Earth Orientation Parameters history (IAU2000) data. Data are extended outside the history interval: the extended values are those of the interval's bounds.

Throws:

PatriusException - if the data cannot be loaded