Package org.orekit.propagation.events

Class FieldDateDetector<T extends CalculusFieldElement<T>>

java.lang.Object

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

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

Type Parameters:

T - type of the field elements

All Implemented Interfaces:

FieldEventDetector<T>, FieldTimeStamped<T>

public class FieldDateDetector<T extends CalculusFieldElement<T>>
extends FieldAbstractDetector<FieldDateDetector<T>,T>
implements FieldTimeStamped<T>

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 (FieldDateDetector(Field, FieldTimeStamped...))
• several dates can be added (addEventDate(FieldAbsoluteDate))

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 calling FieldAbstractDetector.withHandler(FieldEventHandler) after construction.

Author:

Luc Maisonobe, Pascal Parraud

See Also:

• FieldPropagator.addEventDetector(FieldEventDetector)

Field Summary

Fields

Modifier and Type	Field	Description
static final double	DEFAULT_MAX_CHECK	Default value for max check.
static final double	DEFAULT_MIN_GAP	Default value for minimum gap between added dates.
static final double	DEFAULT_THRESHOLD	Default value for convergence threshold.

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

DEFAULT_MAX_ITER

Constructor Summary

Constructors

Modifier	Constructor	Description
	FieldDateDetector(Field<T> field, FieldTimeStamped<T>... dates)	Build a new instance.
protected	FieldDateDetector(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> handler, double minGap, FieldTimeStamped<T>... dates)	Protected constructor with full parameters.
	FieldDateDetector(FieldAbsoluteDate<T> fieldAbsoluteDate)	Build a new instance from a fielded date.

Method Summary

Modifier and Type	Method	Description
void	addEventDate(FieldAbsoluteDate<T> target)	Add an event date.
protected FieldDateDetector<T>	create(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> newHandler)	Build a new instance.
T	g(FieldSpacecraftState<T> s)	Compute the value of the switching function.
FieldAbsoluteDate<T>	getDate()	Get the current event date according to the propagator.
List<FieldTimeStamped<T>>	getDates()	Get all event field dates currently managed, in chronological order.
EventFunction	getEventFunction()	Get the event function.
DateDetector	toEventDetector(EventHandler eventHandler)	Build non-Field instance.
FieldDateDetector<T>	withMinGap(double newMinGap)	Setup minimum gap between added dates.

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

Methods inherited from interface org.orekit.time.FieldTimeStamped

durationFrom, durationFrom

Field Details

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 Details

FieldDateDetector

public FieldDateDetector(FieldAbsoluteDate<T> fieldAbsoluteDate)

Build a new instance from a fielded date.

Parameters:

fieldAbsoluteDate - fielded date

Since:

13.0

FieldDateDetector

@SafeVarargs
public FieldDateDetector(Field<T> field,
 FieldTimeStamped<T>... dates)

Build a new instance.

First event dates are set here, but others can be added later with addEventDate(FieldAbsoluteDate).

Parameters:

field - field to which dates belong

dates - list of event dates

Since:

12.0

See Also:

• addEventDate(FieldAbsoluteDate)

FieldDateDetector

@SafeVarargs
protected FieldDateDetector(FieldEventDetectionSettings<T> detectionSettings,
 FieldEventHandler<T> handler,
 double minGap,
 FieldTimeStamped<T>... 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:

detectionSettings - event detection settings

handler - event handler to call at event occurrences

minGap - minimum gap between added dates (s)

dates - list of event dates

Method Details

withMinGap

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

Build a new instance.

Specified by:

create in class FieldAbstractDetector<FieldDateDetector<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 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<FieldDateDetector<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>>

Returns:

event function

getDates

public List<FieldTimeStamped<T>> getDates()

Get all event field dates currently managed, in chronological order.

Returns:

all event field dates currently managed, in chronological order

Since:

12.0

g

public T g(FieldSpacecraftState<T> s)

Compute the value of the switching function. This function measures the difference between the current and the target date.

Specified by:

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

Parameters:

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

Returns:

value of the switching function

getDate

public FieldAbsoluteDate<T> getDate()

Get the current event date according to the propagator.

Specified by:

getDate in interface FieldTimeStamped<T extends CalculusFieldElement<T>>

Returns:

event date

toEventDetector

public DateDetector toEventDetector(EventHandler eventHandler)

Build non-Field instance.

Overrides:

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

Parameters:

eventHandler - event handler

Returns:

event detector

addEventDate

public void addEventDate(FieldAbsoluteDate<T> 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:

• FieldDateDetector(Field, FieldTimeStamped...)