Package org.orekit.propagation.events.functions

Class TimeIntervalEventFunction

java.lang.Object

org.orekit.propagation.events.functions.TimeIntervalEventFunction

All Implemented Interfaces:

EventFunction

public class TimeIntervalEventFunction
extends Object
implements EventFunction

Class representing time interval crossing detection. It is positive within the interval.

Since:

14.0

Author:

Romain Serra

Constructor Summary

Constructors

Constructor	Description
TimeIntervalEventFunction(TimeInterval timeInterval)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	dependsOnTimeOnly()	Method returning true if and only if the event function does not depend on dependent variables, just the independent one i.e. time.
TimeInterval	getTimeInterval()	Getter for the time interval.
<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.EventFunction

dependsOnMainVariablesOnly

Constructor Details

TimeIntervalEventFunction

public TimeIntervalEventFunction(TimeInterval timeInterval)

Constructor.

Parameters:

timeInterval - event crossing interval

Method Details

value

public double value(SpacecraftState state)

Description copied from interface: EventFunction

Evaluate function.

Specified by:

value in interface EventFunction

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

Type Parameters:

T - field type

Parameters:

fieldState - spacecraft state

Returns:

value

dependsOnTimeOnly

public boolean dependsOnTimeOnly()

Description copied from interface: EventFunction

Method returning true if and only if the event function does not depend on dependent variables, just the independent one i.e. time. This information is used for performance in propagation and derivatives correction with switches in the dynamics.

Specified by:

dependsOnTimeOnly in interface EventFunction

Returns:

flag

getTimeInterval

public TimeInterval getTimeInterval()

Getter for the time interval.

Returns:

interval