fr.cnes.genopus.nonWidget.events

Class CustomRelativeDateDetector

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

All Implemented Interfaces:

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

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

Class implementing a Relative Date detector with a configurable action on event detection.

Author:

aadt

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 double	DEFAULT_MAXCHECK Default maxCheck threshold (s).
static double	DEFAULT_THRESHOLD Default convergence threshold (s).
static String	RDA_DEC_STR Coding message.
static String	RDA_INC_STR Coding message.

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

Method Summary

Modifier and Type	Method and Description
fr.cnes.sirius.patrius.events.EventDetector	copy()
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.
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, g, getDate

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

filterEvent, getActionAtEntry, getActionAtExit, getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, init, 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, g, getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, init, resetState, shouldBeRemoved

Field Detail

RDA_INC_STR

public static final String RDA_INC_STR

Coding message.

See Also:

Constant Field Values

RDA_DEC_STR

public static final String RDA_DEC_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

CustomRelativeDateDetector

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

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.

Throws:

ArithmeticException - if relativeDate is NaN or if referenceDate contains NaN.

CustomRelativeDateDetector

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

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.

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

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

getAction

public fr.cnes.sirius.patrius.events.EventDetector.Action getAction()

Description copied from interface: CustomEventDetector

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