org.orekit.propagation.events.handlers

Class ContinueOnEvent<T extends EventDetector>

java.lang.Object

org.orekit.propagation.events.handlers.ContinueOnEvent<T>

Type Parameters:

T - class type for the generic version

All Implemented Interfaces:

EventHandler<T>

public class ContinueOnEvent<T extends EventDetector>
extends Object
implements EventHandler<T>

Event handler which will always return continue as a state.

Since:

6.1

Author:

Hank Grabowski

Nested Class Summary

Nested classes/interfaces inherited from interface org.orekit.propagation.events.handlers.EventHandler

EventHandler.Action

Constructor Summary

Constructors

Constructor and Description
ContinueOnEvent()

Method Summary

Methods

Modifier and Type	Method and Description
EventHandler.Action	eventOccurred(SpacecraftState s, T detector, boolean increasing) Specific implementation of the eventOccurred interface.
SpacecraftState	resetState(T 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

ContinueOnEvent

public ContinueOnEvent()

Method Detail

eventOccurred

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

Specific implementation of the eventOccurred interface.

Specified by:

eventOccurred in interface EventHandler<T extends EventDetector>

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 occured in an "increasing" or "decreasing" slope direction

Returns:

continue under all circumstances

Throws:

OrekitException - if some specific error occurs

resetState

public 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 EventHandler.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 EventHandler.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.

Specified by:

resetState in interface EventHandler<T extends EventDetector>

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