Class AbstractDetector<T extends EventDetector>
- java.lang.Object
-
- org.orekit.propagation.events.AbstractDetector<T>
-
- All Implemented Interfaces:
Serializable
,EventDetector
- Direct Known Subclasses:
AlignmentDetector
,AltitudeDetector
,AngularSeparationDetector
,ApsideDetector
,BooleanDetector
,CircularFieldOfViewDetector
,DateDetector
,EclipseDetector
,ElevationDetector
,ElevationExtremumDetector
,EventEnablingPredicateFilter
,EventShifter
,EventSlopeFilter
,FieldOfViewDetector
,FootprintOverlapDetector
,FunctionalDetector
,GeographicZoneDetector
,GroundAtNightDetector
,GroundFieldOfViewDetector
,ImpulseManeuver
,InterSatDirectViewDetector
,LatitudeCrossingDetector
,LatitudeExtremumDetector
,LongitudeCrossingDetector
,LongitudeExtremumDetector
,NegateDetector
,NodeDetector
,PositionAngleDetector
public abstract class AbstractDetector<T extends EventDetector> extends Object implements EventDetector
Common parts shared by several orbital events finders.- Author:
- Luc Maisonobe
- See Also:
Propagator.addEventDetector(EventDetector)
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_MAX_ITER
Default cmaximum number of iterations in the event time search.static double
DEFAULT_MAXCHECK
Default maximum checking interval (s).static double
DEFAULT_THRESHOLD
Default convergence threshold (s).
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractDetector(double maxCheck, double threshold, int maxIter, EventHandler<? super T> handler)
Build a new instance.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract T
create(double newMaxCheck, double newThreshold, int newMaxIter, EventHandler<? super T> newHandler)
Build a new instance.EventHandler.Action
eventOccurred(SpacecraftState s, boolean increasing)
Handle the event.abstract double
g(SpacecraftState s)
Compute the value of the switching function.EventHandler<? super T>
getHandler()
Get the handler.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.boolean
isForward()
Check if the current propagation is forward or backward.SpacecraftState
resetState(SpacecraftState oldState)
Reset the state prior to continue propagation.T
withHandler(EventHandler<? super T> newHandler)
Setup the event handler to call at event occurrences.T
withMaxCheck(double newMaxCheck)
Setup the maximum checking interval.T
withMaxIter(int newMaxIter)
Setup the maximum number of iterations in the event time search.T
withThreshold(double newThreshold)
Setup the convergence threshold.
-
-
-
Field Detail
-
DEFAULT_MAXCHECK
public static final double DEFAULT_MAXCHECK
Default maximum checking interval (s).- See Also:
- Constant Field Values
-
DEFAULT_THRESHOLD
public static final double DEFAULT_THRESHOLD
Default convergence threshold (s).- See Also:
- Constant Field Values
-
DEFAULT_MAX_ITER
public static final int DEFAULT_MAX_ITER
Default cmaximum number of iterations in the event time search.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
AbstractDetector
protected AbstractDetector(double maxCheck, double threshold, int maxIter, EventHandler<? super T> handler)
Build a new instance.- Parameters:
maxCheck
- maximum checking interval (s)threshold
- convergence threshold (s)maxIter
- maximum number of iterations in the event time searchhandler
- event handler to call at event occurrences
-
-
Method Detail
-
init
public void init(SpacecraftState s0, AbsoluteDate t)
Initialize event handler at the start of a propagation.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.
The default implementation does nothing
This implementation sets the direction of propagation and initializes the event handler. If a subclass overrides this method it should call
super.init(s0, t)
.- Specified by:
init
in interfaceEventDetector
- Parameters:
s0
- initial statet
- target time for the integration
-
g
public abstract double g(SpacecraftState s)
Compute the value of the switching function. This function must be continuous (at least in its roots neighborhood), as the integrator will need to find its roots to locate the events.- Specified by:
g
in interfaceEventDetector
- Parameters:
s
- the current state information: date, kinematics, attitude- Returns:
- value of the switching function
-
getMaxCheckInterval
public double getMaxCheckInterval()
Get maximal time interval between switching function checks.- Specified by:
getMaxCheckInterval
in interfaceEventDetector
- Returns:
- maximal time interval (s) between switching function checks
-
getMaxIterationCount
public int getMaxIterationCount()
Get maximal number of iterations in the event time search.- Specified by:
getMaxIterationCount
in interfaceEventDetector
- Returns:
- maximal number of iterations in the event time search
-
getThreshold
public double getThreshold()
Get the convergence threshold in the event time search.- Specified by:
getThreshold
in interfaceEventDetector
- Returns:
- convergence threshold (s)
-
withMaxCheck
public T withMaxCheck(double newMaxCheck)
Setup the maximum checking interval.This will override a maximum checking interval if it has been configured previously.
- Parameters:
newMaxCheck
- maximum checking interval (s)- Returns:
- a new detector with updated configuration (the instance is not changed)
- Since:
- 6.1
-
withMaxIter
public T withMaxIter(int newMaxIter)
Setup the maximum number of iterations in the event time search.This will override a number of iterations if it has been configured previously.
- Parameters:
newMaxIter
- maximum number of iterations in the event time search- Returns:
- a new detector with updated configuration (the instance is not changed)
- Since:
- 6.1
-
withThreshold
public T withThreshold(double newThreshold)
Setup the convergence threshold.This will override a convergence threshold if it has been configured previously.
- Parameters:
newThreshold
- convergence threshold (s)- Returns:
- a new detector with updated configuration (the instance is not changed)
- Since:
- 6.1
-
withHandler
public T withHandler(EventHandler<? super T> newHandler)
Setup the event handler to call at event occurrences.This will override a handler if it has been configured previously.
- Parameters:
newHandler
- event handler to call at event occurrences- Returns:
- a new detector with updated configuration (the instance is not changed)
- Since:
- 6.1
-
getHandler
public EventHandler<? super T> getHandler()
Get the handler.- Returns:
- event handler to call at event occurrences
-
eventOccurred
public EventHandler.Action eventOccurred(SpacecraftState s, boolean increasing)
Handle the event.- Specified by:
eventOccurred
in interfaceEventDetector
- Parameters:
s
- SpaceCraft state to be used in the evaluationincreasing
- with the event occurred in an "increasing" or "decreasing" slope direction- Returns:
- the Action that the calling detector should pass back to the evaluation system
-
resetState
public SpacecraftState resetState(SpacecraftState oldState)
Reset the state prior to continue propagation.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)
has itself returned theEventHandler.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 theEventDetector.eventOccurred(org.orekit.propagation.SpacecraftState, boolean)
never returns theEventHandler.Action.RESET_STATE
indicator, this function will never be called, and it is safe to simply return null.The default implementation simply returns its argument.
- Specified by:
resetState
in interfaceEventDetector
- Parameters:
oldState
- old state- Returns:
- new state
-
create
protected abstract T create(double newMaxCheck, double newThreshold, int newMaxIter, EventHandler<? super T> newHandler)
Build a new instance.- Parameters:
newMaxCheck
- maximum checking interval (s)newThreshold
- convergence threshold (s)newMaxIter
- maximum number of iterations in the event time searchnewHandler
- event handler to call at event occurrences- Returns:
- a new instance of the appropriate sub-type
-
isForward
public boolean isForward()
Check if the current propagation is forward or backward.- Returns:
- true if the current propagation is forward
- Since:
- 7.2
-
-