Class EventDetectionSettings


  • public class EventDetectionSettings
    extends Object
    Class containing parameters for event detection.
    Since:
    12.2
    Author:
    Romain Serra.
    See Also:
    EventDetector
    • 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 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 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