Package org.orekit.propagation.events.intervals

Interface FieldAdaptableInterval<T extends CalculusFieldElement<T>>

Type Parameters:

T - the type of the field elements

All Known Implementing Classes:

FieldPeriodBasedAdaptableInterval

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface FieldAdaptableInterval<T extends CalculusFieldElement<T>>

This interface represents an event checking interval that depends on state.

Since:

12.0

Author:

Luc Maisonobe

See Also:

FieldEventDetector, AdaptableInterval

Method Summary

Modifier and Type	Method	Description
double	currentInterval(FieldSpacecraftState<T> state, boolean isForward)	Get the current value of maximal time interval between events handler checks.
static <T extends CalculusFieldElement<T>> FieldAdaptableInterval<T>	of(double constantInterval)	Method creating a constant interval provider.
static <T extends CalculusFieldElement<T>> FieldAdaptableInterval<T>	of(double defaultMaxCheck, FieldAdaptableInterval<T>... adaptableIntervals)	Method creating an interval taking the minimum value of all candidates.
static <T extends CalculusFieldElement<T>> FieldAdaptableInterval<T>	of(AdaptableInterval adaptableInterval)	Method creating an interval provider from a non-Field one.

Method Detail

currentInterval

double currentInterval(FieldSpacecraftState<T> state,
                       boolean isForward)

Get the current value of maximal time interval between events handler checks.

Parameters:

state - current state

isForward - direction of propagation

Returns:

current value of maximal time interval between events handler checks (only as a double)

of

static <T extends CalculusFieldElement<T>> FieldAdaptableInterval<T> of(double constantInterval)

Method creating a constant interval provider.

Type Parameters:

T - field type

Parameters:

constantInterval - value of constant interval

Returns:

adaptable interval ready to be added to an event detector

Since:

12.1

of

static <T extends CalculusFieldElement<T>> FieldAdaptableInterval<T> of(AdaptableInterval adaptableInterval)

Method creating an interval provider from a non-Field one.

Type Parameters:

T - field type

Parameters:

adaptableInterval - non-Field interval

Returns:

adaptable interval ready to be added to an event detector

Since:

13.0

of

@SafeVarargs
static <T extends CalculusFieldElement<T>> FieldAdaptableInterval<T> of(double defaultMaxCheck,
                                                                        FieldAdaptableInterval<T>... adaptableIntervals)

Method creating an interval taking the minimum value of all candidates.

Type Parameters:

T - field type

Parameters:

defaultMaxCheck - default value if no intervals is given as inputv

adaptableIntervals - intervals

Returns:

adaptable interval ready to be added to an event detector

Since:

13.0