fr.cnes.sirius.patrius.orbits.pvcoordinates

Class AbstractBoundedPVProvider

java.lang.Object

fr.cnes.sirius.patrius.orbits.pvcoordinates.AbstractBoundedPVProvider

All Implemented Interfaces:

PVCoordinatesProvider, Serializable

Direct Known Subclasses:

AbstractEphemerisPvHermiteLagrange

public abstract class AbstractBoundedPVProvider
extends Object
implements PVCoordinatesProvider

This abstract class shall be extended to provides a PVCoordinates provider based on manipulation of PVCoordinates ephemeris. The method of the implemented interface PVCoordinatesProvider is not implemented here and have to be implemented in extending classes to provide a position velocity for a given date.

Since:

3.1

Version:

$Id: AbstractBoundedPVProvider.java 17625 2017-05-19 12:06:56Z bignon $

Author:

chabaudp

See Also:

Serialized Form

Concurrency :

not thread-safe

Concurrency comment :

internal mutable attributes

Field Summary

Fields

Modifier and Type	Field and Description
protected int	polyOrder Lagrange/Hermite polynomial order.
protected AbsoluteDate[]	tDate Dates table.
protected PVCoordinates[]	tPVCoord Position velocity coordinates table.

Constructor Summary

Constructors

Constructor and Description
AbstractBoundedPVProvider(PVCoordinates[] tabPV, int order, Frame frame, AbsoluteDate[] tabDate, ISearchIndex algo) Instantiation of AbstractBoundedPVProvider attributes.
AbstractBoundedPVProvider(SpacecraftState[] tabState, int order, ISearchIndex algo) Creates an instance of AbstractBoundedPVProvider from a SpacecraftState table.

Method Summary

Modifier and Type	Method and Description
protected PVCoordinates	checkBounds(AbsoluteDate date) Returns PV Coordinates on bounds if duration is on bounds.
AbsoluteDate	getDateRef() Getter for the reference date.
Frame	getFrame() Getter for the reference frame.
AbsoluteDate	getMaxDate() Return the higher date authorized to call getPVCoordinates.
AbsoluteDate	getMinDate() Return the lower date authorized to call getPVCoordinates.
Frame	getNativeFrame(AbsoluteDate date) Get the native frame, i.e. the raw frame in which PVCoordinates are expressed before transformation to user output frame.
int	getPreviousIndex() Getter for the previous search index.
ISearchIndex	getSearchIndex() Getter for the optimize index search algorithm.
int	indexValidity(int index) Checks if interpolation is valid : meaning if 0<= index +1 -interpOrder/2 or index + interpOrder/2 <= maximalIndex.
protected void	setPreviousIndex(int index) Setter for the previous search index

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.cnes.sirius.patrius.orbits.pvcoordinates.PVCoordinatesProvider

getPVCoordinates

Field Detail

tPVCoord

protected final PVCoordinates[] tPVCoord

Position velocity coordinates table.

polyOrder

protected final int polyOrder

Lagrange/Hermite polynomial order.

tDate

protected final AbsoluteDate[] tDate

Dates table.

Constructor Detail

AbstractBoundedPVProvider

public AbstractBoundedPVProvider(PVCoordinates[] tabPV,
                                 int order,
                                 Frame frame,
                                 AbsoluteDate[] tabDate,
                                 ISearchIndex algo)

Instantiation of AbstractBoundedPVProvider attributes.

Parameters:

tabPV - position velocity coordinates table (table is not copied and so internal class state can be modified from outside)

order - Lagrange/Hermite interpolation order. It must be even.

frame - coordinates expression frame

tabDate - table of dates for each position velocity (table is not copied and so internal class state can be modified from outside)

algo - class to find the nearest date index from a given date in the date table (If null, algo will be, by default, a BinarySearchIndexOpenClosed based on a table of duration since the first date of the dates table)

Throws:

IllegalArgumentException - if tabPV and tabDate have not the same size or
if parameters are not consistent : order is higher than the length of PV coordinates table or
if order is not even

AbstractBoundedPVProvider

public AbstractBoundedPVProvider(SpacecraftState[] tabState,
                                 int order,
                                 ISearchIndex algo)

Creates an instance of AbstractBoundedPVProvider from a SpacecraftState table.

Parameters:

tabState - SpacecraftState table

order - Lagrange/Hermite interpolation order. It must be even.

algo - class to find the nearest date index from a given date (If null, algo will be BinarySearchIndexOpenClosed by default based on a table of duration since the first date of the dates table)

Throws:

IllegalArgumentException - if spacecraftState table should contains elements, and if tabacc not null should be of the same size
if tabPV and tabDate have not the same size or
if parameters are not consistent : order is higher than the length of PV coordinates table or
if order is not even or
if order is not even.

Method Detail

getDateRef

public AbsoluteDate getDateRef()

Getter for the reference date.

Returns:

dateRef

getFrame

public Frame getFrame()

Getter for the reference frame.

Returns:

pvFrame

getSearchIndex

public ISearchIndex getSearchIndex()

Getter for the optimize index search algorithm.

Returns:

searchIndex

getPreviousIndex

public int getPreviousIndex()

Getter for the previous search index.

Returns:

previousIndex

setPreviousIndex

protected void setPreviousIndex(int index)

Setter for the previous search index

Parameters:

index - previous search index

indexValidity

public int indexValidity(int index)
                  throws PatriusException

Checks if interpolation is valid : meaning if 0<= index +1 -interpOrder/2 or index + interpOrder/2 <= maximalIndex.

Parameters:

index - the closest index from a given date

Returns:

the first interpolation point i0, such as i0 = index + 1 - order / 2

Throws:

PatriusException - if the index does not allow enough points to do the interpolation

getMinDate

public AbsoluteDate getMinDate()

Return the lower date authorized to call getPVCoordinates.

Returns:

minimum ephemeris date

getMaxDate

public AbsoluteDate getMaxDate()

Return the higher date authorized to call getPVCoordinates.

Returns:

maximum ephemeris date

checkBounds

protected PVCoordinates checkBounds(AbsoluteDate date)

Returns PV Coordinates on bounds if duration is on bounds.

Parameters:

date - duration

Returns:

PV Coordinates on bounds if duration is on bounds, null otherwise

getNativeFrame

public Frame getNativeFrame(AbsoluteDate date)

Get the native frame, i.e. the raw frame in which PVCoordinates are expressed before transformation to user output frame.

Specified by:

getNativeFrame in interface PVCoordinatesProvider

Parameters:

date - a date

Returns:

the native frame