Package org.orekit.propagation.events
Class EventDetectionSettings
- java.lang.Object
-
- org.orekit.propagation.events.EventDetectionSettings
-
public class EventDetectionSettings extends Object
Class containing parameters for event detection.- Since:
- 12.2
- Author:
- Romain Serra.
- See Also:
EventDetector
-
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_MAX_ITER
Default maximum 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 Constructor Description EventDetectionSettings(double maxCheck, double threshold, int maxIterationCount)
Constructor with maximum check as double.EventDetectionSettings(AdaptableInterval maxCheckInterval, double threshold, int maxIterationCount)
Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static EventDetectionSettings
getDefaultEventDetectionSettings()
Returns default settings for event detections.AdaptableInterval
getMaxCheckInterval()
Getter for adaptable interval.int
getMaxIterationCount()
Getter for max iter.double
getThreshold()
Getter for 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 maximum number of iterations in the event time search.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EventDetectionSettings
public EventDetectionSettings(AdaptableInterval maxCheckInterval, double threshold, int maxIterationCount)
Constructor.- Parameters:
maxCheckInterval
- adaptable intervalthreshold
- detection threshold on timemaxIterationCount
- maximum iteration number
-
EventDetectionSettings
public EventDetectionSettings(double maxCheck, double threshold, int maxIterationCount)
Constructor with maximum check as double.- Parameters:
maxCheck
- constant maximum check for adaptable intervalthreshold
- detection threshold on timemaxIterationCount
- maximum iteration number
-
-
Method Detail
-
getMaxCheckInterval
public AdaptableInterval getMaxCheckInterval()
Getter for adaptable interval.- Returns:
- adaptable interval
-
getThreshold
public double getThreshold()
Getter for threshold.- Returns:
- threshold
-
getMaxIterationCount
public int getMaxIterationCount()
Getter for max iter.- Returns:
- max iter
-
getDefaultEventDetectionSettings
public static EventDetectionSettings getDefaultEventDetectionSettings()
Returns default settings for event detections.- Returns:
- default settings
-
-