fr.cnes.genopus.nonWidget.events

Class CustomDateDetector

java.lang.Object

org.orekit.propagation.events.AbstractDetector

org.orekit.propagation.events.DateDetector

fr.cnes.genopus.nonWidget.events.CustomDateDetector

All Implemented Interfaces:

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

Direct Known Subclasses:

CustomRelativeDateDetector

public class CustomDateDetector
extends org.orekit.propagation.events.DateDetector
implements CustomEventDetector

Sub-class of Orekit's DateDetector class to be able to change the action to be performed in case of 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

Constructors

Constructor and Description
CustomDateDetector(org.orekit.time.AbsoluteDate date) Constructor with target date. maxCheck (1.0e10 s), threshold (1.0e-9 s) and action (STOP) by default.
CustomDateDetector(org.orekit.time.AbsoluteDate date, double maxCheck, double threshold, org.orekit.propagation.events.EventDetector.Action action) Constructor with complete data.

Method Summary

Methods

Modifier and Type	Method and Description
org.orekit.propagation.events.EventDetector	copy() Returns a new instance of the current type of CustomEventDetector with the same attributes but for the action which is set to Action#CONTINUE.
org.orekit.propagation.events.EventDetector.Action	eventOccurred(org.orekit.propagation.SpacecraftState s, boolean increasing, boolean forward)
org.orekit.propagation.events.EventDetector.Action	getAction() Getter for the action to be performed in case of event detection.
fr.cnes.sirius.patrius.events.CodingEventDetector	getCodingEventDetector(String incEventString, String decEventString) Get the generic coding event detector for a given increasing and decreasing messages.
org.orekit.propagation.SpacecraftState	resetState(org.orekit.propagation.SpacecraftState oldState)
String	toString()

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

CustomDateDetector

public CustomDateDetector(org.orekit.time.AbsoluteDate date)

Constructor with target date. maxCheck (1.0e10 s), threshold (1.0e-9 s) and action (STOP) by default.

Parameters:

date - target date.

CustomDateDetector

public CustomDateDetector(org.orekit.time.AbsoluteDate date,
                  double maxCheck,
                  double threshold,
                  org.orekit.propagation.events.EventDetector.Action action)

Constructor with complete data.

Parameters:

date - target date.

maxCheck - maximum checking interval (s).

threshold - convergence threshold (s).

action - action to be performed in case of event detection.

Method Detail

getAction

public org.orekit.propagation.events.EventDetector.Action getAction()

Getter for the action to be performed in case of event detection.

Specified by:

getAction in interface CustomEventDetector

Returns:

the action to be performed in case of event detection.

eventOccurred

public org.orekit.propagation.events.EventDetector.Action eventOccurred(org.orekit.propagation.SpacecraftState s,
                                                               boolean increasing,
                                                               boolean forward)

Specified by:

eventOccurred in interface org.orekit.propagation.events.EventDetector

Overrides:

eventOccurred in class org.orekit.propagation.events.DateDetector

resetState

public org.orekit.propagation.SpacecraftState resetState(org.orekit.propagation.SpacecraftState oldState)

Specified by:

resetState in interface org.orekit.propagation.events.EventDetector

Overrides:

resetState in class org.orekit.propagation.events.AbstractDetector

toString

public String toString()

Overrides:

toString in class Object

getCodingEventDetector

public fr.cnes.sirius.patrius.events.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 org.orekit.propagation.events.EventDetector copy()

Returns a new instance of the current type of CustomEventDetector with the same attributes but for the action which is set to Action#CONTINUE. It is intended to be used to create the CodingEventDetector.

Specified by:

copy in interface CustomEventDetector

Returns:

a new instance with equal attributes but with Action#CONTINUE