fr.cnes.sirius.patrius.events.detectors

Class RelativeDateDetector

java.lang.Object

fr.cnes.sirius.patrius.events.AbstractDetector

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

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

All Implemented Interfaces:

EventDetector, TimeStamped, Serializable

public class RelativeDateDetector
extends DateDetector

Date detector defined by relative date.

Since:

4.1

Version:

$Id: NullMassPartDetector.java 18094 2017-10-02 17:18:57Z bignon $

Author:

Marie Capot

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface fr.cnes.sirius.patrius.events.EventDetector

EventDetector.Action

Field Summary

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
RelativeDateDetector(double relativeDateIn, AbsoluteDate referenceDateIn, TimeScale offsetTimeScale) Constructor with target relative date and reference date. maxCheck (1.e10 s) and threshold (1.0e-9 s).
RelativeDateDetector(double relativeDateIn, AbsoluteDate referenceDateIn, TimeScale offsetTimeScale, double maxCheck, double threshold, EventDetector.Action action) Constructor with target relative date and reference date. maxCheck, threshold and action are also configurable.

Method Summary

Modifier and Type	Method and Description
EventDetector	copy() A copy of the detector.
AbsoluteDate	getReferenceDate() Getter for the reference date of the event.
double	getRelativeDate() Getter for the target relative date in seconds.
TimeScale	getTimeScale() Getter for the time scale of the event.

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

addEventDate, eventOccurred, g, getAction, 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, toString, wait, wait, wait

Constructor Detail

RelativeDateDetector

public RelativeDateDetector(double relativeDateIn,
                            AbsoluteDate referenceDateIn,
                            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:

relativeDateIn - target relative date to find.

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

RelativeDateDetector

public RelativeDateDetector(double relativeDateIn,
                            AbsoluteDate referenceDateIn,
                            TimeScale offsetTimeScale,
                            double maxCheck,
                            double threshold,
                            EventDetector.Action action)
                     throws ArithmeticException

Constructor with target relative date and reference date. maxCheck, threshold and action are also configurable.

Parameters:

relativeDateIn - target relative date.

referenceDateIn - 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

getRelativeDate

public double getRelativeDate()

Getter for the target relative date in seconds.

Returns:

the target relative date in seconds.

getReferenceDate

public AbsoluteDate getReferenceDate()

Getter for the reference date of the event.

Returns:

the reference date of the event.

getTimeScale

public TimeScale getTimeScale()

Getter for the time scale of the event.

Returns:

the time scale of the event.

copy

public EventDetector copy()

A copy of the detector. By default copy is deep. If not, detector javadoc will specify which attribute is not fully copied. In that case, the attribute reference is passed.

Specified by:

copy in interface EventDetector

Overrides:

copy in class DateDetector

Returns:

a copy of the detector.