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 final double	DEFAULT_MAX_CHECK	Default maximum checking interval (s).
static final int	DEFAULT_MAX_ITER	Default maximum number of iterations in the event time search.
static final 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

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.
EventDetectionSettings	withMaxCheckInterval(AdaptableInterval newMaxCheckInterval)	Builds a new instance with a new max. check interval.
EventDetectionSettings	withMaxIter(int newMaxIterationCount)	Builds a new instance with a new max. iteration count.
EventDetectionSettings	withThreshold(double newThreshold)	Builds a new instance with a new threshold value.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_MAX_CHECK

public static final double DEFAULT_MAX_CHECK

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 Details

EventDetectionSettings

public EventDetectionSettings(AdaptableInterval maxCheckInterval,
 double threshold,
 int maxIterationCount)

Constructor.

Parameters:

maxCheckInterval - adaptable interval

threshold - detection threshold on time

maxIterationCount - 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 interval

threshold - detection threshold on time

maxIterationCount - maximum iteration number

Method Details

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

withMaxCheckInterval

public EventDetectionSettings withMaxCheckInterval(AdaptableInterval newMaxCheckInterval)

Builds a new instance with a new max. check interval.

Parameters:

newMaxCheckInterval - new max. check.

Returns:

new object

Since:

13.0

withThreshold

public EventDetectionSettings withThreshold(double newThreshold)

Builds a new instance with a new threshold value.

Parameters:

newThreshold - detection threshold in seconds

Returns:

new object

Since:

13.0

withMaxIter

public EventDetectionSettings withMaxIter(int newMaxIterationCount)

Builds a new instance with a new max. iteration count.

Parameters:

newMaxIterationCount - new max iteration count.

Returns:

new object

Since:

13.0

getDefaultEventDetectionSettings

public static EventDetectionSettings getDefaultEventDetectionSettings()

Returns default settings for event detections.

Returns:

default settings