Class AbstractDetector<T extends AbstractDetector<T>>

    • 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

      • AbstractDetector

        protected AbstractDetector​(double maxCheck,
                                   double threshold,
                                   int maxIter,
                                   EventHandler handler)
        Build a new instance.
        Parameters:
        maxCheck - maximum checking interval, must be strictly positive (s)
        threshold - convergence threshold (s)
        maxIter - maximum number of iterations in the event time search
        handler - event handler to call at event occurrences
      • AbstractDetector

        @Deprecated
        protected AbstractDetector​(AdaptableInterval maxCheck,
                                   double threshold,
                                   int maxIter,
                                   EventHandler handler)
        Deprecated.
        as of 12.2
        Build a new instance.
        Parameters:
        maxCheck - maximum checking interval
        threshold - convergence threshold (s)
        maxIter - maximum number of iterations in the event time search
        handler - event handler to call at event occurrences
        Since:
        12.0
      • AbstractDetector

        protected AbstractDetector​(EventDetectionSettings detectionSettings,
                                   EventHandler handler)
        Build a new instance.
        Parameters:
        detectionSettings - event detection settings
        handler - event handler to call at event occurrences
        Since:
        12.2
    • 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 interface EventDetector
        Parameters:
        s0 - initial state
        t - target time for the integration
      • getMaxCheckInterval

        public AdaptableInterval getMaxCheckInterval()
        Get maximal time interval between switching function checks.
        Specified by:
        getMaxCheckInterval in interface EventDetector
        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 interface EventDetector
        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 interface EventDetector
        Returns:
        convergence threshold (s)
      • withMaxCheck

        public T withMaxCheck​(double newMaxCheck)
        Set up 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
      • withMaxCheck

        public T withMaxCheck​(AdaptableInterval newMaxCheck)
        Set up 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:
        12.0
      • withMaxIter

        public T withMaxIter​(int newMaxIter)
        Set up 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)
        Set up 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
      • withDetectionSettings

        public T withDetectionSettings​(EventDetectionSettings newSettings)
        Set up the event detection settings.

        This will override settings previously configured.

        Parameters:
        newSettings - new event detection settings
        Returns:
        a new detector with updated configuration (the instance is not changed)
        Since:
        12.2
      • withHandler

        public T withHandler​(EventHandler newHandler)
        Set up 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
      • create

        @Deprecated
        protected abstract T create​(AdaptableInterval newMaxCheck,
                                    double newThreshold,
                                    int newMaxIter,
                                    EventHandler newHandler)
        Deprecated.
        as of 12.2. Will be removed in 13.0 and only the other signature shall remain
        Build a new instance.
        Parameters:
        newMaxCheck - maximum checking interval (s)
        newThreshold - convergence threshold (s)
        newMaxIter - maximum number of iterations in the event time search
        newHandler - event handler to call at event occurrences
        Returns:
        a new instance of the appropriate sub-type
      • create

        protected T create​(EventDetectionSettings detectionSettings,
                           EventHandler newHandler)
        Build a new instance.
        Parameters:
        detectionSettings - detection settings
        newHandler - event handler to call at event occurrences
        Returns:
        a new instance of the appropriate sub-type
        Since:
        12.2
      • isForward

        public boolean isForward()
        Check if the current propagation is forward or backward.
        Returns:
        true if the current propagation is forward
        Since:
        7.2