org.orekit.models.earth.displacement

Class OceanLoadingCoefficientsBLQFactory

java.lang.Object

org.orekit.data.AbstractSelfFeedingLoader

org.orekit.models.earth.displacement.OceanLoadingCoefficientsBLQFactory

public class OceanLoadingCoefficientsBLQFactory
extends AbstractSelfFeedingLoader

Factory for ocean loading coefficients, using Onsala Space Observatory files in BLQ format.

Files in BLQ format can be generated using the form at the Bos-Scherneck web site, selecting BLQ as the output format.

The sites names are extracted from the file content, not the file name, because the file can contain more than one station. As we expect existing files may have been stripped from headers and footers, we do not attempt to parse them. We only parse the series of 7 lines blocks starting with the lines with the station names and their coordinates and the 6 data lines that follows. Several such blocks may appear in the file. Copy-pasting the entire mail received from OSO after completing the web site form works, as intermediate lines between the 7 lines blocks are simply ignored.

Since:

9.1

Author:

Luc Maisonobe

See Also:

OceanLoadingCoefficients, OceanLoading

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_BLQ_SUPPORTED_NAMES Default supported files name pattern for Onsala Space Observatory files in BLQ format.

Constructor Summary

Constructors

Constructor and Description
OceanLoadingCoefficientsBLQFactory(String supportedNames) Simple constructor.
OceanLoadingCoefficientsBLQFactory(String supportedNames, DataProvidersManager dataProvidersManager) This constructor allows specification of the source of the BLQ auxiliary data files.

Method Summary

Modifier and Type	Method and Description
OceanLoadingCoefficients	getCoefficients(String site) Get the coefficients for a given site.
List<String>	getSites() Get the list of sites for which we have found coefficients, in lexicographic order ignoring case.

Methods inherited from class org.orekit.data.AbstractSelfFeedingLoader

feed, getDataProvidersManager, getSupportedNames, setSupportedNames

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BLQ_SUPPORTED_NAMES

public static final String DEFAULT_BLQ_SUPPORTED_NAMES

Default supported files name pattern for Onsala Space Observatory files in BLQ format.

See Also:

Constant Field Values

Constructor Detail

OceanLoadingCoefficientsBLQFactory

@DefaultDataContext
public OceanLoadingCoefficientsBLQFactory(String supportedNames)

Simple constructor. This constructor uses the default data context.

Files in BLQ format can be generated using the form at the Bos-Scherneck web site, selecting BLQ as the output format.

Parameters:

supportedNames - regular expression for supported files names

See Also:

DEFAULT_BLQ_SUPPORTED_NAMES, OceanLoadingCoefficientsBLQFactory(String, DataProvidersManager)

OceanLoadingCoefficientsBLQFactory

public OceanLoadingCoefficientsBLQFactory(String supportedNames,
                                          DataProvidersManager dataProvidersManager)

This constructor allows specification of the source of the BLQ auxiliary data files.

Files in BLQ format can be generated using the form at the Bos-Scherneck web site, selecting BLQ as the output format.

Parameters:

supportedNames - regular expression for supported files names

dataProvidersManager - provides access to auxiliary data files.

Since:

10.1

See Also:

DEFAULT_BLQ_SUPPORTED_NAMES

Method Detail

getSites

public List<String> getSites()

Get the list of sites for which we have found coefficients, in lexicographic order ignoring case.

Returns:

list of sites for which we have found coefficients, in lexicographic order ignoring case

getCoefficients

public OceanLoadingCoefficients getCoefficients(String site)

Get the coefficients for a given site.

Parameters:

site - site name (as it appears in the Onsala Space Observatory files in BLQ format), ignoring case

Returns:

coefficients for the site