fr.cnes.sirius.patrius.frames.configuration.precessionnutation

Class CIPCoordinatesGenerator

java.lang.Object

fr.cnes.sirius.patrius.frames.configuration.precessionnutation.CIPCoordinatesGenerator

All Implemented Interfaces:

TimeStampedGenerator<CIPCoordinates>, Serializable

public class CIPCoordinatesGenerator
extends Object
implements TimeStampedGenerator<CIPCoordinates>

The class generates CIPCoordinates to be used independently or within a TimeStampedCache. The method applied is that of the IAU-2000.

Since:

1.3

Version:

$Id: CIPCoordinatesGenerator.java 18073 2017-10-02 16:48:07Z bignon $

Author:

Rami Houdroge

See Also:

PrecessionNutationCache, Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CIPCoordinatesGenerator(PrecessionNutationModel pnModel, int interpolationPointsIn, double spanIn) Constructor.

Method Summary

Modifier and Type	Method and Description
List<CIPCoordinates>	generate(CIPCoordinates existingData, AbsoluteDate date) Generate a chronologically sorted list of entries to be cached.

Methods inherited from class java.lang.Object

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

Constructor Detail

CIPCoordinatesGenerator

protected CIPCoordinatesGenerator(PrecessionNutationModel pnModel,
                                  int interpolationPointsIn,
                                  double spanIn)

Constructor.

Parameters:

pnModel - Precession Nutation model to use

interpolationPointsIn - indicates how many points to generate when the generate(CIPCoordinates, AbsoluteDate) method is called upon by the TimeStampedCache.

spanIn - Time span between generated reference points

Method Detail

generate

public List<CIPCoordinates> generate(CIPCoordinates existingData,
                                     AbsoluteDate date)

Generate a chronologically sorted list of entries to be cached.

If existing is earlier than date, the range covered by generated entries should cover at least from existing (excluded) to date (included). If existing is later than date, the range covered by generated entries should cover at least from date (included) to existing (excluded).

The generated entries may cover a range larger than the minimum specified above if the generator prefers to generate large chunks of data at once. It may generate again entries already generated by an earlier call (typically existing), these extra entries will be silently ignored by the cache.

The generated entries must be chronologically sorted.

Specified by:

generate in interface TimeStampedGenerator<CIPCoordinates>

Parameters:

existingData - closest already existing entry (may be null)

date - date that must be covered by the range of the generated array (guaranteed to lie between TimeStampedCache.getEarliest() and TimeStampedCache.getLatest() )

Returns:

chronologically sorted list of generated entries