Package org.orekit.propagation.events

Class FieldTimeIntervalDetector<T extends CalculusFieldElement<T>>

java.lang.Object

org.orekit.propagation.events.FieldAbstractDetector<FieldTimeIntervalDetector<T>,T>

org.orekit.propagation.events.FieldTimeIntervalDetector<T>

All Implemented Interfaces:

FieldEventDetector<T>

public class FieldTimeIntervalDetector<T extends CalculusFieldElement<T>>
extends FieldAbstractDetector<FieldTimeIntervalDetector<T>,T>

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

Since:

13.1

Author:

Romain Serra

See Also:

TimeInterval, TimeIntervalDetector

Field Summary

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

DEFAULT_MAX_CHECK, DEFAULT_MAX_ITER, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Constructor	Description
FieldTimeIntervalDetector(Field<T> field, TimeInterval timeInterval)	Constructor with default detection settings and handler.
FieldTimeIntervalDetector(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> handler, TimeInterval timeInterval)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected FieldTimeIntervalDetector<T>	create(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> newHandler)	Build a new instance.
T	g(FieldSpacecraftState<T> s)	Compute the value of the switching function.
TimeIntervalEventFunction	getEventFunction()	Get the event function.
TimeInterval	getTimeInterval()	Getter for the time interval.
TimeIntervalDetector	toEventDetector(EventHandler eventHandler)	Build non-Field instance.

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

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.FieldEventDetector

finish, getMaxCheckInterval, getMaxIterationCount, getThreshold, reset

Constructor Detail

FieldTimeIntervalDetector

public FieldTimeIntervalDetector(Field<T> field,
                                 TimeInterval timeInterval)

Constructor with default detection settings and handler.

Parameters:

field - field

timeInterval - time interval

FieldTimeIntervalDetector

public FieldTimeIntervalDetector(FieldEventDetectionSettings<T> detectionSettings,
                                 FieldEventHandler<T> 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 FieldTimeIntervalDetector<T> create(FieldEventDetectionSettings<T> detectionSettings,
                                              FieldEventHandler<T> newHandler)

Description copied from class: FieldAbstractDetector

Build a new instance.

Specified by:

create in class FieldAbstractDetector<FieldTimeIntervalDetector<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>>

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: FieldEventDetector

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

Specified by:

getEventFunction in interface FieldEventDetector<T extends CalculusFieldElement<T>>

Overrides:

getEventFunction in class FieldAbstractDetector<FieldTimeIntervalDetector<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>>

Returns:

event function

g

public T g(FieldSpacecraftState<T> s)

Description copied from interface: FieldEventDetector

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

toEventDetector

public TimeIntervalDetector toEventDetector(EventHandler eventHandler)

Description copied from class: FieldAbstractDetector

Build non-Field instance.

Overrides:

toEventDetector in class FieldAbstractDetector<FieldTimeIntervalDetector<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>>

Parameters:

eventHandler - event handler

Returns:

event detector