Package org.orekit.propagation.events

Class DateDetector

    • Field Detail

      • DEFAULT_MAX_CHECK

        public static final double DEFAULT_MAX_CHECK
        Default value for max check.
        Since:
        12.0
        See Also:
        Constant Field Values

      • DEFAULT_MIN_GAP

        public static final double DEFAULT_MIN_GAP
        Default value for minimum gap between added dates.
        Since:
        12.0
        See Also:
        Constant Field Values

      • DEFAULT_THRESHOLD

        public static final double DEFAULT_THRESHOLD
        Default value for convergence threshold.
        Since:
        12.0
        See Also:
        Constant Field Values

    • Constructor Detail

      • DateDetector

        @Deprecated
protected DateDetector​(AdaptableInterval maxCheck,
                       double threshold,
                       int maxIter,
                       EventHandler handler,
                       double minGap,
                       TimeStamped... dates)
        Deprecated.
        as of 12.2
        Protected constructor with full parameters.

        This constructor is not public as users are expected to use the builder API with the various withXxx() methods to set up the instance in a readable manner without using a huge amount of parameters.

        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
        minGap - minimum gap between added dates (s)
        dates - list of event dates
        Since:
        12.0

      • DateDetector

        protected DateDetector​(EventDetectionSettings detectionSettings,
                       EventHandler handler,
                       double minGap,
                       TimeStamped... dates)
        Protected constructor with full parameters.

        This constructor is not public as users are expected to use the builder API with the various withXxx() methods to set up the instance in a readable manner without using a huge amount of parameters.

        Parameters:
        detectionSettings - detection settings
        handler - event handler to call at event occurrences
        minGap - minimum gap between added dates (s)
        dates - list of event dates
        Since:
        12.2

    • Method Detail

      • withMinGap

        public DateDetector withMinGap​(double newMinGap)
        Setup minimum gap between added dates.
        Parameters:
        newMinGap - new minimum gap between added dates
        Returns:
        a new detector with updated configuration (the instance is not changed)
        Since:
        12.0

      • create

        protected DateDetector create​(AdaptableInterval newMaxCheck,
                              double newThreshold,
                              int newMaxIter,
                              EventHandler newHandler)
        Build a new instance.
        Specified by:
        create in class AbstractDetector<DateDetector>
        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 WARNING: this method will be removed in 13.0. It doesn't have the deprecated annotation because the method is abstract and shall be implemented

      • getDates

        public List<TimeStamped> getDates()
        Get all event dates currently managed, in chronological order.
        Returns:
        all event dates currently managed, in chronological order
        Since:
        11.1

      • g

        public double g​(SpacecraftState s)
        Compute the value of the switching function. This function measures the difference between the current and the target date.
        Specified by:
        g in interface EventDetector
        Parameters:
        s - the current state information: date, kinematics, attitude
        Returns:
        value of the switching function

      • getDate

        public AbsoluteDate getDate()
        Get the current event date according to the propagator.
        Specified by:
        getDate in interface TimeStamped
        Returns:
        event date

      • addEventDate

        public void addEventDate​(AbsoluteDate target)
                  throws IllegalArgumentException
        Add an event date.

        The date to add must be:

        • less than the smallest already registered event date minus the maxCheck
        • or more than the largest already registered event date plus the maxCheck
        Parameters:
        target - target date
        Throws:
        IllegalArgumentException - if the date is too close from already defined interval
        See Also:
        DateDetector(TimeStamped...)