Package org.orekit.propagation.events

Class FieldParameterDrivenDateIntervalDetector<T extends CalculusFieldElement<T>>

java.lang.Object

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

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

Type Parameters:

T - type of the field elements

All Implemented Interfaces:

FieldEventDetector<T>

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

Detector for date intervals that may be offset thanks to parameter drivers.

Two dual views can be used for date intervals: either start date/stop date or median date/duration. start/stop drivers and median/duration drivers work in pair. Both drivers in one pair can be selected and their changes will be propagated to the other pair, but attempting to select drivers in both pairs at the same time will trigger an exception. Changing the value of a driver that is not selected should be avoided as it leads to inconsistencies between the pairs.

Since:

11.1

Author:

Luc Maisonobe

See Also:

• Propagator.addEventDetector(EventDetector)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DURATION_SUFFIX	Default suffix for duration driver.
static final String	MEDIAN_SUFFIX	Default suffix for median driver.
static final String	START_SUFFIX	Default suffix for start driver.
static final String	STOP_SUFFIX	Default suffix for stop driver.

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

DEFAULT_MAX_CHECK, DEFAULT_MAX_ITER, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Modifier	Constructor	Description
	FieldParameterDrivenDateIntervalDetector(Field<T> field, String prefix, AbsoluteDate refMedian, double refDuration)	Build a new instance.
	FieldParameterDrivenDateIntervalDetector(Field<T> field, String prefix, AbsoluteDate refStart, AbsoluteDate refStop)	Build a new instance.
protected	FieldParameterDrivenDateIntervalDetector(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> handler, DateDriver start, DateDriver stop, DateDriver median, ParameterDriver duration)	Protected constructor with full parameters.

Method Summary

Modifier and Type	Method	Description
protected FieldParameterDrivenDateIntervalDetector<T>	create(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> newHandler)	Build a new instance.
T	g(FieldSpacecraftState<T> s)	Compute the value of the switching function.
ParameterDriver	getDurationDriver()	Get the driver for duration.
EventFunction	getEventFunction()	Get the event function.
DateDriver	getMedianDriver()	Get the driver for median date.
DateDriver	getStartDriver()	Get the driver for start date.
DateDriver	getStopDriver()	Get the driver for stop date.
ParameterDrivenDateIntervalDetector	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

Field Details

START_SUFFIX

public static final String START_SUFFIX

Default suffix for start driver.

See Also:

• Constant Field Values

STOP_SUFFIX

public static final String STOP_SUFFIX

Default suffix for stop driver.

See Also:

• Constant Field Values

MEDIAN_SUFFIX

public static final String MEDIAN_SUFFIX

Default suffix for median driver.

See Also:

• Constant Field Values

DURATION_SUFFIX

public static final String DURATION_SUFFIX

Default suffix for duration driver.

See Also:

• Constant Field Values

Constructor Details

FieldParameterDrivenDateIntervalDetector

public FieldParameterDrivenDateIntervalDetector(Field<T> field,
 String prefix,
 AbsoluteDate refMedian,
 double refDuration)

Build a new instance.

Parameters:

field - field to which the elements belong

prefix - prefix to use for parameter drivers names

refMedian - reference interval median date

refDuration - reference duration

FieldParameterDrivenDateIntervalDetector

public FieldParameterDrivenDateIntervalDetector(Field<T> field,
 String prefix,
 AbsoluteDate refStart,
 AbsoluteDate refStop)

Build a new instance.

Parameters:

field - field to which the elements belong

prefix - prefix to use for parameter drivers names

refStart - reference interval start date

refStop - reference interval stop date

FieldParameterDrivenDateIntervalDetector

protected FieldParameterDrivenDateIntervalDetector(FieldEventDetectionSettings<T> detectionSettings,
 FieldEventHandler<T> handler,
 DateDriver start,
 DateDriver stop,
 DateDriver median,
 ParameterDriver duration)

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:

detectionSettings - event detection settings

handler - event handler to call at event occurrences

start - reference interval start driver

stop - reference interval stop driver

median - median date driver

duration - duration driver

Since:

13.0

Method Details

create

protected FieldParameterDrivenDateIntervalDetector<T> create(FieldEventDetectionSettings<T> detectionSettings,
 FieldEventHandler<T> newHandler)

Build a new instance.

Specified by:

create in class FieldAbstractDetector<FieldParameterDrivenDateIntervalDetector<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

getStartDriver

public DateDriver getStartDriver()

Get the driver for start date.

Note that the start date is automatically adjusted if either median date or duration are selected and changed.

Returns:

driver for start date

getStopDriver

public DateDriver getStopDriver()

Get the driver for stop date.

Note that the stop date is automatically adjusted if either median date or duration are selected changed.

Returns:

driver for stop date

getMedianDriver

public DateDriver getMedianDriver()

Get the driver for median date.

Note that the median date is automatically adjusted if either getStartDriver() start date or stop date are selected changed.

Returns:

driver for median date

getDurationDriver

public ParameterDriver getDurationDriver()

Get the driver for duration.

Note that the duration is automatically adjusted if either getStartDriver() start date or stop date are selected changed.

Returns:

driver for duration

getEventFunction

public EventFunction 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<FieldParameterDrivenDateIntervalDetector<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>>

Returns:

event function

g

public T g(FieldSpacecraftState<T> s)

Compute the value of the switching function.

The function is positive for dates within the interval defined by applying the parameter drivers shifts to reference dates, and negative for dates outside of this interval. Note that if Δt_start - Δt_stop is less than ref_stop.durationFrom(ref_start), then the interval degenerates to empty and the function never reaches positive values.

Parameters:

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

Returns:

value of the switching function

toEventDetector

public ParameterDrivenDateIntervalDetector toEventDetector(EventHandler eventHandler)

Build non-Field instance.

Overrides:

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

Parameters:

eventHandler - event handler

Returns:

event detector