Package org.orekit.propagation.events
Class DateDetector
- java.lang.Object
-
- org.orekit.propagation.events.AbstractDetector<DateDetector>
-
- org.orekit.propagation.events.DateDetector
-
- All Implemented Interfaces:
EventDetector
,TimeStamped
public class DateDetector extends AbstractDetector<DateDetector> implements TimeStamped
Finder for date events.This class finds date events (i.e. occurrence of some predefined dates).
As of version 5.1, it is an enhanced date detector:
- it can be defined without prior date (
DateDetector(TimeStamped...)
) - several dates can be added (
addEventDate(AbsoluteDate)
)
The gap between the added dates must be more than the minGap.
The default implementation behavior is to
stop
propagation at the first event date occurrence. This can be changed by callingAbstractDetector.withHandler(EventHandler)
after construction.- Author:
- Luc Maisonobe, Pascal Parraud
- See Also:
Propagator.addEventDetector(EventDetector)
-
-
Field Summary
Fields Modifier and Type Field Description static double
DEFAULT_MAX_CHECK
Default value for max check.static double
DEFAULT_MIN_GAP
Default value for minimum gap between added dates.static double
DEFAULT_THRESHOLD
Default value for convergence threshold.-
Fields inherited from class org.orekit.propagation.events.AbstractDetector
DEFAULT_MAX_ITER, DEFAULT_MAXCHECK
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
DateDetector(AdaptableInterval maxCheck, double threshold, int maxIter, EventHandler handler, double minGap, TimeStamped... dates)
Protected constructor with full parameters.DateDetector(TimeStamped... dates)
Build a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addEventDate(AbsoluteDate target)
Add an event date.protected DateDetector
create(AdaptableInterval newMaxCheck, double newThreshold, int newMaxIter, EventHandler newHandler)
Build a new instance.double
g(SpacecraftState s)
Compute the value of the switching function.AbsoluteDate
getDate()
Get the current event date according to the propagator.List<TimeStamped>
getDates()
Get all event dates currently managed, in chronological order.DateDetector
withMinGap(double newMinGap)
Setup minimum gap between added dates.-
Methods inherited from class org.orekit.propagation.events.AbstractDetector
getHandler, getMaxCheckInterval, getMaxIterationCount, getThreshold, init, isForward, withHandler, withMaxCheck, withMaxCheck, withMaxIter, withThreshold
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.orekit.time.TimeStamped
durationFrom
-
-
-
-
Field Detail
-
DEFAULT_MAX_CHECK
public static final double DEFAULT_MAX_CHECK
Default value for max check.- Since:
- 12.0
- See Also:
- Constant Field Values
-
DEFAULT_MIN_GAP
public static final double DEFAULT_MIN_GAP
Default value for minimum gap between added dates.- Since:
- 12.0
- See Also:
- Constant Field Values
-
DEFAULT_THRESHOLD
public static final double DEFAULT_THRESHOLD
Default value for convergence threshold.- Since:
- 12.0
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
DateDetector
public DateDetector(TimeStamped... dates)
Build a new instance.First event dates are set here, but others can be added later with
addEventDate(AbsoluteDate)
.- Parameters:
dates
- list of event dates- Since:
- 12.0
- See Also:
addEventDate(AbsoluteDate)
-
DateDetector
protected DateDetector(AdaptableInterval maxCheck, double threshold, int maxIter, EventHandler handler, double minGap, TimeStamped... dates)
Protected constructor with full parameters.This constructor is not public as users are expected to use the builder API with the various
withXxx()
methods to set up the instance in a readable manner without using a huge amount of parameters.- Parameters:
maxCheck
- maximum checking intervalthreshold
- convergence threshold (s)maxIter
- maximum number of iterations in the event time searchhandler
- event handler to call at event occurrencesminGap
- minimum gap between added dates (s)dates
- list of event dates- Since:
- 12.0
-
-
Method Detail
-
withMinGap
public DateDetector withMinGap(double newMinGap)
Setup minimum gap between added dates.- Parameters:
newMinGap
- new minimum gap between added dates- Returns:
- a new detector with updated configuration (the instance is not changed)
- Since:
- 12.0
-
create
protected DateDetector create(AdaptableInterval newMaxCheck, double newThreshold, int newMaxIter, EventHandler newHandler)
Build a new instance.- Specified by:
create
in classAbstractDetector<DateDetector>
- Parameters:
newMaxCheck
- maximum checking interval (s)newThreshold
- convergence threshold (s)newMaxIter
- maximum number of iterations in the event time searchnewHandler
- event handler to call at event occurrences- Returns:
- a new instance of the appropriate sub-type
-
getDates
public List<TimeStamped> getDates()
Get all event dates currently managed, in chronological order.- Returns:
- all event dates currently managed, in chronological order
- Since:
- 11.1
-
g
public double g(SpacecraftState s)
Compute the value of the switching function. This function measures the difference between the current and the target date.- Specified by:
g
in interfaceEventDetector
- Specified by:
g
in classAbstractDetector<DateDetector>
- Parameters:
s
- the current state information: date, kinematics, attitude- Returns:
- value of the switching function
-
getDate
public AbsoluteDate getDate()
Get the current event date according to the propagator.- Specified by:
getDate
in interfaceTimeStamped
- Returns:
- event date
-
addEventDate
public void addEventDate(AbsoluteDate target) throws IllegalArgumentException
Add an event date.The date to add must be:
- less than the smallest already registered event date minus the maxCheck
- or more than the largest already registered event date plus the maxCheck
- Parameters:
target
- target date- Throws:
IllegalArgumentException
- if the date is too close from already defined interval- See Also:
DateDetector(TimeStamped...)
-
-