org.orekit.forces.gravity.potential

Class AstronomicalAmplitudeReader

java.lang.Object

org.orekit.forces.gravity.potential.AstronomicalAmplitudeReader

All Implemented Interfaces:

DataLoader

public class AstronomicalAmplitudeReader
extends Object
implements DataLoader

Parser for tides astronomical amplitude H_f.

Since:

6.1

Author:

Luc Maisonobe

Constructor Summary

Constructors

Constructor and Description
AstronomicalAmplitudeReader(String supportedNames, int columns, int columnDoodson, int columnHf, double scale) Simple constructor.

Method Summary

Modifier and Type	Method and Description
Map<Integer,Double>	getAstronomicalAmplitudesMap() Get astronomical amplitudes map.
String	getSupportedNames() Get the regular expression for supported files names.
void	loadData(InputStream input, String name) Load data from a stream.
boolean	stillAcceptsData() Check if the loader still accepts new data.

Methods inherited from class java.lang.Object

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

Constructor Detail

AstronomicalAmplitudeReader

public AstronomicalAmplitudeReader(String supportedNames,
                                   int columns,
                                   int columnDoodson,
                                   int columnHf,
                                   double scale)

Simple constructor.

Parameters:

supportedNames - regular expression for supported files names

columns - number of columns

columnDoodson - Doodson number column (counting from 1)

columnHf - H_f column (counting from 1)

scale - scaling factor for astronomical amplitude

Method Detail

getSupportedNames

public String getSupportedNames()

Get the regular expression for supported files names.

Returns:

regular expression for supported files names

stillAcceptsData

public boolean stillAcceptsData()

Check if the loader still accepts new data.

This method is used to speed up data loading by interrupting crawling the data sets as soon as a loader has found the data it was waiting for. For loaders that can merge data from any number of sources (for example JPL ephemerides or Earth Orientation Parameters that are split among several files), this method should always return true to make sure no data is left over.

Specified by:

stillAcceptsData in interface DataLoader

Returns:

true while the loader still accepts new data

loadData

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

Load data from a stream.

Specified by:

loadData in interface DataLoader

Parameters:

input - data input stream

name - name of the file (or zip entry)

Throws:

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

IOException - if data can't be read

getAstronomicalAmplitudesMap

public Map<Integer,Double> getAstronomicalAmplitudesMap()

Get astronomical amplitudes map.

Returns:

an unmodifiable map containing astronomical amplitudes H_f from a Doodson number key