fr.cnes.genopus.nonWidget.events
Class CustomLocalTimeDetector

java.lang.Object
  org.orekit.propagation.events.AbstractDetector
      org.orekit.propagation.events.LocalTimeDetector
          fr.cnes.genopus.nonWidget.events.CustomLocalTimeDetector

All Implemented Interfaces:

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

public class CustomLocalTimeDetector
extends org.orekit.propagation.events.LocalTimeDetector
implements CustomTriggeredEventDetector

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

Author:

aadt

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

CustomLocalTimeDetector(double localTime, org.orekit.frames.Frame bodyFrame, int triggerCount)
Constructor with target local time and body shape. maxCheck (600 s), threshold (1.0e-6 s) and action (RESET_STATE) by default.

CustomLocalTimeDetector(double localTime, org.orekit.frames.Frame bodyFrame, 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.
int	getTriggerCount() Getter for the count from which the event must be triggered.
org.orekit.propagation.SpacecraftState	resetState(org.orekit.propagation.SpacecraftState oldState)
String	toString()

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

g, getBodyFrame, getTime, init, shouldBeRemoved

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

getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold

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

CustomLocalTimeDetector

public CustomLocalTimeDetector(double localTime,
                               org.orekit.frames.Frame bodyFrame,
                               int triggerCount)
                        throws org.orekit.errors.OrekitException

Constructor with target local time and body shape. maxCheck (600 s), threshold (1.0e-6 s) and action (RESET_STATE) by default.

Parameters:

localTime - satellite local time triggering the event (rad).

bodyFrame - the central body attached frame (in witch the local Time is defined).

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

Throws:

org.orekit.errors.OrekitException - error when loading the ephemeris files

CustomLocalTimeDetector

public CustomLocalTimeDetector(double localTime,
                               org.orekit.frames.Frame bodyFrame,
                               int triggerCount,
                               double maxCheck,
                               double threshold,
                               org.orekit.propagation.events.EventDetector.Action action)
                        throws org.orekit.errors.OrekitException

Constructor with complete data.

Parameters:

localTime - satellite local time triggering the event (rad).

bodyFrame - the central body attached frame (in witch the local Time is defined).

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.

Throws:

org.orekit.errors.OrekitException - error when loading the ephemeris files

Method Detail

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.LocalTimeDetector

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