fr.cnes.genopus.nonWidget.events
Class CustomEclipseDetector

java.lang.Object
  org.orekit.propagation.events.AbstractDetector
      org.orekit.propagation.events.EclipseDetector
          fr.cnes.genopus.nonWidget.events.CustomEclipseDetector

All Implemented Interfaces:

CustomEventDetector, CustomTriggeredEventDetector, Serializable, org.orekit.propagation.events.EventDetector

public class CustomEclipseDetector
extends org.orekit.propagation.events.EclipseDetector
implements CustomTriggeredEventDetector

Sub-class of Orekit's EclipseDetector class to be able to change the action to be performed in case of event detection.

Author:

ffsm

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.orekit.propagation.events.EventDetector

org.orekit.propagation.events.EventDetector.Action

Field Summary

Fields inherited from class org.orekit.propagation.events.AbstractDetector

DEFAULT_MAXCHECK, DEFAULT_THRESHOLD

Fields inherited from interface org.orekit.propagation.events.EventDetector

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

CustomEclipseDetector(int eventType, double occultingBodyRadius, int triggerCount)
Constructor with target eclipse and trigger. maxCheck (600 s), threshold (1.0e-6 s) and action (RESET_STATE) by default.

CustomEclipseDetector(int eventType, double occultingBodyRadius, int triggerCount, double maxCheck, double threshold, org.orekit.propagation.events.EventDetector.Action action)
Constructor with complete data.

Method Summary

org.orekit.propagation.events.EventDetector.Action	eventOccurred(org.orekit.propagation.SpacecraftState s, boolean increasing, boolean forward)
org.orekit.propagation.events.EventDetector.Action	getAction() Getter for the action to be performed in case of event detection.
double	getOccultingBodyRadius() Getter for the occulting body radius (the Earth).
int	getTriggerCount() Getter for the count from which the event must be triggered.
int	getType() Getter for the type of event (0-entering, 1-exiting, 2-entering or exiting).
org.orekit.propagation.SpacecraftState	resetState(org.orekit.propagation.SpacecraftState oldState)
String	toString()

Methods inherited from class org.orekit.propagation.events.EclipseDetector

g, getOcculted, getOccultedDirection, getOccultedRadius, getOcculting, isTotalEclipse, shouldBeRemoved

Methods inherited from class org.orekit.propagation.events.AbstractDetector

getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, init

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orekit.propagation.events.EventDetector

g, getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, init, shouldBeRemoved

Constructor Detail

CustomEclipseDetector

public CustomEclipseDetector(int eventType,
                             double occultingBodyRadius,
                             int triggerCount)

Constructor with target eclipse and trigger. maxCheck (600 s), threshold (1.0e-6 s) and action (RESET_STATE) by default.

Parameters:

eventType - event type (0-entering, 1-entering, 2-entering and exiting)

occultingBodyRadius - the occulting body radius (m)

triggerCount - for successive event ocurrences, count for which the event must be triggered.

CustomEclipseDetector

public CustomEclipseDetector(int eventType,
                             double occultingBodyRadius,
                             int triggerCount,
                             double maxCheck,
                             double threshold,
                             org.orekit.propagation.events.EventDetector.Action action)

Constructor with complete data.

Parameters:

eventType - event type (0-entering, 1-entering, 2-entering and exiting)

occultingBodyRadius - the occulting body radius (m)

triggerCount - for successive event ocurrences, count for which the event must be triggered.

maxCheck - maximum checking interval (s).

threshold - convergence threshold (s).

action - action to be performed in case of event detection.

Method Detail

getType

public int getType()

Getter for the type of event (0-entering, 1-exiting, 2-entering or exiting).

Returns:

the type of event (0-entering, 1-entering, 2-entering and exiting).

getOccultingBodyRadius

public double getOccultingBodyRadius()

Getter for the occulting body radius (the Earth).

Returns:

the Earth's equatorial radius.

getTriggerCount

public int getTriggerCount()

Getter for the count from which the event must be triggered.

Specified by:

getTriggerCount in interface CustomTriggeredEventDetector

Returns:

the count from which the event must be triggered.

getAction

public org.orekit.propagation.events.EventDetector.Action getAction()

Getter for the action to be performed in case of event detection.

Specified by:

getAction in interface CustomEventDetector

Returns:

the action to be performed in case of event detection.

eventOccurred

public org.orekit.propagation.events.EventDetector.Action eventOccurred(org.orekit.propagation.SpacecraftState s,
                                                                        boolean increasing,
                                                                        boolean forward)
                                                                 throws org.orekit.errors.OrekitException

Specified by:

eventOccurred in interface org.orekit.propagation.events.EventDetector

Overrides:

eventOccurred in class org.orekit.propagation.events.EclipseDetector

Throws:

org.orekit.errors.OrekitException

resetState

public org.orekit.propagation.SpacecraftState resetState(org.orekit.propagation.SpacecraftState oldState)

Specified by:

resetState in interface org.orekit.propagation.events.EventDetector

Overrides:

resetState in class org.orekit.propagation.events.AbstractDetector

toString

public String toString()

Overrides:

toString in class Object