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

Constructors

Constructor and Description
CustomAOLDetector(double angle, org.orekit.orbits.PositionAngle type, org.orekit.frames.Frame equator, int triggerFrom, Integer triggerStep, Integer triggerTo) 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 triggerFrom, Integer triggerStep, Integer triggerTo, double maxCheck, double threshold, org.orekit.propagation.events.EventDetector.Action action) Constructor with target AOL, AOL type (true, mean or eccentric) and equatorial frame. maxCheck, threshold and action are also configurable.

Method Summary

Methods

Modifier and Type	Method and Description
CustomEventDetector	copy() Returns a new instance of the current type of CustomEventDetector with the same attributes but for the action which is set to Action#CONTINUE.
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.
fr.cnes.sirius.patrius.events.CodingEventDetector	getCodingEventDetector(String incEventString, String decEventString) Get the generic coding event detectors for a given increasing and decreasing messages.
org.orekit.frames.Frame	getEquator() Getter for the equator frame with respect to which the AOL is to be computed.
int	getTriggerFrom() Getter for the count from which the event must be triggered.
Integer	getTriggerStep() Getter for the step every which the event must be triggered.
Integer	getTriggerTo() Getter for the count until which the event must be triggered.
CustomEventDetectorTrigger.TriggeringType	getTriggerType() Getter for the trigger type, that is, the slope of the switching function that must trigger the event.
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 triggerFrom,
                 Integer triggerStep,
                 Integer triggerTo)

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.

triggerFrom - count at/from which the single/multiple event must be triggered.

triggerStep - step every which the multiple event must be triggered. If null, the event will be triggered only once at the occurrence given by triggerFrom.

triggerTo - count until which the multiple event must be triggered. If null, the event will be triggered until the end of propagation.

CustomAOLDetector

public CustomAOLDetector(double angle,
                 org.orekit.orbits.PositionAngle type,
                 org.orekit.frames.Frame equator,
                 int triggerFrom,
                 Integer triggerStep,
                 Integer triggerTo,
                 double maxCheck,
                 double threshold,
                 org.orekit.propagation.events.EventDetector.Action action)

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.

triggerFrom - count at/from which the single/multiple event must be triggered.

triggerStep - step every which the multiple event must be triggered. If null, the event will be triggered only once at the occurrence given by triggerFrom.

triggerTo - count until which the multiple event must be triggered. If null, the event will be triggered until the end of propagation.

maxCheck - maximum checking interval (s).

threshold - convergence threshold (s).

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

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.

getTriggerFrom

public int getTriggerFrom()

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

Specified by:

getTriggerFrom in interface CustomTriggeredEventDetector

Returns:

the count from which the event must be triggered.

getTriggerStep

public Integer getTriggerStep()

Getter for the step every which the event must be triggered. If null the event is triggered only once.

Specified by:

getTriggerStep in interface CustomTriggeredEventDetector

Returns:

the step every which the event must be triggered.

getTriggerTo

public Integer getTriggerTo()

Getter for the count until which the event must be triggered. If null, the event is triggered until the end of propagation.

Specified by:

getTriggerTo in interface CustomTriggeredEventDetector

Returns:

the count until 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)

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

copy

public CustomEventDetector copy()

Returns a new instance of the current type of CustomEventDetector with the same attributes but for the action which is set to Action#CONTINUE. It is intended to be used to create the CodingEventDetector.

Specified by:

copy in interface CustomEventDetector

Returns:

a new instance with equal attributes but with Action#CONTINUE

getCodingEventDetector

public fr.cnes.sirius.patrius.events.CodingEventDetector getCodingEventDetector(String incEventString,
                                                                       String decEventString)

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

Specified by:

getCodingEventDetector in interface CustomEventDetector

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.

getTriggerType

public CustomEventDetectorTrigger.TriggeringType getTriggerType()

Getter for the trigger type, that is, the slope of the switching function that must trigger the event. The options are CustomEventDetectorTrigger.TriggeringType.INCREASING for increasing slope, CustomEventDetectorTrigger.TriggeringType.DECREASING for decreasing slope and CustomEventDetectorTrigger.TriggeringType.BOTH for increasing or decreasing slope of the switching function.

Specified by:

getTriggerType in interface CustomTriggeredEventDetector

Returns:

the trigger type.