Class StopOnEvent
- java.lang.Object
-
- org.orekit.propagation.events.handlers.StopOnEvent
-
- All Implemented Interfaces:
EventHandler
public class StopOnEvent extends Object implements EventHandler
Event handler which will always returnstop
as a state.- Since:
- 6.1
- Author:
- Hank Grabowski
-
-
Constructor Summary
Constructors Constructor Description StopOnEvent()
Empty constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Action
eventOccurred(SpacecraftState s, EventDetector detector, boolean increasing)
Specific implementation of the eventOccurred interface.-
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
init, resetState
-
-
-
-
Method Detail
-
eventOccurred
public Action eventOccurred(SpacecraftState s, EventDetector detector, boolean increasing)
Specific implementation of the eventOccurred interface.- Specified by:
eventOccurred
in interfaceEventHandler
- Parameters:
s
- SpaceCraft state to be used in the evaluationdetector
- object with appropriate type that can be used in determining correct return stateincreasing
- with the event occurred in an "increasing" or "decreasing" slope direction- Returns:
stop
under all circumstances
-
-