Package org.orekit.propagation.events

Class FieldAdapterDetector<T extends CalculusFieldElement<T>>

java.lang.Object

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

Type Parameters:

T - type of the field element

All Implemented Interfaces:

FieldEventDetector<T>

public class FieldAdapterDetector<T extends CalculusFieldElement<T>>
extends Object
implements FieldEventDetector<T>

Base class for adapting an existing detector.

This class is intended to be a base class for changing behaviour of a wrapped existing detector. This base class delegates all its methods to the wrapped detector. Classes extending it can therefore override only the methods they want to change.

Since:

12.0

Author:

Luc Maisonobe

Constructor Summary

Constructors

Constructor	Description
FieldAdapterDetector(FieldEventDetector<T> detector)	Build an adaptor wrapping an existing detector.

Method Summary

Modifier and Type	Method	Description
void	finish(FieldSpacecraftState<T> state)	This method finalizes the event detector's job.
T	g(FieldSpacecraftState<T> s)	Compute the value of the switching function.
FieldEventDetectionSettings<T>	getDetectionSettings()	Getter for the settings.
FieldEventDetector<T>	getDetector()	Get the wrapped detector.
FieldEventHandler<T>	getHandler()	Get the handler.
FieldAdaptableInterval<T>	getMaxCheckInterval()	Get maximal time interval between switching function checks.
int	getMaxIterationCount()	Get maximal number of iterations in the event time search.
T	getThreshold()	Get the convergence threshold in the event time search.
void	init(FieldSpacecraftState<T> s0, FieldAbsoluteDate<T> t)	Initialize event handler at the start of a propagation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FieldAdapterDetector

public FieldAdapterDetector(FieldEventDetector<T> detector)

Build an adaptor wrapping an existing detector.

Parameters:

detector - detector to wrap

Method Detail

getDetector

public FieldEventDetector<T> getDetector()

Get the wrapped detector.

Returns:

wrapped detector

init

public void init(FieldSpacecraftState<T> s0,
                 FieldAbsoluteDate<T> t)

Initialize event handler at the start of a propagation.

This method is called once at the start of the propagation. It may be used by the event handler to initialize some internal data if needed.

The default implementation does nothing

Specified by:

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

Parameters:

s0 - initial state

t - target time for the integration

g

public T g(FieldSpacecraftState<T> s)

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.

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

getThreshold

public T getThreshold()

Get the convergence threshold in the event time search.

Specified by:

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

Returns:

convergence threshold (s)

getMaxCheckInterval

public FieldAdaptableInterval<T> getMaxCheckInterval()

Get maximal time interval between switching function checks.

Specified by:

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

Returns:

maximal time interval (s) between switching function checks

getMaxIterationCount

public int getMaxIterationCount()

Get maximal number of iterations in the event time search.

Specified by:

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

Returns:

maximal number of iterations in the event time search

getHandler

public FieldEventHandler<T> getHandler()

Get the handler.

Specified by:

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

Returns:

event handler to call at event occurrences

finish

public void finish(FieldSpacecraftState<T> state)

This method finalizes the event detector's job.

Specified by:

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

Parameters:

state - state at propagation end

getDetectionSettings

public FieldEventDetectionSettings<T> getDetectionSettings()

Getter for the settings.

Specified by:

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

Returns:

detection settings