Package org.orekit.propagation.events.handlers

Class StopOnIncreasing

java.lang.Object

org.orekit.propagation.events.handlers.StopOnIncreasing

All Implemented Interfaces:

EventHandler

public class StopOnIncreasing
extends Object
implements EventHandler

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.

Since:

6.1

Author:

Hank Grabowski

Constructor Summary

Constructors

Constructor	Description
StopOnIncreasing()	Empty constructor.

Method Summary

Modifier and Type	Method	Description
Action	eventOccurred(SpacecraftState s, EventDetector detector, boolean increasing)	Handle a detection event and choose what to do next.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.orekit.propagation.events.handlers.EventHandler

finish, init, resetState

Constructor Detail

StopOnIncreasing

public StopOnIncreasing()

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(SpacecraftState s,
                            EventDetector 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 EventHandler

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