Package org.orekit.forces.maneuvers.trigger

Interface ManeuverTriggers

All Superinterfaces:

EventDetectorsProvider, ParameterDriversProvider

All Known Subinterfaces:

ResettableManeuverTriggers

All Known Implementing Classes:

AbstractManeuverTriggers, DateBasedManeuverTriggers, IntervalEventTrigger, StartStopEventsTrigger

public interface ManeuverTriggers
extends ParameterDriversProvider, EventDetectorsProvider

Generic interface for the maneuver triggers used in a Maneuver.

Since:

10.2

Author:

Maxime Journot

Field Summary

Fields inherited from interface org.orekit.propagation.events.EventDetectorsProvider

DATATION_ACCURACY

Method Summary

Modifier and Type	Method	Description
default String	getName()	Get the maneuver name.
default <T extends CalculusFieldElement<T>> void	init(FieldSpacecraftState<T> initialState, FieldAbsoluteDate<T> target)	Initialization method called at propagation start.
default void	init(SpacecraftState initialState, AbsoluteDate target)	Initialization method called at propagation start.
boolean	isFiring(AbsoluteDate date, double[] parameters)	Find out if the maneuver is firing or not.
<T extends CalculusFieldElement<T>> boolean	isFiring(FieldAbsoluteDate<T> date, T[] parameters)	Find out if the maneuver is firing or not.

Methods inherited from interface org.orekit.propagation.events.EventDetectorsProvider

getDateDetector, getEventDetectors, getEventDetectors, getFieldDateDetector, getFieldEventDetectors, getFieldEventDetectors

Methods inherited from interface org.orekit.utils.ParameterDriversProvider

getNbParametersDriversValue, getParameterDriver, getParameters, getParameters, getParameters, getParameters, getParametersAllValues, getParametersAllValues, getParametersDrivers, isSupported

Method Detail

init

default void init(SpacecraftState initialState,
                  AbsoluteDate target)

Initialization method called at propagation start.

The default implementation does nothing.

Parameters:

initialState - initial spacecraft state (at the start of propagation).

target - date of propagation. Not equal to initialState.getDate().

init

default <T extends CalculusFieldElement<T>> void init(FieldSpacecraftState<T> initialState,
                                                      FieldAbsoluteDate<T> target)

Initialization method called at propagation start.

The default implementation does nothing.

Type Parameters:

T - type of the elements

Parameters:

initialState - initial spacecraft state (at the start of propagation).

target - date of propagation. Not equal to initialState.getDate().

Since:

11.1

isFiring

boolean isFiring(AbsoluteDate date,
                 double[] parameters)

Find out if the maneuver is firing or not.

Parameters:

date - current date

parameters - maneuver triggers parameters

Returns:

true if the maneuver is firing, false otherwise

isFiring

<T extends CalculusFieldElement<T>> boolean isFiring(FieldAbsoluteDate<T> date,
                                                     T[] parameters)

Find out if the maneuver is firing or not.

Type Parameters:

T - type of the field elements

Parameters:

date - current date

parameters - maneuver triggers parameters

Returns:

true if the maneuver is firing, false otherwise

getName

default String getName()

Get the maneuver name.

Returns:

the maneuver name