org.orekit.propagation.events.handlers

Class StopOnEvent

java.lang.Object

org.orekit.propagation.events.handlers.StopOnEvent

All Implemented Interfaces:

EventHandler

public class StopOnEvent
extends Object
implements EventHandler

Event handler which will always return stop as a state.

Since:

6.1

Author:

Hank Grabowski

Constructor Summary

Constructors

Constructor and Description
StopOnEvent() Empty constructor.

Method Summary

Modifier and Type	Method and Description
org.hipparchus.ode.events.Action	eventOccurred(SpacecraftState s, EventDetector detector, boolean increasing) Specific implementation of the eventOccurred interface.

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

StopOnEvent

public StopOnEvent()

Empty constructor.

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

Since:

12.0

Method Detail

eventOccurred

public org.hipparchus.ode.events.Action eventOccurred(SpacecraftState s,
                                                      EventDetector detector,
                                                      boolean increasing)

Specific implementation of the eventOccurred interface.

Specified by:

eventOccurred in interface EventHandler

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

Returns:

stop under all circumstances