Package org.orekit.propagation.events

Class AdapterDetector

  • All Implemented Interfaces:
    EventDetector
    public class AdapterDetector
extends Object
implements EventDetector
    Base class for adapting an existing detector.

    This class is intended to be a base class for changing behaviour of a wrapped existing detector. This base class delegates all its methods to the wrapped detector. Classes extending it can therefore override only the methods they want to change.

    Since:
    9.3
    Author:
    Luc Maisonobe

    • Constructor Detail

      • AdapterDetector

        public AdapterDetector​(EventDetector detector)
        Build an adaptor wrapping an existing detector.
        Parameters:
        detector - detector to wrap

    • Method Detail

      • getDetector

        public EventDetector getDetector()
        Get the wrapped detector.
        Returns:
        wrapped detector

      • 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

      • finish

        public void finish​(SpacecraftState state)
        This method finalizes the event detector's job.
        Specified by:
        finish in interface EventDetector
        Parameters:
        state - state at propagation end