fr.cnes.genopus.nonWidget.events

Interface CustomEventDetector

All Superinterfaces:

org.orekit.propagation.events.EventDetector, Serializable

All Known Subinterfaces:

CustomTriggeredEventDetector

All Known Implementing Classes:

CustomAltitudeDetector, CustomAOLDetector, CustomApsideDetector, CustomDateDetector, CustomEclipseDetector, CustomLocalTimeDetector, CustomNodeDetector, CustomRelativeDateDetector, CustomVisibilityFromStationDetector

public interface CustomEventDetector
extends org.orekit.propagation.events.EventDetector

Interface to be implemented by custom detectors defining method to get its action. The getAction method definition should be added to EventDetector PATRIUS interface.

Author:

ffsm

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 interface org.orekit.propagation.events.EventDetector

DECREASING, INCREASING, INCREASING_DECREASING

Method Summary

Methods

Modifier and Type	Method and Description
org.orekit.propagation.events.EventDetector	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	getAction() Getter for the action to be performed in case of event detection.
fr.cnes.sirius.patrius.events.CodingEventDetector	getCodingEventDetector(String incEventString, String decEventString) Get the coding event detector for some given increasing and decreasing messages.

Methods inherited from interface org.orekit.propagation.events.EventDetector

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

Method Detail

getAction

org.orekit.propagation.events.EventDetector.Action getAction()

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

Returns:

the action to be performed in case of event detection.

copy

org.orekit.propagation.events.EventDetector 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.

Returns:

a new instance with equal attributes but with Action#CONTINUE

getCodingEventDetector

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

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

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.