org.orekit.forces.gravity.potential
Class GravityFieldFactory

java.lang.Object
  org.orekit.forces.gravity.potential.GravityFieldFactory

public class GravityFieldFactory
extends java.lang.Object

Factory used to read gravity field files in several supported formats.

Version:

$Revision: 3111 $ $Date: 2010-02-10 17:45:39 +0100 (mer. 10 févr. 2010) $

Author:

Fabien Maussion, Pascal Parraud, Luc Maisonobe

Field Summary

static java.lang.String	EGM_FILENAME Default regular expression for EGM files.
static java.lang.String	GRGS_FILENAME Default regular expression for GRGS files.
static java.lang.String	ICGEM_FILENAME Default regular expression for ICGEM files.
static java.lang.String	SHM_FILENAME Default regular expression for SHM files.

Method Summary

static void	addDefaultPotentialCoefficientsReaders() Add the default READERS for gravity fields.
static void	addPotentialCoefficientsReader(PotentialCoefficientsReader reader) Add a reader for gravity fields.
static void	clearPotentialCoefficientsReaders() Clear gravity field READERS.
static PotentialCoefficientsProvider	getPotentialProvider() Get the gravity field 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

ICGEM_FILENAME

public static final java.lang.String ICGEM_FILENAME

Default regular expression for ICGEM files.

See Also:

Constant Field Values

SHM_FILENAME

public static final java.lang.String SHM_FILENAME

Default regular expression for SHM files.

See Also:

Constant Field Values

EGM_FILENAME

public static final java.lang.String EGM_FILENAME

Default regular expression for EGM files.

See Also:

Constant Field Values

GRGS_FILENAME

public static final java.lang.String GRGS_FILENAME

Default regular expression for GRGS files.

See Also:

Constant Field Values

Method Detail

addPotentialCoefficientsReader

public static void addPotentialCoefficientsReader(PotentialCoefficientsReader reader)

Add a reader for gravity fields.

Parameters:

reader - custom reader to add for the gravity field

See Also:

addDefaultPotentialCoefficientsReaders(), clearPotentialCoefficientsReaders()

addDefaultPotentialCoefficientsReaders

public static void addDefaultPotentialCoefficientsReaders()

Add the default READERS for gravity fields.

The default READERS supports ICGEM, SHM, EGM and GRGS formats with the default names ICGEM_FILENAME, SHM_FILENAME, EGM_FILENAME, GRGS_FILENAME and don't allow missing coefficients.

See Also:

addPotentialCoefficientsReader(PotentialCoefficientsReader), clearPotentialCoefficientsReaders()

clearPotentialCoefficientsReaders

public static void clearPotentialCoefficientsReaders()

Clear gravity field READERS.

See Also:

addPotentialCoefficientsReader(PotentialCoefficientsReader), addDefaultPotentialCoefficientsReaders()

getPotentialProvider

public static PotentialCoefficientsProvider getPotentialProvider()
                                                          throws java.io.IOException,
                                                                 java.text.ParseException,
                                                                 OrekitException

Get the gravity field coefficients provider from the first supported file.

If no PotentialCoefficientsReader has been added by calling addPotentialCoefficientsReader or if clearPotentialCoefficientsReaders has been called afterwards,the addDefaultPotentialCoefficientsReaders method will be called automatically.

Returns:

a gravity field coefficients provider containing already loaded data

Throws:

java.io.IOException - if data can't be read

java.text.ParseException - if data can't be parsed

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