fr.cnes.sirius.patrius.forces.gravity.tides.coefficients

Class OceanTidesCoefficientsFactory

java.lang.Object

fr.cnes.sirius.patrius.forces.gravity.tides.coefficients.OceanTidesCoefficientsFactory

public final class OceanTidesCoefficientsFactory
extends Object

Factory used to read ocean tides coefficients files in different formats and return an OceanTidesCoefficientsProvider

Loading of ocean tides coefficients data follows PATRIUS standard way of handling data:

Data are automatically loaded based on provided OceanTidesCoefficientsProvider.

User can provide its own implementation of these loaders and provide them using addOceanTidesCoefficientsReader(OceanTidesCoefficientsReader).

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 clearOceanTidesCoefficientsReaders().

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

• FES2004FormatReader: FES 2004 file format.

There is no included data in PATRIUS by default.
Once loaded, data are stored in static variables and are used for ocean tides computation accessible through getCoefficientsProvider() method.

Since:

1.2

Version:

$Id: OceanTidesCoefficientsFactory.java 17582 2017-05-10 12:58:16Z bignon $

Author:

Rami Houdroge

See Also:

GravityFieldFactory

Concurrency :

thread-hostile

Concurrency comment :

uses a thread-hostile DataProvidersManager

Field Summary

Fields

Modifier and Type	Field and Description
static String	FES2004_FILENAME Default file name for FES2004

Method Summary

Modifier and Type	Method and Description
static void	addDefaultOceanTidesCoefficientsReaders() Add the default READERS for ocean tides coefficients
static void	addOceanTidesCoefficientsReader(OceanTidesCoefficientsReader reader) Add a reader for ocean tides
static void	clearOceanTidesCoefficientsReaders() Clear ocean tides coefficients READERS.
static OceanTidesCoefficientsProvider	getCoefficientsProvider() Get the ocean tides coefficients provider from the first supported file.

Methods inherited from class java.lang.Object

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

Field Detail

FES2004_FILENAME

public static final String FES2004_FILENAME

Default file name for FES2004

See Also:

Constant Field Values

Method Detail

addOceanTidesCoefficientsReader

public static void addOceanTidesCoefficientsReader(OceanTidesCoefficientsReader reader)

Add a reader for ocean tides

Parameters:

reader - custom reader to add for the ocean tides coefficients

addDefaultOceanTidesCoefficientsReaders

public static void addDefaultOceanTidesCoefficientsReaders()

Add the default READERS for ocean tides coefficients

The default READERS supports FES2004 format with the default name FES2004_FILENAME

See Also:

addOceanTidesCoefficientsReader(OceanTidesCoefficientsReader), clearOceanTidesCoefficientsReaders()

clearOceanTidesCoefficientsReaders

public static void clearOceanTidesCoefficientsReaders()

Clear ocean tides coefficients READERS.

See Also:

addOceanTidesCoefficientsReader(OceanTidesCoefficientsReader), addDefaultOceanTidesCoefficientsReaders()

getCoefficientsProvider

public static OceanTidesCoefficientsProvider getCoefficientsProvider()
                                                              throws PatriusException

Get the ocean tides coefficients provider from the first supported file.

If no OceanTidesCoefficientsProvider has been added by calling addOceanTidesCoefficientsReader or if clearOceanTidesCoefficientsReaders has been called afterwards,the addDefaultOceanTidesCoefficientsReaders method will be called automatically.

Returns:

an ocean tides coefficients provider containing already loaded data

Throws:

PatriusException - if some data is missing or if some loader specific error occurs