public class PythonEventDetector extends Object implements EventDetector
It mirrors the EventHandler
interface from
Apache Commons Math but provides a space-dynamics interface to the
methods.
Events detectors are a useful solution to meet the requirements of propagators concerning discrete conditions. The state of each event detector is queried by the integrator at each step. When the sign of the underlying g switching function changes, the step is rejected and reduced, in order to make sure the sign changes occur only at steps boundaries.
When step ends exactly at a switching function sign change, the corresponding
event is triggered, by calling the eventOccurred(SpacecraftState, boolean)
method. The method can do whatever it needs with the event (logging it, performing
some processing, ignore it ...). The return value of the method will be used by
the propagator to stop or resume propagation, possibly changing the state vector.
Constructor and Description |
---|
PythonEventDetector() |
Modifier and Type | Method and Description |
---|---|
EventHandler.Action |
eventOccurred(SpacecraftState s,
boolean increasing)
Handle the event.
|
void |
finalize()
Part of JCC Python interface to object
|
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.
|
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.
|
void |
pythonDecRef()
Part of JCC Python interface to object
|
long |
pythonExtension()
Part of JCC Python interface to object
|
void |
pythonExtension(long pythonObject)
Part of JCC Python interface to object
|
SpacecraftState |
resetState(SpacecraftState oldState)
Reset the state prior to continue propagation.
|
public void pythonExtension(long pythonObject)
public long pythonExtension()
public void finalize() throws Throwable
public void pythonDecRef()
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 double g(SpacecraftState s) throws OrekitException
g
in interface EventDetector
s
- the current state information: date, kinematics, attitudeOrekitException
- if some specific error occurspublic double getThreshold()
getThreshold
in interface EventDetector
public double getMaxCheckInterval()
getMaxCheckInterval
in interface EventDetector
public int getMaxIterationCount()
getMaxIterationCount
in interface EventDetector
public EventHandler.Action eventOccurred(SpacecraftState s, boolean increasing) throws OrekitException
eventOccurred
in interface EventDetector
s
- SpaceCraft state to be used in the evaluationincreasing
- with the event occured in an "increasing" or "decreasing" slope directionOrekitException
- if some specific error occurspublic 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 eventOccurred(org.orekit.propagation.SpacecraftState, boolean)
has itself returned the EventHandler.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
eventOccurred(org.orekit.propagation.SpacecraftState, boolean)
never returns the EventHandler.Action.RESET_STATE
indicator, this function will never be called, and it is safe to simply return null.
resetState
in interface EventDetector
oldState
- old stateOrekitException
- if the state cannot be resetedCopyright © 2002-2015 CS Systèmes d'information. All rights reserved.