Class FieldStopOnIncreasing<T extends CalculusFieldElement<T>>

  • Type Parameters:
    T - type of the field element
    All Implemented Interfaces:
    FieldEventHandler<T>

    public class FieldStopOnIncreasing<T extends CalculusFieldElement<T>>
    extends Object
    implements FieldEventHandler<T>
    Handle a detection event and choose what to do next.

    The implementation behavior is to continue propagation when descending and to stop propagation when ascending.

    Author:
    Hank Grabowski
    • Constructor Detail

      • FieldStopOnIncreasing

        public FieldStopOnIncreasing()
        Empty constructor.

        This constructor is not strictly necessary, but it prevents spurious javadoc warnings with JDK 18 and later.

        Since:
        12.0
    • Method Detail

      • eventOccurred

        public Action eventOccurred​(FieldSpacecraftState<T> s,
                                    FieldEventDetector<T> detector,
                                    boolean increasing)
        Handle a detection event and choose what to do next.

        The implementation behavior is to continue propagation when descending and to stop propagation when ascending.

        Specified by:
        eventOccurred in interface FieldEventHandler<T extends CalculusFieldElement<T>>
        Parameters:
        s - the current state information : date, kinematics, attitude
        detector - the detector object calling this method (not used in the evaluation)
        increasing - if true, the value of the switching function increases when times increases around event
        Returns:
        Action.STOP or Action.CONTINUE