Class AttitudesSequence.Switch

    • Method Detail

      • getThreshold

        public double getThreshold()
        Get the convergence threshold in the event time search.
        Specified by:
        getThreshold in interface EventDetector
        Returns:
        convergence threshold (s)
      • 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
      • 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

        Specified by:
        init in interface EventDetector
        Parameters:
        s0 - initial state
        t - target time for the integration
      • g

        public double g​(SpacecraftState s)
        Compute the value of the switching function. This function must be continuous (at least in its roots neighborhood), as the integrator will need to find its roots to locate the events.
        Specified by:
        g in interface EventDetector
        Parameters:
        s - the current state information: date, kinematics, attitude
        Returns:
        value of the switching function
      • eventOccurred

        public Action eventOccurred​(SpacecraftState s,
                                    EventDetector detector,
                                    boolean increasing)
        Handle an event.
        Specified by:
        eventOccurred in interface EventHandler
        Parameters:
        s - SpaceCraft state to be used in the evaluation
        detector - object with appropriate type that can be used in determining correct return state
        increasing - with the event occurred in an "increasing" or "decreasing" slope direction
        Returns:
        the Action that the calling detector should pass back to the evaluation system