Package org.orekit.time.clocks

Class SampledClockModel

java.lang.Object

org.orekit.time.clocks.SampledClockModel

All Implemented Interfaces:

ClockModel, BaseParameterDriversProvider<ParameterDriver,ParameterObserver>, ParameterDriversProvider

public class SampledClockModel
extends Object
implements ClockModel

Offset clock model backed up by a sample.

Since:

12.1

Author:

Luc Maisonobe

Constructor Summary

Constructors

Constructor	Description
SampledClockModel(List<ClockOffset> sample, int nbInterpolationPoints)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
ImmutableTimeStampedCache<ClockOffset>	getCache()	Get the clock offsets cache.
ClockOffset	getOffset(AbsoluteDate date)	Get the clock offset at date.
List<ParameterDriver>	getParametersDrivers()	Get the drivers for parameters.
AbsoluteDate	getValidityEnd()	Get validity end.
AbsoluteDate	getValidityStart()	Get validity start.
<T extends CalculusFieldElement<T>> SampledFieldClockModel<T>	toField(DoubleFunction<T> converter)	Convert to field model.
SampledFieldClockModel<Gradient>	toGradient(int freeParameters, Map<String,Integer> indices)	Convert to gradient model.

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.drivers.BaseParameterDriversProvider

getParameterDriver, getParameterDriverWithSubstring, isSupported

Methods inherited from interface org.orekit.time.clocks.ClockModel

getAccelerationDriver, getAcceptedTermSuffix, getBiasDriver, getOffsetValue, getParameterDriverTerm, getRateDriver

Methods inherited from interface org.orekit.utils.drivers.ParameterDriversProvider

getParameters, getParameters

Constructor Details

SampledClockModel

public SampledClockModel(List<ClockOffset> sample,
 int nbInterpolationPoints)

Simple constructor.

Parameters:

sample - clock offsets sample

nbInterpolationPoints - number of points to use in interpolation

Method Details

getCache

public ImmutableTimeStampedCache<ClockOffset> getCache()

Get the clock offsets cache.

Returns:

clock offsets cache

getValidityStart

public AbsoluteDate getValidityStart()

Get validity start.

Specified by:

getValidityStart in interface ClockModel

Returns:

model validity start

getValidityEnd

public AbsoluteDate getValidityEnd()

Get validity end.

Specified by:

getValidityEnd in interface ClockModel

Returns:

model validity end

getOffset

public ClockOffset getOffset(AbsoluteDate date)

Get the clock offset at date.

Specified by:

getOffset in interface ClockModel

Parameters:

date - date at which offset is requested

Returns:

clock offset at specified date

toField

public <T extends CalculusFieldElement<T>>
SampledFieldClockModel<T> toField(DoubleFunction<T> converter)

Convert to field model.

Specified by:

toField in interface ClockModel

Type Parameters:

T - type of the field elements

Parameters:

converter - converter to field elements

Returns:

field version of the instance

toGradient

public SampledFieldClockModel<Gradient> toGradient(int freeParameters,
 Map<String,Integer> indices)

Convert to gradient model.

Specified by:

toGradient in interface ClockModel

Parameters:

freeParameters - total number of free parameters in the gradient

indices - indices of the differentiation parameters in derivatives computations, must be span name and not driver name

Returns:

converted clock model

getParametersDrivers

public List<ParameterDriver> getParametersDrivers()

Get the drivers for parameters.

Specified by:

getParametersDrivers in interface BaseParameterDriversProvider<ParameterDriver,ParameterObserver>

Returns:

drivers for parameters