fr.cnes.genopus.nonWidget.events

Class CustomRecurrentDateDetector

java.lang.Object

fr.cnes.sirius.patrius.events.AbstractDetector

fr.cnes.sirius.patrius.events.detectors.DateDetector

fr.cnes.genopus.nonWidget.events.CustomRecurrentDateDetector

All Implemented Interfaces:

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

public class CustomRecurrentDateDetector
extends fr.cnes.sirius.patrius.events.detectors.DateDetector
implements CustomEventDetector

Class representing a recurrent date detector: it detects every date t from a reference date t0 such as t - t0 = n.p with p being the period of the detector.

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

Modifier and Type	Field and Description
static String	DAT_STR Coding message.

Fields inherited from class fr.cnes.sirius.patrius.events.detectors.DateDetector

DEFAULT_MAXCHECK, DEFAULT_THRESHOLD

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

actionAtEntry, actionAtExit, DEFAULT_MAXITER, removeAtEntry, removeAtExit, shouldBeRemovedFlag

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

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

Constructors

Constructor and Description
CustomRecurrentDateDetector(fr.cnes.sirius.patrius.time.AbsoluteDate referenceDate, double step) Recurrent detector constructor with default values.
CustomRecurrentDateDetector(fr.cnes.sirius.patrius.time.AbsoluteDate referenceDate, double step, double maxCheck, double threshold, fr.cnes.sirius.patrius.events.EventDetector.Action action) Recurrent detector constructor with complete data.

Method Summary

Modifier and Type	Method and Description
fr.cnes.sirius.patrius.events.EventDetector	copy()
double	g(fr.cnes.sirius.patrius.propagation.SpacecraftState s)
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 generic coding event detector for a given increasing and decreasing messages.
double	getStep() Returns the detector period.
void	init(fr.cnes.sirius.patrius.propagation.SpacecraftState s0, fr.cnes.sirius.patrius.time.AbsoluteDate t)
boolean	isRecurring() Returns true if the detector is a recurring detector.
String	toString()

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

addEventDate, eventOccurred, getAction, getDate

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

filterEvent, getActionAtEntry, getActionAtExit, getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, isRemoveAtEntry, isRemoveAtExit, logEventsOverTimeInterval, resetState, setMaxCheckInterval, setMaxIter, shouldBeRemoved

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface fr.cnes.genopus.nonWidget.events.CustomEventDetector

getAction

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

eventOccurred, filterEvent, getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, resetState, shouldBeRemoved

Field Detail

DAT_STR

public static final String DAT_STR

Coding message.

See Also:

Constant Field Values

Constructor Detail

CustomRecurrentDateDetector

public CustomRecurrentDateDetector(fr.cnes.sirius.patrius.time.AbsoluteDate referenceDate,
                                   double step)

Recurrent detector constructor with default values. maxCheck (1.0e10 s), threshold (1.0e-9 s) and action (STOP) by default.

Parameters:

referenceDate - reference date

step - period of occurrence detection

CustomRecurrentDateDetector

public CustomRecurrentDateDetector(fr.cnes.sirius.patrius.time.AbsoluteDate referenceDate,
                                   double step,
                                   double maxCheck,
                                   double threshold,
                                   fr.cnes.sirius.patrius.events.EventDetector.Action action)

Recurrent detector constructor with complete data.

Parameters:

referenceDate - target date

step - period of occurrence detection

maxCheck - maximum checking interval (s)

threshold - convergence threshold (s)

action - action to be performed in case of event detection

Method Detail

init

public void init(fr.cnes.sirius.patrius.propagation.SpacecraftState s0,
                 fr.cnes.sirius.patrius.time.AbsoluteDate t)

Specified by:

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

Overrides:

init in class fr.cnes.sirius.patrius.events.AbstractDetector

g

public double g(fr.cnes.sirius.patrius.propagation.SpacecraftState s)
         throws fr.cnes.sirius.patrius.utils.exception.PatriusException

Specified by:

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

Overrides:

g in class fr.cnes.sirius.patrius.events.detectors.DateDetector

Throws:

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

getStep

public double getStep()

Returns the detector period.

Returns:

the detector period

isRecurring

public boolean isRecurring()

Returns true if the detector is a recurring detector.

Returns:

true if the detector is a recurring detector

toString

public String toString()

Overrides:

toString in class Object

getCodingEventDetector

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

Get the generic coding event detector 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.

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

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