Package org.orekit.propagation.events

Interface FieldEnablingPredicate<T extends CalculusFieldElement<T>>

Type Parameters:

T - type of the field elements

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 FieldEnablingPredicate<T extends CalculusFieldElement<T>>

This interface represents an event enabling predicate function.

Since:

12.0

Author:

Luc Maisonobe

See Also:

EnablingPredicate

Method Summary

Modifier and Type	Method	Description
static <T extends CalculusFieldElement<T>> FieldEnablingPredicate<T>	andCombine(FieldEnablingPredicate<T>... enablingPredicates)	Method combining predicated based on the AND logic operator.
default boolean	dependsOnMainVariablesOnly()	Method returning true if and only if the predicate does not depend on dependent variables, other than the Cartesian coordinates (or equivalent), mass and attitude (excepts for its rates).
boolean	eventIsEnabled(FieldSpacecraftState<T> state, FieldEventDetector<T> detector, T g)	Compute an event enabling function of state.
static <T extends CalculusFieldElement<T>> FieldEnablingPredicate<T>	orCombine(FieldEnablingPredicate<T>... enablingPredicates)	Method combining predicated based on the OR logic operator.

Method Detail

eventIsEnabled

boolean eventIsEnabled(FieldSpacecraftState<T> state,
                       FieldEventDetector<T> detector,
                       T g)

Compute an event enabling function of state.

Parameters:

state - current state

detector - underlying detector

g - value of the underlying detector for the current state

Returns:

true if the event is enabled (i.e. it can be triggered), false if it should be ignored

dependsOnMainVariablesOnly

default boolean dependsOnMainVariablesOnly()

Method returning true if and only if the predicate does not depend on dependent variables, other than the Cartesian coordinates (or equivalent), mass and attitude (excepts for its rates). It should thus return false if the STM or other secondary variables are needed to evaluate the predicate. This information is used for performance in propagation. The default implementation returns false.

Returns:

flag

Since:

14.0

orCombine

@SafeVarargs
static <T extends CalculusFieldElement<T>> FieldEnablingPredicate<T> orCombine(FieldEnablingPredicate<T>... enablingPredicates)

Method combining predicated based on the OR logic operator.

Type Parameters:

T - field type

Parameters:

enablingPredicates - predicates

Returns:

combined predicate

Since:

13.1

andCombine

@SafeVarargs
static <T extends CalculusFieldElement<T>> FieldEnablingPredicate<T> andCombine(FieldEnablingPredicate<T>... enablingPredicates)

Method combining predicated based on the AND logic operator.

Type Parameters:

T - field type

Parameters:

enablingPredicates - predicates

Returns:

combined predicate

Since:

13.1