Package org.orekit.propagation.events.handlers

Class FieldStopOnDecreasing<T extends CalculusFieldElement<T>>

java.lang.Object

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

Type Parameters:

T - type of the field element

All Implemented Interfaces:

FieldEventHandler<T>

public class FieldStopOnDecreasing<T extends CalculusFieldElement<T>>
extends Object
implements FieldEventHandler<T>

Handle a detection event and choose what to do next.

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

Author:

Hank Grabowski

Constructor Summary

Constructors

Constructor	Description
FieldStopOnDecreasing()	Empty constructor.

Method Summary

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

finish, init, resetState

Constructor Details

FieldStopOnDecreasing

public FieldStopOnDecreasing()

Empty constructor.

This constructor is not strictly necessary, but it prevents spurious javadoc warnings with JDK 18 and later.

Since:

12.0

Method Details

eventOccurred

public Action eventOccurred(FieldSpacecraftState<T> s,
 FieldEventDetector<T> detector,
 boolean increasing)

Handle a detection event and choose what to do next.

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

Specified by:

eventOccurred in interface FieldEventHandler<T extends CalculusFieldElement<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:

Action.STOP or Action.CONTINUE