org.orekit.propagation.events.handlers

Class FieldStopOnIncreasing<KK extends FieldEventDetector<T>,T extends org.hipparchus.RealFieldElement<T>>

java.lang.Object

org.orekit.propagation.events.handlers.FieldStopOnIncreasing<KK,T>

Type Parameters:

KK - class type for the generic version

All Implemented Interfaces:

FieldEventHandler<KK,T>

public class FieldStopOnIncreasing<KK extends FieldEventDetector<T>,T extends org.hipparchus.RealFieldElement<T>>
extends Object
implements FieldEventHandler<KK,T>

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.

Author:

Hank Grabowski

Nested Class Summary

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

FieldEventHandler.Action

Constructor Summary

Constructors

Constructor and Description
FieldStopOnIncreasing()

Method Summary

Modifier and Type	Method and Description
FieldEventHandler.Action	eventOccurred(FieldSpacecraftState<T> s, KK 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.FieldEventHandler

init, resetState

Constructor Detail

FieldStopOnIncreasing

public FieldStopOnIncreasing()

Method Detail

eventOccurred

public FieldEventHandler.Action eventOccurred(FieldSpacecraftState<T> s,
                                              KK 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 FieldEventHandler<KK extends FieldEventDetector<T>,T extends org.hipparchus.RealFieldElement<T>>

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:

FieldEventHandler.Action.STOP or FieldEventHandler.Action.CONTINUE

Throws:

OrekitException - if some specific error occurs