Package org.orekit.propagation.events.handlers

Class RecallLastOccurrence

java.lang.Object

org.orekit.propagation.events.handlers.RecallLastOccurrence

All Implemented Interfaces:

EventHandler

public class RecallLastOccurrence
extends Object
implements EventHandler

Event handler wrapping another, arbitrary one whilst remembering date of last detection. If never used, the cache is null. If used but nothing detected, it returns past infinity in case of forward propagation and future infinity otherwise.

Since:

12.1

Author:

Romain Serra

See Also:

RecordAndContinue

Constructor Summary

Constructors

Constructor	Description
RecallLastOccurrence(EventHandler wrappedHandler)	Constructor.

Method Summary

Modifier and Type	Method	Description
Action	eventOccurred(SpacecraftState s, EventDetector detector, boolean increasing)	Handle an event.
void	finish(SpacecraftState finalState, EventDetector detector)	This method finalizes the event handler's job.
AbsoluteDate	getLastOccurrence()	Getter for last occurrence.
void	init(SpacecraftState initialState, AbsoluteDate target, EventDetector detector)	Initialize event handler at the start of a propagation.
SpacecraftState	resetState(EventDetector detector, SpacecraftState oldState)	Reset the state prior to continue propagation.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecallLastOccurrence

public RecallLastOccurrence(EventHandler wrappedHandler)

Constructor.

Parameters:

wrappedHandler - event handler to wrap

Method Detail

getLastOccurrence

public AbsoluteDate getLastOccurrence()

Getter for last occurrence.

Returns:

last date when underlying event was detected

init

public 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

public 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

public 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

public 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