fr.cnes.genopus.nonWidget.events

Class IntervalOccurrenceDetectorWrapper

java.lang.Object

fr.cnes.sirius.patrius.events.detectors.IntervalOccurrenceDetector

fr.cnes.genopus.nonWidget.events.IntervalOccurrenceDetectorWrapper

All Implemented Interfaces:

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

public class IntervalOccurrenceDetectorWrapper
extends fr.cnes.sirius.patrius.events.detectors.IntervalOccurrenceDetector
implements CustomEventDetector

Temporary wrapper.

Version:

$Id: NthOccurrenceDetector.java 17582 2017-05-10 12:58:16Z bignon $

Author:

Emmanuel Bignon

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 inherited from interface fr.cnes.sirius.patrius.events.EventDetector

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

Constructors

Constructor and Description
IntervalOccurrenceDetectorWrapper(CustomEventDetector eventToDetect, int firstOccurrenceIn, int lastOccurrenceIn, int stepIn, fr.cnes.sirius.patrius.events.EventDetector.Action actionAtOccurrence) Constructor.
IntervalOccurrenceDetectorWrapper(CustomEventDetector eventToDetect, int firstOccurrenceIn, int lastOccurrenceIn, int stepIn, fr.cnes.sirius.patrius.events.EventDetector.Action actionAtOccurrence, boolean remove) Constructor.

Method Summary

Modifier and Type	Method and Description
fr.cnes.sirius.patrius.events.EventDetector	copy()
fr.cnes.sirius.patrius.events.EventDetector.Action	eventOccurred(fr.cnes.sirius.patrius.propagation.SpacecraftState s, boolean increasing, boolean forward)
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.
fr.cnes.sirius.patrius.events.postprocessing.CodingEventDetector	getCodingEventDetector(String incEventString, String decEventString, fr.cnes.sirius.patrius.events.EventDetector.Action action) Get the coding event detector for some given increasing and decreasing messages.

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

filterEvent, g, getActionAtOccurrence, getCurrentOccurrence, getEvent, getFirstOccurrence, getLastOccurrence, getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getStep, getThreshold, init, isRemoveAtOccurrence, processEventOccurrence, resetState, shouldBeRemoved, toString

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

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

Constructor Detail

IntervalOccurrenceDetectorWrapper

public IntervalOccurrenceDetectorWrapper(CustomEventDetector eventToDetect,
                                         int firstOccurrenceIn,
                                         int lastOccurrenceIn,
                                         int stepIn,
                                         fr.cnes.sirius.patrius.events.EventDetector.Action actionAtOccurrence)

Constructor.

Parameters:

eventToDetect - event to detect

firstOccurrenceIn - first occurrence of the event to detect

lastOccurrenceIn - last occurrence of the event to detect

stepIn - step between occurrences of the event to detect

actionAtOccurrence - action at event nth occurrence

IntervalOccurrenceDetectorWrapper

public IntervalOccurrenceDetectorWrapper(CustomEventDetector eventToDetect,
                                         int firstOccurrenceIn,
                                         int lastOccurrenceIn,
                                         int stepIn,
                                         fr.cnes.sirius.patrius.events.EventDetector.Action actionAtOccurrence,
                                         boolean remove)

Constructor.

Parameters:

eventToDetect - event to detect

firstOccurrenceIn - first occurrence of the event to detect

lastOccurrenceIn - last occurrence of the event to detect

stepIn - step between occurrences of the event to detect

actionAtOccurrence - action at event nth occurrence

remove - true if detector should be removed after detection of nth occurrence

Method Detail

eventOccurred

public fr.cnes.sirius.patrius.events.EventDetector.Action eventOccurred(fr.cnes.sirius.patrius.propagation.SpacecraftState s,
                                                                        boolean increasing,
                                                                        boolean forward)
                                                                 throws fr.cnes.sirius.patrius.utils.exception.PatriusException

Specified by:

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

Overrides:

eventOccurred in class fr.cnes.sirius.patrius.events.detectors.IntervalOccurrenceDetector

Throws:

fr.cnes.sirius.patrius.utils.exception.PatriusException

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

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.

getCodingEventDetector

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

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.

getCodingEventDetector

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

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

action - action

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