Interface FieldEventHandler<KK extends FieldEventDetector<T>,​T extends org.hipparchus.RealFieldElement<T>>

  • Type Parameters:
    KK - object type that the handler is called from
    All Known Implementing Classes:
    FieldContinueOnEvent, FieldStopOnDecreasing, FieldStopOnEvent, FieldStopOnIncreasing

    public interface FieldEventHandler<KK extends FieldEventDetector<T>,​T extends org.hipparchus.RealFieldElement<T>>
    An interface defining how to override event handling behavior in the standard propagator eventing classes without requiring subclassing. In cases where one wishes to use anonymous classes rather than explicit subclassing this allows for a more direct way to override the behavior. Event classes have to specifically support this capability.
    Since:
    6.1
    Author:
    Hank Grabowski
    • Method Detail

      • init

        default void init​(FieldSpacecraftState<T> initialState,
                          FieldAbsoluteDate<T> target)
        Initialize event handler at the start of a propagation.

        This method is called once at the start of the propagation. It may be used by the event handler to initialize some internal data if needed.

        The default implementation does nothing

        Parameters:
        initialState - initial state
        target - target date for the propagation
      • eventOccurred

        FieldEventHandler.Action eventOccurred​(FieldSpacecraftState<T> s,
                                               KK detector,
                                               boolean increasing)
        eventOccurred method mirrors the same interface method as in EventDetector and its subclasses, but with an additional parameter that allows the calling method to pass in an object from the detector which would have potential additional data to allow the implementing class to determine the correct return state.
        Parameters:
        s - SpaceCraft state to be used in the evaluation
        detector - object with appropriate type that can be used in determining correct return state
        increasing - with the event occurred in an "increasing" or "decreasing" slope direction
        Returns:
        the Action that the calling detector should pass back to the evaluation system