fr.cnes.sirius.patrius.progmission

Class ProgDetectorUtils

java.lang.Object

fr.cnes.sirius.patrius.progmission.ProgDetectorUtils

public final class ProgDetectorUtils
extends Object

Class used to compute the interval lists associated to detectors (rather the phenomena derived from them) for a given propagator and propagation interval.
The event detectors will be wrapped with coding event detectors that will be added to the propagator.

Since:

4.17

Author:

vermeulenp, guillemettem

Constructor Summary

Constructors

Constructor and Description
ProgDetectorUtils(EventDetector detector, AbsoluteDateInterval interval, Propagator propagator) Simple constructor with only one detector.
ProgDetectorUtils(EventDetector detector, AbsoluteDateInterval interval, Propagator propagator, boolean increasingIsStart) Constructor with only one detector.
ProgDetectorUtils(List<EventDetector> detectorList, AbsoluteDateInterval interval, Propagator propagator) Simple constructor with multiple detectors.
ProgDetectorUtils(List<EventDetector> detectorList, AbsoluteDateInterval interval, Propagator propagator, boolean[] increasingIsStart) Constructor with multiple detectors.

Method Summary

Modifier and Type	Method and Description
Map<EventDetector,List<AbsoluteDateInterval>>	getIntervals() Retrieve the cached map linking each event detector provided to the instance and the list of the intervals of their associated phenomenon.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgDetectorUtils

public ProgDetectorUtils(EventDetector detector,
                         AbsoluteDateInterval interval,
                         Propagator propagator)

Simple constructor with only one detector.
Use the default value increasingIsStart = true.

Parameters:

detector - Event detector

interval - Propagation interval

propagator - Propagator

ProgDetectorUtils

public ProgDetectorUtils(EventDetector detector,
                         AbsoluteDateInterval interval,
                         Propagator propagator,
                         boolean increasingIsStart)

Constructor with only one detector.

Parameters:

detector - Event detector

interval - Propagation interval

propagator - Propagator

increasingIsStart - true if increasing of the g function represents the "beginning" of the associated phenomenon, false otherwise

ProgDetectorUtils

public ProgDetectorUtils(List<EventDetector> detectorList,
                         AbsoluteDateInterval interval,
                         Propagator propagator)

Simple constructor with multiple detectors.
The default value for increasingIsStart being used is an array filled with true.

Parameters:

detectorList - Event detectors list

interval - Propagation interval

propagator - Propagator

ProgDetectorUtils

public ProgDetectorUtils(List<EventDetector> detectorList,
                         AbsoluteDateInterval interval,
                         Propagator propagator,
                         boolean[] increasingIsStart)

Constructor with multiple detectors.

Parameters:

detectorList - Event detectors list

interval - Propagation interval

propagator - Propagator

increasingIsStart - Array of booleans where true means that the increasing of the g function represents the "beginning" of the associated phenomenon, false otherwise

Method Detail

getIntervals

public Map<EventDetector,List<AbsoluteDateInterval>> getIntervals()
                                                           throws PatriusException

Retrieve the cached map linking each event detector provided to the instance and the list of the intervals of their associated phenomenon.
Compute said map if it's the first time it is called.

Returns:

the map linking each event detector provided to the instance and the list of the intervals of their associated phenomenon

Throws:

PatriusException - if an error occurs during the propagation