|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.orekit.propagation.events.AbstractDetector
public abstract class AbstractDetector
Common parts shared by several events finders. A default implementation of most of the methods of EventDetector Interface. Make it easier to create a new detector.
Propagator.addEventDetector(EventDetector)
,
Serialized FormNested Class Summary |
---|
Nested classes/interfaces inherited from interface org.orekit.propagation.events.EventDetector |
---|
EventDetector.Action |
Field Summary | |
---|---|
static double |
DEFAULT_MAXCHECK
Default maximum checking interval (s). |
static double |
DEFAULT_THRESHOLD
Default convergence threshold (s). |
Fields inherited from interface org.orekit.propagation.events.EventDetector |
---|
DECREASING, INCREASING, INCREASING_DECREASING |
Constructor Summary | |
---|---|
protected |
AbstractDetector(double maxCheck,
double threshold)
Build a new instance. |
|
AbstractDetector(int slopeSelection,
double maxCheck,
double threshold)
Build a new instance. |
Method Summary | |
---|---|
abstract EventDetector.Action |
eventOccurred(SpacecraftState s,
boolean increasing,
boolean forward)
Handle an event and choose what to do next. |
abstract double |
g(SpacecraftState s)
Compute the value of the switching function. |
double |
getMaxCheckInterval()
Get maximal time interval between switching function checks. |
int |
getMaxIterationCount()
Get maximal number of iterations in the event time search. |
int |
getSlopeSelection()
Get the parameter in charge of the selection of detected events by the slope of the g-function. |
double |
getThreshold()
Get the convergence threshold in the event time search. |
void |
init(SpacecraftState s0,
AbsoluteDate t)
Initialize event handler at the start of a propagation. |
SpacecraftState |
resetState(SpacecraftState oldState)
Reset the state (including additional states) prior to continue propagation. |
abstract boolean |
shouldBeRemoved()
This method is called after EventDetector.eventOccurred(org.orekit.propagation.SpacecraftState, boolean, boolean) has been triggered. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final double DEFAULT_MAXCHECK
public static final double DEFAULT_THRESHOLD
Constructor Detail |
---|
protected AbstractDetector(double maxCheck, double threshold)
maxCheck
- maximum checking interval (s)threshold
- convergence threshold (s)public AbstractDetector(int slopeSelection, double maxCheck, double threshold)
slopeSelection
- g-function slope selection (0, 1, or 2)maxCheck
- maximum checking interval (s)threshold
- convergence threshold (s)Method Detail |
---|
public void init(SpacecraftState s0, AbsoluteDate t)
This method is called once at the start of the propagation. It may be used by the event handler to initialize some internal data if needed.
init
in interface EventDetector
s0
- initial statet
- target time for the integrationpublic abstract EventDetector.Action eventOccurred(SpacecraftState s, boolean increasing, boolean forward) throws OrekitException
The scheduling between this method and the OrekitStepHandler
method handleStep(interpolator, isLast)
is to call this method first and
handleStep
afterwards. This scheduling allows the propagator to
pass true
as the isLast
parameter to the step
handler to make it aware the step will be the last one if this method
returns EventDetector.Action.STOP
. As the interpolator may be used to navigate back
throughout the last step (as OrekitStepNormalizer
does for example), user code called by this method and user
code called by step handlers may experience apparently out of order values
of the independent time variable. As an example, if the same user object
implements both this EventDetector
interface and the
OrekitFixedStepHandler
interface, a forward integration may call its
eventOccurred
method with a state at 2000-01-01T00:00:10 first
and call its handleStep
method with a state at 2000-01-01T00:00:09
afterwards. Such out of order calls are limited to the size of the
integration step for variable step handlers
and
to the size of the fixed step for fixed step handlers
.
eventOccurred
in interface EventDetector
s
- the current state information: date, kinematics, attitude for forces
and events computation, mass provider, and additional statesincreasing
- if true, the value of the switching function increases
when times increases around event (note that increase is measured with respect
to physical time, not with respect to propagation which may go backward in time)forward
- if true, the integration variable (time) increases during integration.
EventDetector.Action.STOP
, EventDetector.Action.RESET_STATE
,
EventDetector.Action.RESET_DERIVATIVES
, EventDetector.Action.CONTINUE
OrekitException
- if some specific error occurspublic abstract boolean shouldBeRemoved()
EventDetector.eventOccurred(org.orekit.propagation.SpacecraftState, boolean, boolean)
has been triggered.
It returns true if the current detector should be removed after first event detection.
WARNING: this method can be called only once a event has been triggered. Before,
the value is not available.
shouldBeRemoved
in interface EventDetector
public abstract double g(SpacecraftState s) throws OrekitException
g
in interface EventDetector
s
- the current state information: date, kinematics, attitude for forces
and events computation, mass provider, and additional states
OrekitException
- if some specific error occurspublic double getMaxCheckInterval()
getMaxCheckInterval
in interface EventDetector
public int getMaxIterationCount()
getMaxIterationCount
in interface EventDetector
public double getThreshold()
getThreshold
in interface EventDetector
public SpacecraftState resetState(SpacecraftState oldState) throws OrekitException
This method is called after the step handler has returned and
before the next step is started, but only when EventDetector.eventOccurred(org.orekit.propagation.SpacecraftState, boolean, boolean)
has itself returned the EventDetector.Action.RESET_STATE
indicator. It allows the user to reset the state for the next step,
without perturbing the step handler of the finishing step. If the
EventDetector.eventOccurred(org.orekit.propagation.SpacecraftState, boolean, boolean)
never returns the EventDetector.Action.RESET_STATE
indicator, this function will never be called, and it is safe to simply return null.
resetState
in interface EventDetector
oldState
- old state
OrekitException
- if the state cannot be resetedpublic int getSlopeSelection()
getSlopeSelection
in interface EventDetector
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |