fr.cnes.genopus.nonWidget.events

Class CustomAltitudeDetector

java.lang.Object

fr.cnes.sirius.patrius.events.AbstractDetector

fr.cnes.sirius.patrius.events.detectors.AltitudeDetector

fr.cnes.genopus.nonWidget.events.CustomAltitudeDetector

All Implemented Interfaces:

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

public class CustomAltitudeDetector
extends fr.cnes.sirius.patrius.events.detectors.AltitudeDetector
implements CustomEventDetector

Sub-class of Orekit's AltitudeDetector 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.events.EventDetector

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALT_DEC_STR Coding message.
static String	ALT_INC_STR Coding message.

Fields inherited from class fr.cnes.sirius.patrius.events.detectors.AltitudeDetector

ASCENDING, ASCENDING_DESCENDING, DESCENDING

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

actionAtEntry, actionAtExit, DEFAULT_MAXCHECK, DEFAULT_MAXITER, DEFAULT_THRESHOLD, removeAtEntry, removeAtExit, shouldBeRemovedFlag

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

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

Constructors

Constructor and Description
CustomAltitudeDetector(int slopeSelection, double altitude, fr.cnes.sirius.patrius.bodies.OneAxisEllipsoid bodyShape) Constructor with target altitude and body shape.
CustomAltitudeDetector(int slopeSelection, double altitude, fr.cnes.sirius.patrius.bodies.OneAxisEllipsoid bodyShape, double maxCheck, double threshold, fr.cnes.sirius.patrius.events.EventDetector.Action action) Constructor with complete data.

Method Summary

Modifier and Type	Method and Description
fr.cnes.sirius.patrius.events.EventDetector	copy()
fr.cnes.sirius.patrius.events.EventDetector.Action	getAction() Getter for the action to be performed in case of event detection.
fr.cnes.sirius.patrius.bodies.OneAxisEllipsoid	getBodyShape()
String	getCodeDec() Returns code on decreasing.
String	getCodeInc() Returns code on increasing.
fr.cnes.sirius.patrius.events.postprocessing.CodingEventDetector	getCodingEventDetector(String incEventString, String decEventString) Get the coding event detector for some given increasing and decreasing messages.
String	toString()

Methods inherited from class fr.cnes.sirius.patrius.events.detectors.AltitudeDetector

eventOccurred, g, getAltitude

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

filterEvent, getActionAtEntry, getActionAtExit, getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, init, isRemoveAtEntry, isRemoveAtExit, logEventsOverTimeInterval, resetState, setMaxCheckInterval, setMaxIter, shouldBeRemoved

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.events.EventDetector

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

Field Detail

ALT_INC_STR

public static final String ALT_INC_STR

Coding message.

See Also:

Constant Field Values

ALT_DEC_STR

public static final String ALT_DEC_STR

Coding message.

See Also:

Constant Field Values

Constructor Detail

CustomAltitudeDetector

public CustomAltitudeDetector(int slopeSelection,
                              double altitude,
                              fr.cnes.sirius.patrius.bodies.OneAxisEllipsoid bodyShape)

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

Parameters:

slopeSelection - slopeSelection

altitude - target altitude.

bodyShape - central body shape.

CustomAltitudeDetector

public CustomAltitudeDetector(int slopeSelection,
                              double altitude,
                              fr.cnes.sirius.patrius.bodies.OneAxisEllipsoid bodyShape,
                              double maxCheck,
                              double threshold,
                              fr.cnes.sirius.patrius.events.EventDetector.Action action)

Constructor with complete data.

Parameters:

slopeSelection - slopeSelection

altitude - target altitude.

bodyShape - central body shape.

maxCheck - maximum checking interval (s).

threshold - convergence threshold (s).

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

Method Detail

getBodyShape

public fr.cnes.sirius.patrius.bodies.OneAxisEllipsoid getBodyShape()

Overrides:

getBodyShape in class fr.cnes.sirius.patrius.events.detectors.AltitudeDetector

getAction

public fr.cnes.sirius.patrius.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.

toString

public String toString()

Overrides:

toString in class Object

copy

public fr.cnes.sirius.patrius.events.EventDetector copy()

Specified by:

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

Overrides:

copy in class fr.cnes.sirius.patrius.events.detectors.AltitudeDetector

getCodingEventDetector

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

Description copied from interface: CustomEventDetector

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

Specified by:

getCodingEventDetector in interface CustomEventDetector

Parameters:

incEventString - message to be included at the beginning of the message log when the detector is triggered with increasing g function

decEventString - message to be included at the beginning of the message 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