fr.cnes.genopus.nonWidget.events
Class CustomRelativeDateDetector

java.lang.Object
  org.orekit.propagation.events.AbstractDetector
      org.orekit.propagation.events.DateDetector
          fr.cnes.genopus.nonWidget.events.CustomDateDetector
              fr.cnes.genopus.nonWidget.events.CustomRelativeDateDetector

All Implemented Interfaces:

CustomEventDetector, Serializable, org.orekit.propagation.events.EventDetector, org.orekit.time.TimeStamped

public class CustomRelativeDateDetector
extends CustomDateDetector

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 org.orekit.propagation.events.EventDetector

org.orekit.propagation.events.EventDetector.Action

Field Summary

Fields inherited from class org.orekit.propagation.events.AbstractDetector

DEFAULT_MAXCHECK, DEFAULT_THRESHOLD

Fields inherited from interface org.orekit.propagation.events.EventDetector

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

CustomRelativeDateDetector(double relativeDate, org.orekit.time.AbsoluteDate referenceDate, org.orekit.time.TimeScale offsetTimeScale)
Constructor with target relative date and reference date. maxCheck (1.e10 s) and threshold (1.0e-9 s).

CustomRelativeDateDetector(double relativeDate, org.orekit.time.AbsoluteDate referenceDate, org.orekit.time.TimeScale offsetTimeScale, double maxCheck, double threshold, org.orekit.propagation.events.EventDetector.Action action)
Constructor with target relative date and reference date. maxCheck, threshold and action are also configurable.

Method Summary

org.orekit.time.AbsoluteDate	getReferenceDate() Getter for the reference date of the event.
double	getRelativeDate() Getter for the target relative date.
org.orekit.time.TimeScale	getTimeScale() Getter for the time scale of the event.
String	toString()

Methods inherited from class fr.cnes.genopus.nonWidget.events.CustomDateDetector

eventOccurred, getAction, getGenericCodingEventDetector, resetState

Methods inherited from class org.orekit.propagation.events.DateDetector

addEventDate, g, getDate, shouldBeRemoved

Methods inherited from class org.orekit.propagation.events.AbstractDetector

getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, init

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orekit.propagation.events.EventDetector

g, getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, init, shouldBeRemoved

Constructor Detail

CustomRelativeDateDetector

public CustomRelativeDateDetector(double relativeDate,
                                  org.orekit.time.AbsoluteDate referenceDate,
                                  org.orekit.time.TimeScale offsetTimeScale)

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.

CustomRelativeDateDetector

public CustomRelativeDateDetector(double relativeDate,
                                  org.orekit.time.AbsoluteDate referenceDate,
                                  org.orekit.time.TimeScale offsetTimeScale,
                                  double maxCheck,
                                  double threshold,
                                  org.orekit.propagation.events.EventDetector.Action action)

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.

Method Detail

getRelativeDate

public double getRelativeDate()

Getter for the target relative date.

Returns:

the target relative date.

getReferenceDate

public org.orekit.time.AbsoluteDate getReferenceDate()

Getter for the reference date of the event.

Returns:

the reference date of the event.

getTimeScale

public org.orekit.time.TimeScale getTimeScale()

Getter for the time scale of the event.

Returns:

the time scale of the event.

toString

public String toString()

Overrides:

toString in class CustomDateDetector