org.orekit.utils
Class AbstractBoundedPVProvider

java.lang.Object
  org.orekit.utils.AbstractBoundedPVProvider

All Implemented Interfaces:

PVCoordinatesProvider

Direct Known Subclasses:

EphemerisPvHermite, EphemerisPvLagrange

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 14526 2015-11-16 18:02:20Z chabaud $

Author:

chabaudp

Concurrency :

not thread-safe

Concurrency comment :

internal mutable attributes

Field Summary

protected AbsoluteDate[]	tDate Dates table
protected PVCoordinates[]	tPVCoord Position velocity coordinates table

Constructor Summary

AbstractBoundedPVProvider(PVCoordinates[] tabPV, Frame frame, AbsoluteDate[] tabDate, ISearchIndex algo)
Instantiation of AbstractBoundedPVProvider attributes.

AbstractBoundedPVProvider(SpacecraftState[] tabState, ISearchIndex algo)
Creates an instance of AbstractBoundedPVProvider from a SpacecraftState table

Method Summary

AbsoluteDate	getDateRef() Get the reference date
Frame	getFrame() Get the reference frame
abstract AbsoluteDate	getMaxDate() Get the last date of the range.
abstract AbsoluteDate	getMinDate() Get the first date of the range.
int	getPreviousIndex() Get the previous search index
ISearchIndex	getSearchIndex() Get the optimize indice search algorithm
protected void	setPreviousIndex(int index) Set 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 org.orekit.utils.PVCoordinatesProvider

getPVCoordinates

Field Detail

tPVCoord

protected final PVCoordinates[] tPVCoord

Position velocity coordinates table

tDate

protected final AbsoluteDate[] tDate

Dates table

Constructor Detail

AbstractBoundedPVProvider

public AbstractBoundedPVProvider(PVCoordinates[] tabPV,
                                 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)

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)

Since:

3.1

AbstractBoundedPVProvider

public AbstractBoundedPVProvider(SpacecraftState[] tabState,
                                 ISearchIndex algo)

Creates an instance of AbstractBoundedPVProvider from a SpacecraftState table

Parameters:

tabState - SpacecraftState table

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 - spacecraftState table should contains elements, and if tabacc not null should be of the same size

Since:

3.1

Method Detail

getDateRef

public AbsoluteDate getDateRef()

Get the reference date

Returns:

dateRef

Since:

3.1

getFrame

public Frame getFrame()

Get the reference frame

Returns:

pvFrame

Since:

3.1

getSearchIndex

public ISearchIndex getSearchIndex()

Get the optimize indice search algorithm

Returns:

searchIndex

Since:

3.1

getPreviousIndex

public int getPreviousIndex()

Get the previous search index

Returns:

previousIndex

Since:

3.1

setPreviousIndex

protected void setPreviousIndex(int index)

Set the previous search index

Parameters:

index - previous search index

Since:

3.1

getMinDate

public abstract AbsoluteDate getMinDate()

Get the first date of the range.

Returns:

the first date of the range

Since:

3.1

getMaxDate

public abstract AbsoluteDate getMaxDate()

Get the last date of the range.

Returns:

the last date of the range

Since:

3.1