org.orekit.propagation.events.handlers

Class StopOnIncreasing<T extends EventDetector>

java.lang.Object

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

Type Parameters:

T - class type for the generic version

All Implemented Interfaces:

Serializable, EventHandler<T>

public class StopOnIncreasing<T extends EventDetector>
extends Object
implements EventHandler<T>, Serializable

Handle a detection event and choose what to do next.

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

Since:

6.1

Author:

Hank Grabowski

See Also:

Serialized Form

Nested Class Summary

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

EventHandler.Action

Constructor Summary

Constructors

Constructor and Description
StopOnIncreasing()

Method Summary

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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orekit.propagation.events.handlers.EventHandler

init, resetState

Constructor Detail

StopOnIncreasing

public StopOnIncreasing()

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 descending and to stop propagation when ascending.

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