fr.cnes.sirius.patrius.forces.atmospheres.solarActivity

Class SolarActivityDataFactory

java.lang.Object

fr.cnes.sirius.patrius.forces.atmospheres.solarActivity.SolarActivityDataFactory

public final class SolarActivityDataFactory
extends Object

Factory used to read solar activity files and return solar activity data providers

Loading of Solar Activity data follows PATRIUS standard way of handling data:

Data are automatically loaded based on provided SolarActivityDataProvider.

User can provide its own implementation of these loaders and provide them using addSolarActivityDataReader(SolarActivityDataReader).

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

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

• ACSOLFormatReader: ACSOL file format.
• NOAAFormatReader: NOAA file format.

There is no included data in PATRIUS by default.
Once loaded, data are stored in static variables and are used for solar activity retrieval through getSolarActivityDataProvider() method.

Since:

1.2

Version:

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

Author:

Rami Houdroge

Concurrency :

thread-hostile

Concurrency comment :

uses DataProvidersManager which is thread hostile

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACSOL_FILENAME Default file name for ACSOL
static String	NOAA_FILENAME Default file name for NOAA

Method Summary

Modifier and Type	Method and Description
static void	addDefaultSolarActivityDataReaders() Add the default READERS for solar activity The default READERS supports ACSOL format with the default name ACSOL_FILENAME
static void	addSolarActivityDataReader(SolarActivityDataReader reader) Add a reader for solar activity
static void	clearSolarActivityDataReaders() Clear solar activity READERS.
static SolarActivityDataProvider	getSolarActivityDataProvider() Get the solar activity 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

ACSOL_FILENAME

public static final String ACSOL_FILENAME

Default file name for ACSOL

See Also:

Constant Field Values

NOAA_FILENAME

public static final String NOAA_FILENAME

Default file name for NOAA

See Also:

Constant Field Values

Method Detail

addSolarActivityDataReader

public static void addSolarActivityDataReader(SolarActivityDataReader reader)

Add a reader for solar activity

Parameters:

reader - custom reader to add

addDefaultSolarActivityDataReaders

public static void addDefaultSolarActivityDataReaders()
                                               throws PatriusException

Add the default READERS for solar activity

The default READERS supports ACSOL format with the default name ACSOL_FILENAME

Throws:

PatriusException - thrown if readers could not properly initialized

See Also:

addSolarActivityDataReader(SolarActivityDataReader), clearSolarActivityDataReaders()

clearSolarActivityDataReaders

public static void clearSolarActivityDataReaders()

Clear solar activity READERS.

See Also:

addSolarActivityDataReader(SolarActivityDataReader), addDefaultSolarActivityDataReaders()

getSolarActivityDataProvider

public static SolarActivityDataProvider getSolarActivityDataProvider()
                                                              throws PatriusException

Get the solar activity provider from the first supported file.

If no SolarActivityDataProvider has been added by calling addSolarActivityDataReader or if clearSolarActivityDataReaders has been called afterwards,the addDefaultSolarActivityDataReaders method will be called automatically.

Returns:

an solar activity coefficients provider containing already loaded data

Throws:

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