fr.cnes.sirius.patrius.forces.gravity.potential

Class SHMFormatReader

java.lang.Object

fr.cnes.sirius.patrius.forces.gravity.potential.PotentialCoefficientsReader

fr.cnes.sirius.patrius.forces.gravity.potential.SHMFormatReader

All Implemented Interfaces:

DataLoader, PotentialCoefficientsProvider

public class SHMFormatReader
extends PotentialCoefficientsReader

Reader for the SHM gravity field format.

This format was used to describe the gravity field of EIGEN models published by the GFZ Potsdam up to 2003. It was then replaced by ICGEM format. The SHM format is described in Potsdam university website.

The proper way to use this class is to call the GravityFieldFactory which will determine which reader to use with the selected potential coefficients file

Author:

Fabien Maussion

See Also:

GravityFieldFactory

Field Summary

Fields inherited from class fr.cnes.sirius.patrius.forces.gravity.potential.PotentialCoefficientsReader

ae, mu, normalizedC, normalizedJ, normalizedS, readCompleted

Constructor Summary

Constructors

Constructor and Description
SHMFormatReader(String supportedNames, boolean missingCoefficientsAllowed) Simple constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	loadData(InputStream input, String name) Load data from a stream.

Methods inherited from class fr.cnes.sirius.patrius.forces.gravity.potential.PotentialCoefficientsReader

getAe, getC, getJ, getMu, getS, getSupportedNames, missingCoefficientsAllowed, stillAcceptsData

Methods inherited from class java.lang.Object

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

Constructor Detail

SHMFormatReader

public SHMFormatReader(String supportedNames,
               boolean missingCoefficientsAllowed)

Simple constructor.

Parameters:

supportedNames - regular expression for supported files names

missingCoefficientsAllowed - if true, allows missing coefficients in the input data

Method Detail

loadData

public void loadData(InputStream input,
            String name)
              throws IOException,
                     ParseException,
                     PatriusException

Load data from a stream.

Specified by:

loadData in interface DataLoader

Specified by:

loadData in class PotentialCoefficientsReader

Parameters:

input - data input stream

name - name of the file (or zip entry)

Throws:

IOException - if data can't be read

ParseException - if data can't be parsed

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