Package org.orekit.propagation.events.functions

Class ShiftedEventFunction

java.lang.Object

org.orekit.propagation.events.functions.ShiftedEventFunction

All Implemented Interfaces:

EventFunction, EventFunctionModifier

public class ShiftedEventFunction
extends Object
implements EventFunctionModifier

Time-shifted event function. The value can depend on the state or be constant.

Since:

14.0

Author:

Romain Serra

Constructor Summary

Constructors

Constructor	Description
ShiftedEventFunction(EventFunction baseFunction, double timeShift)	Constructor with constant shift.
ShiftedEventFunction(EventFunction baseFunction, ExtendedStateScalarFunction timeShiftFunction)	Constructor.

Method Summary

Modifier and Type	Method	Description
EventFunction	getBaseFunction()
ExtendedStateScalarFunction	getTimeShiftFunction()	Getter for time shift function.
<T extends CalculusFieldElement<T>> T	value(FieldSpacecraftState<T> fieldState)	Evaluate Field function.
double	value(SpacecraftState state)	Evaluate function.

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.functions.EventFunctionModifier

dependsOnMainVariablesOnly, dependsOnTimeOnly

Constructor Detail

ShiftedEventFunction

public ShiftedEventFunction(EventFunction baseFunction,
                            double timeShift)

Constructor with constant shift.

Parameters:

baseFunction - event function to shift in time

timeShift - shift value

ShiftedEventFunction

public ShiftedEventFunction(EventFunction baseFunction,
                            ExtendedStateScalarFunction timeShiftFunction)

Constructor.

Parameters:

baseFunction - event function to shift in time

timeShiftFunction - shift value function

Method Detail

getTimeShiftFunction

public ExtendedStateScalarFunction getTimeShiftFunction()

Getter for time shift function.

Returns:

shift function

getBaseFunction

public EventFunction getBaseFunction()

Specified by:

getBaseFunction in interface EventFunctionModifier

value

public double value(SpacecraftState state)

Description copied from interface: EventFunction

Evaluate function.

Specified by:

value in interface EventFunction

Specified by:

value in interface EventFunctionModifier

Parameters:

state - spacecraft state

Returns:

value

value

public <T extends CalculusFieldElement<T>> T value(FieldSpacecraftState<T> fieldState)

Description copied from interface: EventFunction

Evaluate Field function. By default, calls the non-Field version. This is suitable for detection but not be for applications like automatic differentiation, where a proper implementation should be used instead.

Specified by:

value in interface EventFunction

Specified by:

value in interface EventFunctionModifier

Type Parameters:

T - field type

Parameters:

fieldState - spacecraft state

Returns:

value