Package org.orekit.forces.maneuvers.trigger

Class AbstractManeuverTriggers.FieldTriggerHandler<S extends CalculusFieldElement<S>>

java.lang.Object

org.orekit.forces.maneuvers.trigger.AbstractManeuverTriggers.FieldTriggerHandler<S>

Type Parameters:

S - type of the field elements

All Implemented Interfaces:

FieldEventHandler<S>

Enclosing class:

AbstractManeuverTriggers

protected abstract class AbstractManeuverTriggers.FieldTriggerHandler<S extends CalculusFieldElement<S>>
extends Object
implements FieldEventHandler<S>

Local abstract handler for triggers, with a cache for the reset.

Since:

13.1

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FieldTriggerHandler()

Method Summary

Modifier and Type	Method	Description
protected Action	determineAction(FieldEventDetector<S> detector, FieldSpacecraftState<S> oldState)	Determines the action (reset state or derivatives only).
void	init(FieldSpacecraftState<S> initialState, FieldAbsoluteDate<S> target, FieldEventDetector<S> detector)	Initialize event handler at the start of a propagation.
protected boolean	isForward()	Getter for flag.
FieldSpacecraftState<S>	resetState(FieldEventDetector<S> detector, FieldSpacecraftState<S> oldState)	Reset the state prior to continue propagation.

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.handlers.FieldEventHandler

eventOccurred, finish

Constructor Details

FieldTriggerHandler

protected FieldTriggerHandler()

Method Details

init

public void init(FieldSpacecraftState<S> initialState,
 FieldAbsoluteDate<S> target,
 FieldEventDetector<S> detector)

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 FieldEventHandler<S extends CalculusFieldElement<S>>

Parameters:

initialState - initial state

target - target date for the propagation

detector - event detector related to the event handler

determineAction

protected Action determineAction(FieldEventDetector<S> detector,
 FieldSpacecraftState<S> oldState)

Determines the action (reset state or derivatives only).

Parameters:

detector - event detector

oldState - state before reset if any

Returns:

action

resetState

public FieldSpacecraftState<S> resetState(FieldEventDetector<S> detector,
 FieldSpacecraftState<S> oldState)

Reset the state prior to continue propagation.

This method is called after the step handler has returned and before the next step is started, but only when FieldEventHandler.eventOccurred(org.orekit.propagation.FieldSpacecraftState<T>, org.orekit.propagation.events.FieldEventDetector<T>, boolean) has itself returned the Action.RESET_STATE indicator. It allows the user to reset the state for the next step, without perturbing the step handler of the finishing step. If the FieldEventHandler.eventOccurred(org.orekit.propagation.FieldSpacecraftState<T>, org.orekit.propagation.events.FieldEventDetector<T>, boolean) never returns the Action.RESET_STATE indicator, this function will never be called, and it is safe to simply return null.

The default implementation simply return its argument.

Specified by:

resetState in interface FieldEventHandler<S extends CalculusFieldElement<S>>

Parameters:

detector - object with appropriate type that can be used in determining correct return state

oldState - old state

Returns:

new state

isForward

protected boolean isForward()

Getter for flag.

Returns:

flag on backward propagation