fr.cnes.genopus.nonWidget.events
Class CustomAOLDetector

java.lang.Object
  org.orekit.propagation.events.AbstractDetector
      org.orekit.propagation.events.AOLDetector
          fr.cnes.genopus.nonWidget.events.CustomAOLDetector

All Implemented Interfaces:

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

public class CustomAOLDetector
extends org.orekit.propagation.events.AOLDetector
implements CustomTriggeredEventDetector

Sub-class of Orekit's AOLDetector 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

CustomAOLDetector(double angle, org.orekit.orbits.PositionAngle type, org.orekit.frames.Frame equator, int triggerCount, boolean shouldBeRemovedOnOccurrence)
Constructor with target AOL, AOL type (true, mean or eccentric) and equatorial frame. maxCheck (600 s) and threshold (1.0e-6 s) by default.

CustomAOLDetector(double angle, org.orekit.orbits.PositionAngle type, org.orekit.frames.Frame equator, int triggerCount, double maxCheck, double threshold, org.orekit.propagation.events.EventDetector.Action action, boolean shouldBeRemovedOnOccurrence)
Constructor with target AOL, AOL type (true, mean or eccentric) and equatorial frame. maxCheck, threshold and action are also configurable.

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	getAngle() Getter for the target AOL.
org.orekit.frames.Frame	getEquator() Getter for the equator frame with respect to which the AOL is to be computed.
fr.cnes.sirius.patrius.events.GenericCodingEventDetector	getGenericCodingEventDetector(String incEventString, String decEventString) Get the generic coding event detector for a given increasing and decreasing messages.
boolean	getShouldBeRemovedAtOccurrence() Getter for the flag to set if the event should be removed after first occurrence.
int	getTriggerCount() Getter for the count from which the event must be triggered.
org.orekit.orbits.PositionAngle	getType() Getter for the target AOL type (true, mean, eccentric).
org.orekit.propagation.SpacecraftState	resetState(org.orekit.propagation.SpacecraftState oldState)
boolean	shouldBeRemoved()
String	toString()

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

g, getAOL, getAOLFrame, getAOLType, init

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

Constructor Detail

CustomAOLDetector

public CustomAOLDetector(double angle,
                         org.orekit.orbits.PositionAngle type,
                         org.orekit.frames.Frame equator,
                         int triggerCount,
                         boolean shouldBeRemovedOnOccurrence)

Constructor with target AOL, AOL type (true, mean or eccentric) and equatorial frame. maxCheck (600 s) and threshold (1.0e-6 s) by default. Default action after event detection RESET_STATE.

Parameters:

angle - the AOL angle to find.

type - the type of AOL angle (true, mean or eccentric).

equator - the equatorial frame with respect to which the AOL is to be computed.

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

shouldBeRemovedOnOccurrence - for successive event occurrences, false if the event shouldn't be removed, true if the event should be removed

CustomAOLDetector

public CustomAOLDetector(double angle,
                         org.orekit.orbits.PositionAngle type,
                         org.orekit.frames.Frame equator,
                         int triggerCount,
                         double maxCheck,
                         double threshold,
                         org.orekit.propagation.events.EventDetector.Action action,
                         boolean shouldBeRemovedOnOccurrence)

Constructor with target AOL, AOL type (true, mean or eccentric) and equatorial frame. maxCheck, threshold and action are also configurable.

Parameters:

angle - the AOL angle to find.

type - the type of AOL angle (true, mean or eccentric).

equator - the equatorial frame with respect to which the AOL is to be computed.

triggerCount - for successive event occurrences, 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.

shouldBeRemovedOnOccurrence - for successive event occurrences, false if the event shouldn't be removed, true if the event should be removed

Method Detail

getAngle

public double getAngle()

Getter for the target AOL.

Returns:

the target AOL.

getType

public org.orekit.orbits.PositionAngle getType()

Getter for the target AOL type (true, mean, eccentric).

Returns:

the target AOL type (true, mean, eccentric).

getEquator

public org.orekit.frames.Frame getEquator()

Getter for the equator frame with respect to which the AOL is to be computed.

Returns:

the equator frame with respect to which the AOL is to be computed.

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.

getShouldBeRemovedAtOccurrence

public boolean getShouldBeRemovedAtOccurrence()

Getter for the flag to set if the event should be removed after first occurrence.

Returns:

the flag indicating if the event should be removed after first occurrence

eventOccurred

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

Specified by:

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

Overrides:

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

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

shouldBeRemoved

public boolean shouldBeRemoved()

Specified by:

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

Overrides:

shouldBeRemoved in class org.orekit.propagation.events.AOLDetector

getGenericCodingEventDetector

public fr.cnes.sirius.patrius.events.GenericCodingEventDetector getGenericCodingEventDetector(String incEventString,
                                                                                              String decEventString)

Get the generic coding event detector for a given increasing and decreasing messages.

Parameters:

incEventString - message for the log when the detector is triggered with increasing g function

decEventString - message for the log when the detector is triggered with decreasing g function

Returns:

the generic coding event detector with equal attributes as the original event detector.