Package org.orekit.propagation.events.handlers

Class StopOnEvent<T extends EventDetector>

java.lang.Object

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

Type Parameters:

T - class type for the generic version

All Implemented Interfaces:

Serializable, EventHandler<T>

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

Event handler which will always return stop as a state.

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	Description
StopOnEvent()

Method Summary

Modifier and Type	Method	Description
EventHandler.Action	eventOccurred(SpacecraftState s, T detector, boolean increasing)	Specific implementation of the eventOccurred interface.

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

init, resetState

Methods inherited from class java.lang.Object

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

Constructor Detail

StopOnEvent

public StopOnEvent()

Method Detail

eventOccurred

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

Specific implementation of the eventOccurred interface.

Specified by:

eventOccurred in interface EventHandler<T extends EventDetector>

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

Throws:

OrekitException - if some specific error occurs