Package org.orekit.propagation.events.handlers

Interface EventHandlerModifier

All Superinterfaces:

EventHandler

All Known Implementing Classes:

RecallLastOccurrence

public interface EventHandlerModifier
extends EventHandler

An interface defining an event handler wrapping another one, possibly modifying the outputs or extracting information. By default, all methods delegate to the original handler.

Since:

14.0

Author:

Romain Serra

Method Summary

Modifier and Type	Method	Description
default Action	eventOccurred(SpacecraftState s, EventDetector detector, boolean increasing)	Handle an event.
default void	finish(SpacecraftState finalState, EventDetector detector)	This method finalizes the event handler's job.
EventHandler	getOriginalHandler()	Getter for the original event handler.
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

getOriginalHandler

EventHandler getOriginalHandler()

Getter for the original event handler.

Returns:

underlying handler

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

Specified by:

init in interface EventHandler

Parameters:

initialState - initial state

target - target date for the propagation

detector - event detector related to the event handler

eventOccurred

default Action eventOccurred(SpacecraftState s,
                             EventDetector detector,
                             boolean increasing)

Handle an event.

Specified by:

eventOccurred in interface EventHandler

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

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

Specified by:

resetState in interface EventHandler

Parameters:

detector - object with appropriate type that can be used in determining correct return state

oldState - old state

Returns:

new state

finish

default void finish(SpacecraftState finalState,
                    EventDetector detector)

This method finalizes the event handler's job.

The default implementation does nothing

Specified by:

finish in interface EventHandler

Parameters:

finalState - state at propagation end

detector - event detector related to the event handler