Interface EventHandler
-
- All Known Implementing Classes:
ContinueOnEvent
,EventMultipleHandler
,RecallLastOccurrence
,RecordAndContinue
,StopOnDecreasing
,StopOnEvent
,StopOnIncreasing
public interface EventHandler
An interface defining how to handle events occurring during propagation.- Since:
- 6.1
- Author:
- Hank Grabowski
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Action
eventOccurred(SpacecraftState s, EventDetector detector, boolean increasing)
Handle an event.default void
init(SpacecraftState initialState, AbsoluteDate target, EventDetector detector)
Initialize event handler at the start of a propagation.default SpacecraftState
resetState(EventDetector detector, SpacecraftState oldState)
Reset the state prior to continue propagation.
-
-
-
Method Detail
-
init
default void init(SpacecraftState initialState, AbsoluteDate target, EventDetector detector)
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 statetarget
- target date for the propagationdetector
- event detector related to the event handler
-
eventOccurred
Action eventOccurred(SpacecraftState s, EventDetector detector, boolean increasing)
Handle an event.- 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:
- the Action that the calling detector should pass back to the evaluation system
-
resetState
default SpacecraftState resetState(EventDetector detector, SpacecraftState oldState)
Reset the state prior to continue propagation.This method is called after the step handler has returned and before the next step is started, but only when
eventOccurred(org.orekit.propagation.SpacecraftState, org.orekit.propagation.events.EventDetector, boolean)
has itself returned theAction.RESET_STATE
indicator. It allows the user to reset the state for the next step, without perturbing the step handler of the finishing step. If theeventOccurred(org.orekit.propagation.SpacecraftState, org.orekit.propagation.events.EventDetector, boolean)
never returns theAction.RESET_STATE
indicator, this function will never be called, and it is safe to simply return null.The default implementation simply return its argument.
- Parameters:
detector
- object with appropriate type that can be used in determining correct return stateoldState
- old state- Returns:
- new state
-
-