fr.cnes.genopus.nonWidget.events

Class CustomRecurrentRelativeDateDetector

java.lang.Object

fr.cnes.sirius.patrius.events.AbstractDetector

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

fr.cnes.sirius.patrius.events.detectors.RelativeDateDetector

fr.cnes.genopus.nonWidget.events.CustomRecurrentRelativeDateDetector

All Implemented Interfaces:

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

public class CustomRecurrentRelativeDateDetector
extends fr.cnes.sirius.patrius.events.detectors.RelativeDateDetector
implements CustomEventDetector

Class representing a recurrent relative 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.
static double	DEFAULT_MAXCHECK Default maxCheck threshold (s).
static double	DEFAULT_THRESHOLD Default convergence threshold (s).

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
CustomRecurrentRelativeDateDetector(double relativeDate, fr.cnes.sirius.patrius.time.AbsoluteDate referenceDate, fr.cnes.sirius.patrius.time.TimeScale offsetTimeScale, double step) Recurrent detector constructor with target relative date and reference date.
CustomRecurrentRelativeDateDetector(double relativeDate, fr.cnes.sirius.patrius.time.AbsoluteDate referenceDate, fr.cnes.sirius.patrius.time.TimeScale offsetTimeScale, double step, double maxCheck, double threshold, fr.cnes.sirius.patrius.events.EventDetector.Action action) Recurrent detector constructor with target relative date and reference date.

Method Summary

Modifier and Type	Method and Description
fr.cnes.sirius.patrius.events.EventDetector	copy()
double	g(fr.cnes.sirius.patrius.propagation.SpacecraftState s)
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 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.RelativeDateDetector

getReferenceDate, getRelativeDate, getTimeScale

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

addEventDate, eventOccurred, 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.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

DEFAULT_THRESHOLD

public static final double DEFAULT_THRESHOLD

Default convergence threshold (s).

See Also:

Constant Field Values

DEFAULT_MAXCHECK

public static final double DEFAULT_MAXCHECK

Default maxCheck threshold (s).

See Also:

Constant Field Values

Constructor Detail

CustomRecurrentRelativeDateDetector

public CustomRecurrentRelativeDateDetector(double relativeDate,
                                           fr.cnes.sirius.patrius.time.AbsoluteDate referenceDate,
                                           fr.cnes.sirius.patrius.time.TimeScale offsetTimeScale,
                                           double step)
                                    throws ArithmeticException

Recurrent detector constructor with target relative date and reference date. maxCheck (1.e10 s) and threshold (1.0e-9 s). Default action after event detection RESET_STATE.

Parameters:

relativeDate - target relative date to find

referenceDate - reference date of the event

offsetTimeScale - time scale in which the relativeDate is expressed

step - period of occurrence detection

Throws:

ArithmeticException - if relativeDate is NaN or if referenceDate contains NaN

CustomRecurrentRelativeDateDetector

public CustomRecurrentRelativeDateDetector(double relativeDate,
                                           fr.cnes.sirius.patrius.time.AbsoluteDate referenceDate,
                                           fr.cnes.sirius.patrius.time.TimeScale offsetTimeScale,
                                           double step,
                                           double maxCheck,
                                           double threshold,
                                           fr.cnes.sirius.patrius.events.EventDetector.Action action)
                                    throws ArithmeticException

Recurrent detector constructor with target relative date and reference date. maxCheck, threshold and action are also configurable.

Parameters:

relativeDate - target relative date

referenceDate - reference date of the event

offsetTimeScale - time scale in which the relativeDate is expressed

step - period of occurrence detection

maxCheck - maximum checking interval (s)

threshold - convergence threshold (s)

action - action to be performed in case of event detection

Throws:

ArithmeticException - if referenceDate contains NaN or if relativeDate is NaN

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

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

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

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

Overrides:

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

Returns:

the action to be performed in case of event detection.

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