fr.cnes.genopus.nonWidget.events

Class CustomApsideDetector

java.lang.Object

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

fr.cnes.sirius.patrius.propagation.events.ApsideDetector

fr.cnes.genopus.nonWidget.events.CustomApsideDetector

All Implemented Interfaces:

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

public class CustomApsideDetector
extends fr.cnes.sirius.patrius.propagation.events.ApsideDetector
implements CustomEventDetector

Sub-class of Orekit's ApsideDetector 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	APS_DEC_STR Coding message.
static String	APS_INC_STR Coding message.

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

APOGEE, PERIGEE, PERIGEE_APOGEE

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

DEFAULT_MAXCHECK

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

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

Constructors

Constructor and Description
CustomApsideDetector(int slopeSelection) Constructor with target apside and trigger. maxCheck (600 s), threshold (1.0e-6 s) and action (RESET_STATE) by default.
CustomApsideDetector(int slopeSelection, 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 coding event detector for some given increasing and decreasing messages.
String	toString()

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

eventOccurred, g, getActionAtApogee, getActionAtPerigee, removeAtApogee, removeAtPerigee, shouldBeRemoved

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

getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, init, 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

APS_INC_STR

public static final String APS_INC_STR

Coding message.

See Also:

Constant Field Values

APS_DEC_STR

public static final String APS_DEC_STR

Coding message.

See Also:

Constant Field Values

Constructor Detail

CustomApsideDetector

public CustomApsideDetector(int slopeSelection)

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

Parameters:

slopeSelection - slope selection

CustomApsideDetector

public CustomApsideDetector(int slopeSelection,
                    double maxCheck,
                    double threshold,
                    fr.cnes.sirius.patrius.propagation.events.EventDetector.Action action)

Constructor with complete data.

Parameters:

slopeSelection - slope selection

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

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.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.ApsideDetector

getCodingEventDetector

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