fr.cnes.genopus.nonWidget.events

Interface CustomEventDetector

All Superinterfaces:

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

All Known Implementing Classes:

CustomAltitudeDetector, CustomAOLDetector, CustomApsideDetector, CustomDateDetector, CustomEclipseDetector, CustomLocalTimeDetector, CustomNodeDetector, CustomRecurrentDateDetector, CustomRecurrentRelativeDateDetector, CustomRelativeDateDetector, CustomVisibilityFromStationDetector, IntervalOccurrenceDetectorWrapper, NthOccurrenceDetectorWrapper

public interface CustomEventDetector
extends fr.cnes.sirius.patrius.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 fr.cnes.sirius.patrius.events.EventDetector

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

Field Summary

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

DECREASING, INCREASING, INCREASING_DECREASING

Method Summary

Modifier and Type	Method and Description
fr.cnes.sirius.patrius.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.postprocessing.CodingEventDetector	getCodingEventDetector(String incEventString, String decEventString) Get the coding event detector for some given increasing and decreasing messages.

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

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

Method Detail

getAction

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

getCodingEventDetector

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

getCodeInc

String getCodeInc()

Returns code on increasing.

Returns:

code on increasing

getCodeDec

String getCodeDec()

Returns code on decreasing.

Returns:

code on decreasing