fr.cnes.sirius.patrius.events.detectors

Class CenteredAolPassageDetector

java.lang.Object

fr.cnes.sirius.patrius.events.AbstractDetector

fr.cnes.sirius.patrius.events.detectors.CenteredAolPassageDetector

All Implemented Interfaces:

EventDetector, Serializable

public final class CenteredAolPassageDetector
extends AbstractDetector

Centered argument of latitude detector

Author:

GMV

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface fr.cnes.sirius.patrius.events.EventDetector

EventDetector.Action

Field Summary

Fields inherited from class fr.cnes.sirius.patrius.events.AbstractDetector

actionAtEntry, actionAtExit, DEFAULT_MAXCHECK, DEFAULT_MAXITER, DEFAULT_THRESHOLD, removeAtEntry, removeAtExit, shouldBeRemovedFlag

Fields inherited from interface fr.cnes.sirius.patrius.events.EventDetector

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

Constructors

Constructor and Description
CenteredAolPassageDetector(double aol, PositionAngle positionAngle, MeanOsculatingElementsProvider provider, Frame frame) Constructor
CenteredAolPassageDetector(double aol, PositionAngle positionAngle, MeanOsculatingElementsProvider provider, Frame frame, double maxCheck, double threshold) Constructor with complementary parameters
CenteredAolPassageDetector(double aol, PositionAngle positionAngle, MeanOsculatingElementsProvider provider, Frame frame, double maxCheck, double threshold, EventDetector.Action action) Constructor with complementary parameters

Method Summary

Modifier and Type	Method and Description
Orbit	centeredToOsculating(CircularOrbit centeredOrbit) Get osculating CircularOrbit from centered counterpart
EventDetector	copy() A copy of the detector.
EventDetector.Action	eventOccurred(SpacecraftState s, boolean increasing, boolean forward) Handle an event and choose what to do next.
double	g(SpacecraftState s) Compute the value of the switching function.

Methods inherited from class fr.cnes.sirius.patrius.events.AbstractDetector

filterEvent, getActionAtEntry, getActionAtExit, getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, init, isRemoveAtEntry, isRemoveAtExit, logEventsOverTimeInterval, resetState, setMaxCheckInterval, setMaxIter, shouldBeRemoved

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CenteredAolPassageDetector

public CenteredAolPassageDetector(double aol,
                                  PositionAngle positionAngle,
                                  MeanOsculatingElementsProvider provider,
                                  Frame frame)
                           throws PatriusException

Constructor

Parameters:

aol - Centered AOL [rad] triggering the event

positionAngle - Anomaly type

provider - Converter from orbit osculating elements to mean elements

frame - the patrius frame

Throws:

PatriusException - Possible exception

CenteredAolPassageDetector

public CenteredAolPassageDetector(double aol,
                                  PositionAngle positionAngle,
                                  MeanOsculatingElementsProvider provider,
                                  Frame frame,
                                  double maxCheck,
                                  double threshold)
                           throws PatriusException

Constructor with complementary parameters

Parameters:

aol - Centered AOL [rad] triggering the event

positionAngle - Anomaly type

provider - Converter from orbit osculating elements to mean elements

frame - the patrius frame

maxCheck - Maximum check (see AbstractDetector)

threshold - Threshold (see AbstractDetector)

Throws:

PatriusException - Possible exception

CenteredAolPassageDetector

public CenteredAolPassageDetector(double aol,
                                  PositionAngle positionAngle,
                                  MeanOsculatingElementsProvider provider,
                                  Frame frame,
                                  double maxCheck,
                                  double threshold,
                                  EventDetector.Action action)

Constructor with complementary parameters

Parameters:

aol - Centered AOL [rad triggering the event

positionAngle - Anomaly type

provider - Converter from orbit osculating elements to mean elements

frame - the patrius frame

maxCheck - Maximum check (see AbstractDetector)

threshold - Threshold (see AbstractDetector)

action - Action to do when event is detected

Throws:

PatriusException - Possible exception

Method Detail

eventOccurred

public final EventDetector.Action eventOccurred(SpacecraftState s,
                                                boolean increasing,
                                                boolean forward)
                                         throws PatriusException

Handle an event and choose what to do next.

The scheduling between this method and the PatriusStepHandler method handleStep() is to call this method first and handleStep afterwards. This scheduling allows the propagator to pass true as the isLast parameter to the step handler to make it aware the step will be the last one if this method returns EventDetector.Action.STOP. As the interpolator may be used to navigate back throughout the last step (as OrekitStepNormalizer does for example), user code called by this method and user code called by step handlers may experience apparently out of order values of the independent time variable. As an example, if the same user object implements both this EventDetector interface and the OrekitFixedStepHandler interface, a forward integration may call its eventOccurred method with a state at 2000-01-01T00:00:10 first and call its handleStep method with a state at 2000-01-01T00:00:09 afterwards. Such out of order calls are limited to the size of the integration step for variable step handlers and to the size of the fixed step for fixed step handlers.

Specified by:

eventOccurred in interface EventDetector

Overrides:

eventOccurred in class AbstractDetector

Parameters:

s - the current state information: date, kinematics, attitude for forces and events computation, mass provider, and additional states

increasing - if true, the value of the switching function increases when times increases around event (note that increase is measured with respect to physical time, not with respect to propagation which may go backward in time)

forward - if true, the integration variable (time) increases during integration.

Returns:

one of EventDetector.Action.STOP, EventDetector.Action.RESET_STATE, EventDetector.Action.RESET_DERIVATIVES, EventDetector.Action.CONTINUE

Throws:

PatriusException - if some specific error occurs

g

public final double g(SpacecraftState s)
               throws PatriusException

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

Specified by:

g in class AbstractDetector

Parameters:

s - the current state information: date, kinematics, attitude for forces and events computation, mass provider, and additional states

Returns:

value of the switching function

Throws:

PatriusException - if some specific error occurs

centeredToOsculating

public Orbit centeredToOsculating(CircularOrbit centeredOrbit)
                           throws PatriusException

Get osculating CircularOrbit from centered counterpart

Parameters:

centeredOrbit - Centered orbit

Returns:

Osculating orbit

Throws:

PatriusException - Possible exception

copy

public EventDetector copy()

A copy of the detector. By default copy is deep. If not, detector javadoc will specify which attribute is not fully copied. In that case, the attribute reference is passed.

Returns:

a copy of the detector.