org.orekit.propagation.events.handlers

Interface EventHandler<T extends EventDetector>

Type Parameters:

T - object type that the handler is called from

All Known Implementing Classes:

ContinueOnEvent, RecordAndContinue, StopOnDecreasing, StopOnEvent, StopOnIncreasing

public interface EventHandler<T extends EventDetector>

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EventHandler.Action Enumerate for actions to be performed when an event occurs.

Method Summary

Modifier and Type	Method and Description
EventHandler.Action	eventOccurred(SpacecraftState s, T 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.
default void	init(SpacecraftState initialState, AbsoluteDate target) Initialize event handler at the start of a propagation.
default SpacecraftState	resetState(T detector, SpacecraftState oldState) Reset the state prior to continue propagation.

Method Detail

init

default void init(SpacecraftState initialState,
                  AbsoluteDate 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

EventHandler.Action eventOccurred(SpacecraftState s,
                                  T detector,
                                  boolean increasing)
                           throws OrekitException

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

Throws:

OrekitException - if some specific error occurs

resetState

default SpacecraftState resetState(T detector,
                                   SpacecraftState oldState)
                            throws OrekitException

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, T, boolean) has itself returned the EventHandler.Action.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 the eventOccurred(org.orekit.propagation.SpacecraftState, T, boolean) never returns the EventHandler.Action.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 state

oldState - old state

Returns:

new state

Throws:

OrekitException - if the state cannot be reseted