fr.cnes.sirius.patrius.frames.configuration.eop

Class AbstractEOPHistory

java.lang.Object

fr.cnes.sirius.patrius.frames.configuration.eop.AbstractEOPHistory

All Implemented Interfaces:

EOPHistory, Serializable, Iterable<TimeStamped>

Direct Known Subclasses:

EOP1980History, EOP2000History

public abstract class AbstractEOPHistory
extends Object
implements Serializable, EOPHistory

This class loads any kind of Earth Orientation Parameter data throughout a large time range.

Author:

Pascal Parraud

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractEOPHistory.DoubleInterpolationFunctionBuilder<T extends EOPEntry> Cache interpolable function builder used to generate Double values.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	OPTIMAL_CACHE_SIZE Optimal cache size (determined by benchmark analysis).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEOPHistory(EOPInterpolators interpMethod) Simple constructor.

Method Summary

Modifier and Type	Method and Description
void	addEntry(EOPEntry entry) Add an Earth Orientation Parameters entry.
void	checkEOPContinuity(double maxGap) Check Earth orientation parameters continuity.
static void	fillHistory(Collection<? extends EOPEntry> entries, EOPHistory history) Populates a EOPHistory instance from a collection of EOPEntry.
AbsoluteDate	getEndDate() Get the date of the last available Earth Orientation Parameters.
protected EOPEntry[]	getEOPEntryArray() Getter for the EOP entries array.
EOPInterpolators	getEOPInterpolationMethod() Return the EOP interpolation method.
protected EOPEntry	getFirst() Returns first EOP entry.
protected EOPEntry	getLast() Returns last EOP entry.
double	getLOD(AbsoluteDate date) Get the LoD (Length of Day) value.
NutationCorrection	getNutationCorrection(AbsoluteDate date) Get the correction to the nutation parameters.
PoleCorrection	getPoleCorrection(AbsoluteDate date) Get the pole IERS Reference Pole correction.
AbsoluteDate	getStartDate() Get the date of the first available Earth Orientation Parameters.
double	getUT1MinusTAI(AbsoluteDate date) Get the UT1-TAI value.
double	getUT1MinusUTC(AbsoluteDate date) Get the UT1-UTC value.
protected boolean	isEmpty() Returns true if no EOP have been loaded, false otherwise.
Iterator<TimeStamped>	iterator()
int	size() Get the number of entries in the history.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

OPTIMAL_CACHE_SIZE

protected static final int OPTIMAL_CACHE_SIZE

Optimal cache size (determined by benchmark analysis).

See Also:

Constant Field Values

Constructor Detail

AbstractEOPHistory

protected AbstractEOPHistory(EOPInterpolators interpMethod)

Simple constructor.

Parameters:

interpMethod - EOP interpolation method

Method Detail

addEntry

public void addEntry(EOPEntry entry)

Add an Earth Orientation Parameters entry.

Specified by:

addEntry in interface EOPHistory

Parameters:

entry - entry to add

iterator

public Iterator<TimeStamped> iterator()

Specified by:

iterator in interface Iterable<TimeStamped>

size

public int size()

Get the number of entries in the history.

Specified by:

size in interface EOPHistory

Returns:

number of entries in the history

isEmpty

protected boolean isEmpty()

Returns true if no EOP have been loaded, false otherwise.

Returns:

true if no EOP have been loaded, false otherwise

getFirst

protected EOPEntry getFirst()

Returns first EOP entry.

Returns:

first EOP entry

getLast

protected EOPEntry getLast()

Returns last EOP entry.

Returns:

last EOP entry

getEOPInterpolationMethod

public EOPInterpolators getEOPInterpolationMethod()

Return the EOP interpolation method.

Specified by:

getEOPInterpolationMethod in interface EOPHistory

Returns:

eop interpolation method

getStartDate

public AbsoluteDate getStartDate()

Get the date of the first available Earth Orientation Parameters.

Specified by:

getStartDate in interface EOPHistory

Returns:

the start date of the available data

getEndDate

public AbsoluteDate getEndDate()

Get the date of the last available Earth Orientation Parameters.

Specified by:

getEndDate in interface EOPHistory

Returns:

the end date of the available data

getUT1MinusUTC

public double getUT1MinusUTC(AbsoluteDate date)

Get the UT1-UTC value.

The data provided comes from the IERS files. It is smoothed data.

Specified by:

getUT1MinusUTC in interface EOPHistory

Parameters:

date - date at which the value is desired

Returns:

UT1-UTC in seconds (0 if date is outside covered range)

getUT1MinusTAI

public double getUT1MinusTAI(AbsoluteDate date)

Get the UT1-TAI value.

The data provided comes from the IERS files. It is smoothed data.

Specified by:

getUT1MinusTAI in interface EOPHistory

Parameters:

date - date at which the value is desired

Returns:

UT1-TAI in seconds (0 if date is outside covered range)

getLOD

public double getLOD(AbsoluteDate date)

Get the LoD (Length of Day) value.

The data provided comes from the IERS files. It is smoothed data.

Specified by:

getLOD in interface EOPHistory

Parameters:

date - date at which the value is desired

Returns:

LoD in seconds (0 if date is outside covered range)

getPoleCorrection

public PoleCorrection getPoleCorrection(AbsoluteDate date)

Get the pole IERS Reference Pole correction.

The data provided comes from the IERS files. It is smoothed data.

Specified by:

getPoleCorrection in interface EOPHistory

Parameters:

date - date at which the correction is desired

Returns:

pole correction (PoleCorrection.NULL_CORRECTION if date is outside covered range)

getNutationCorrection

public NutationCorrection getNutationCorrection(AbsoluteDate date)

Get the correction to the nutation parameters.

The data provided comes from the IERS files. It is smoothed data.

Specified by:

getNutationCorrection in interface EOPHistory

Parameters:

date - date at which the correction is desired

Returns:

nutation correction (NutationCorrection.NULL_CORRECTION if date is outside covered range)

getEOPEntryArray

protected EOPEntry[] getEOPEntryArray()

Getter for the EOP entries array.

Returns:

the EOP entries array

checkEOPContinuity

public void checkEOPContinuity(double maxGap)
                        throws PatriusException

Check Earth orientation parameters continuity.

Parameters:

maxGap - maximal allowed gap between entries (in seconds)

Throws:

PatriusException - if there are holes in the data sequence

fillHistory

public static void fillHistory(Collection<? extends EOPEntry> entries,
                               EOPHistory history)

Populates a EOPHistory instance from a collection of EOPEntry.

Parameters:

entries - collection of EOPEntry

history - instance to be populated