Package org.orekit.propagation.events

Class TimeIntervalDetector

java.lang.Object

org.orekit.propagation.events.AbstractDetector<TimeIntervalDetector>

org.orekit.propagation.events.TimeIntervalDetector

All Implemented Interfaces:

EventDetector

public class TimeIntervalDetector
extends AbstractDetector<TimeIntervalDetector>

Detector for time intervals. Positive whenever the date is inside, negative otherwise.

Since:

13.1

Author:

Romain Serra

See Also:

TimeInterval

Field Summary

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

DEFAULT_MAX_CHECK, DEFAULT_MAX_ITER, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Constructor	Description
TimeIntervalDetector(EventDetectionSettings detectionSettings, EventHandler handler, TimeInterval timeInterval)	Constructor.
TimeIntervalDetector(EventHandler handler, TimeInterval timeInterval)	Constructor with default detection settings.

Method Summary

Modifier and Type	Method	Description
protected TimeIntervalDetector	create(EventDetectionSettings detectionSettings, EventHandler newHandler)	Build a new instance.
double	g(SpacecraftState s)	Compute the value of the switching function.
TimeIntervalEventFunction	getEventFunction()	Get the event function.
TimeInterval	getTimeInterval()	Getter for the time interval.

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

checkIfForward, getDetectionSettings, getHandler, init, isForward, withDetectionSettings, 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.propagation.events.EventDetector

finish, getMaxCheckInterval, getMaxIterationCount, getThreshold, reset

Constructor Detail

TimeIntervalDetector

public TimeIntervalDetector(EventHandler handler,
                            TimeInterval timeInterval)

Constructor with default detection settings.

Parameters:

handler - event handler

timeInterval - time interval

TimeIntervalDetector

public TimeIntervalDetector(EventDetectionSettings detectionSettings,
                            EventHandler handler,
                            TimeInterval timeInterval)

Constructor.

Parameters:

detectionSettings - event detection settings

handler - event handler

timeInterval - time interval

Method Detail

getTimeInterval

public TimeInterval getTimeInterval()

Getter for the time interval.

Returns:

interval

create

protected TimeIntervalDetector create(EventDetectionSettings detectionSettings,
                                      EventHandler newHandler)

Description copied from class: AbstractDetector

Build a new instance.

Specified by:

create in class AbstractDetector<TimeIntervalDetector>

Parameters:

detectionSettings - detection settings

newHandler - event handler to call at event occurrences

Returns:

a new instance of the appropriate sub-type

getEventFunction

public TimeIntervalEventFunction getEventFunction()

Description copied from interface: EventDetector

Get the event function. It defines g both for double and Field.

Specified by:

getEventFunction in interface EventDetector

Overrides:

getEventFunction in class AbstractDetector<TimeIntervalDetector>

Returns:

event function

g

public double g(SpacecraftState s)

Description copied from interface: EventDetector

Compute the value of the switching function. This function must be continuous (at least in its roots neighborhood), as the integrator will need to find its roots to locate the events.

Parameters:

s - the current state information: date, kinematics, attitude

Returns:

value of the switching function