Package org.orekit.propagation.events

Interface DetectorModifier

All Superinterfaces:
EventDetector
All Known Implementing Classes:
AttitudesSequence.Switch, AttitudesSwitcher.InstantaneousSwitch, EventEnablingPredicateFilter, EventShifter, ImpulseManeuver, LongitudeCrossingDetector, ManeuverTriggerDetector, NegateDetector
public interface DetectorModifier extends EventDetector
Base class for modifying 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:
13.0
Author:
Luc Maisonobe, Romain Serra

  • Method Details

    • getDetector

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

    • init

      default void init(SpacecraftState s0, AbsoluteDate t)
      Initialize event detector 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 initializes the handler.

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

    • reset

      default void reset(SpacecraftState state, AbsoluteDate target)
      Reset the event detector during propagation when the state is modified by an event or an additional data provider.

      The default implementation does nothing.

      Specified by:
      reset in interface EventDetector
      Parameters:
      state - current state
      target - target time for the integration

    • getEventFunction

      default EventFunction getEventFunction()
      Get the event function. It defines g both for double and Field.
      Specified by:
      getEventFunction in interface EventDetector
      Returns:
      event function

    • g

      default 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

    • getHandler

      default EventHandler getHandler()
      Get the handler.
      Specified by:
      getHandler in interface EventDetector
      Returns:
      event handler to call at event occurrences

    • finish

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

    • getDetectionSettings

      default EventDetectionSettings getDetectionSettings()
      Getter for the settings.
      Specified by:
      getDetectionSettings in interface EventDetector
      Returns:
      detection settings