org.orekit.propagation.events.handlers

Class StopOnDecreasing<T extends EventDetector>

java.lang.Object

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

Type Parameters:

T - class type for the generic version

All Implemented Interfaces:

EventHandler<T>

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

Handle a detection event and choose what to do next.

The implementation behavior is to continue propagation when ascending and to stop propagation when descending.

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
StopOnDecreasing()

Method Summary

Methods

Modifier and Type	Method and Description
EventHandler.Action	eventOccurred(SpacecraftState s, T detector, boolean increasing) Handle a detection event and choose what to do next.
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

StopOnDecreasing

public StopOnDecreasing()

Method Detail

eventOccurred

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

Handle a detection event and choose what to do next.

The implementation behavior is to continue propagation when ascending and to stop propagation when descending.

Specified by:

eventOccurred in interface EventHandler<T extends EventDetector>

Parameters:

s - the current state information : date, kinematics, attitude

detector - the detector object calling this method (not used in the evaluation)

increasing - if true, the value of the switching function increases when times increases around event

Returns:

EventHandler.Action.STOP or EventHandler.Action.CONTINUE

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