fr.cnes.genopus.nonWidget.events

Class CustomAOLDetector

java.lang.Object

fr.cnes.sirius.patrius.propagation.events.AbstractDetector

fr.cnes.sirius.patrius.propagation.events.AOLDetector

fr.cnes.genopus.nonWidget.events.CustomAOLDetector

All Implemented Interfaces:

CustomEventDetector, fr.cnes.sirius.patrius.propagation.events.EventDetector, Serializable

public class CustomAOLDetector
extends fr.cnes.sirius.patrius.propagation.events.AOLDetector
implements CustomEventDetector

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 fr.cnes.sirius.patrius.propagation.events.EventDetector

fr.cnes.sirius.patrius.propagation.events.EventDetector.Action

Field Summary

Fields

Modifier and Type	Field and Description
static String	AOL_DEC_STR Coding message.
static String	AOL_INC_STR Coding message.

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

DEFAULT_MAXCHECK, DEFAULT_THRESHOLD

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

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

Constructors

Constructor and Description
CustomAOLDetector(double angle, fr.cnes.sirius.patrius.orbits.PositionAngle type, fr.cnes.sirius.patrius.frames.Frame equator) 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, fr.cnes.sirius.patrius.orbits.PositionAngle type, fr.cnes.sirius.patrius.frames.Frame equator, double maxCheck, double threshold, fr.cnes.sirius.patrius.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()
fr.cnes.sirius.patrius.propagation.events.EventDetector.Action	getAction() Getter for the action to be performed in case of event detection.
String	getCodeDec() Returns code on decreasing.
String	getCodeInc() Returns code on increasing.
fr.cnes.sirius.patrius.events.CodingEventDetector	getCodingEventDetector(String incEventString, String decEventString) Get the generic coding event detectors for a given increasing and decreasing messages.
String	toString()

Methods inherited from class fr.cnes.sirius.patrius.propagation.events.AOLDetector

eventOccurred, g, getAOL, getAOLFrame, getAOLType, init, shouldBeRemoved

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

getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, resetState

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.cnes.sirius.patrius.propagation.events.EventDetector

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

Field Detail

AOL_INC_STR

public static final String AOL_INC_STR

Coding message.

See Also:

Constant Field Values

AOL_DEC_STR

public static final String AOL_DEC_STR

Coding message.

See Also:

Constant Field Values

Constructor Detail

CustomAOLDetector

public CustomAOLDetector(double angle,
                 fr.cnes.sirius.patrius.orbits.PositionAngle type,
                 fr.cnes.sirius.patrius.frames.Frame equator)

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.

CustomAOLDetector

public CustomAOLDetector(double angle,
                 fr.cnes.sirius.patrius.orbits.PositionAngle type,
                 fr.cnes.sirius.patrius.frames.Frame equator,
                 double maxCheck,
                 double threshold,
                 fr.cnes.sirius.patrius.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.

maxCheck - maximum checking interval (s).

threshold - convergence threshold (s).

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

Method Detail

getAction

public fr.cnes.sirius.patrius.propagation.events.EventDetector.Action getAction()

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

Specified by:

getAction in interface CustomEventDetector

Overrides:

getAction in class fr.cnes.sirius.patrius.propagation.events.AOLDetector

Returns:

the action to be performed in case of event detection.

toString

public String toString()

Overrides:

toString in class Object

copy

public CustomEventDetector copy()

Specified by:

copy in interface fr.cnes.sirius.patrius.propagation.events.EventDetector

Overrides:

copy in class fr.cnes.sirius.patrius.propagation.events.AOLDetector

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.

getCodeInc

public String getCodeInc()

Returns code on increasing.

Specified by:

getCodeInc in interface CustomEventDetector

Returns:

code on increasing

getCodeDec

public String getCodeDec()

Returns code on decreasing.

Specified by:

getCodeDec in interface CustomEventDetector

Returns:

code on decreasing