fr.cnes.genopus.nonWidget.events

Class CustomEclipseDetector

java.lang.Object

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

fr.cnes.sirius.patrius.propagation.events.EclipseDetector

fr.cnes.genopus.nonWidget.events.CustomEclipseDetector

All Implemented Interfaces:

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

public class CustomEclipseDetector
extends fr.cnes.sirius.patrius.propagation.events.EclipseDetector
implements CustomEventDetector

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

Author:

ffsm

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	ECL_DEC_STR Coding message.
static String	ECL_INC_STR Coding message.

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

ENTRY, ENTRY_EXIT, EXIT

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
CustomEclipseDetector(int slopeSelection, double occultingBodyRadius) Constructor with target eclipse and trigger. maxCheck (600 s), threshold (1.0e-6 s) and action (RESET_STATE) by default.
CustomEclipseDetector(int slopeSelection, double occultingBodyRadius, double maxCheck, double threshold, fr.cnes.sirius.patrius.propagation.events.EventDetector.Action action) Constructor with complete data.

Method Summary

Methods

Modifier and Type	Method and Description
fr.cnes.sirius.patrius.propagation.events.EventDetector	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.
double	getOccultingBodyRadius() Getter for the occulting body radius (the Earth).
fr.cnes.sirius.patrius.propagation.SpacecraftState	resetState(fr.cnes.sirius.patrius.propagation.SpacecraftState oldState)
String	toString()

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

eventOccurred, g, getActionAtEntry, getActionAtExit, getOcculted, getOccultedDirection, getOccultedRadius, getOcculting, getOccultingRadiusProvider, isTotalEclipse, removeAtEntry, removeAtExit, shouldBeRemoved

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

getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, init

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, shouldBeRemoved

Field Detail

ECL_INC_STR

public static final String ECL_INC_STR

Coding message.

See Also:

Constant Field Values

ECL_DEC_STR

public static final String ECL_DEC_STR

Coding message.

See Also:

Constant Field Values

Constructor Detail

CustomEclipseDetector

public CustomEclipseDetector(int slopeSelection,
                     double occultingBodyRadius)
                      throws ArithmeticException

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

Parameters:

slopeSelection - slope selection

occultingBodyRadius - the occulting body radius (m)

Throws:

ArithmeticException - if occultingBodyRadius is NaN.

CustomEclipseDetector

public CustomEclipseDetector(int slopeSelection,
                     double occultingBodyRadius,
                     double maxCheck,
                     double threshold,
                     fr.cnes.sirius.patrius.propagation.events.EventDetector.Action action)
                      throws ArithmeticException

Constructor with complete data.

Parameters:

slopeSelection - slope selection

occultingBodyRadius - the occulting body radius (m)

maxCheck - maximum checking interval (s).

threshold - convergence threshold (s).

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

Throws:

ArithmeticException - if occultingBodyRadius is NaN.

Method Detail

getOccultingBodyRadius

public double getOccultingBodyRadius()

Getter for the occulting body radius (the Earth).

Returns:

the Earth's equatorial radius.

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

Returns:

the action to be performed in case of event detection.

resetState

public fr.cnes.sirius.patrius.propagation.SpacecraftState resetState(fr.cnes.sirius.patrius.propagation.SpacecraftState oldState)

Specified by:

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

Overrides:

resetState in class fr.cnes.sirius.patrius.propagation.events.AbstractDetector

toString

public String toString()

Overrides:

toString in class Object

copy

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

Specified by:

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

Overrides:

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

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