org.orekit.forces.maneuvers.trigger

Interface ManeuverTriggers

All Known Implementing Classes:

AbstractManeuverTriggers, DateBasedManeuverTriggers, EventBasedManeuverTriggers, IntervalEventTrigger, StartStopEventsTrigger

public interface ManeuverTriggers

Generic interface for the maneuver triggers used in a Maneuver.

Since:

10.2

Author:

Maxime Journot

Method Summary

Modifier and Type	Method and Description
Stream<EventDetector>	getEventsDetectors() Get the event detectors associated with the triggers.
<T extends CalculusFieldElement<T>> Stream<FieldEventDetector<T>>	getFieldEventsDetectors(Field<T> field) Get the event detectors associated with the triggers.
default String	getName() Get the maneuver name.
default List<ParameterDriver>	getParametersDrivers() Get the maneuver triggers parameter drivers.
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.

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

getEventsDetectors

Stream<EventDetector> getEventsDetectors()

Get the event detectors associated with the triggers.

Returns:

the event detectors

getFieldEventsDetectors

<T extends CalculusFieldElement<T>> Stream<FieldEventDetector<T>> getFieldEventsDetectors(Field<T> field)

Get the event detectors associated with the triggers.

Type Parameters:

T - type of the field elements

Parameters:

field - field to which the state belongs

Returns:

the event detectors

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

getParametersDrivers

default List<ParameterDriver> getParametersDrivers()

Get the maneuver triggers parameter drivers.

Returns:

maneuver triggers parameter drivers

getName

default String getName()

Get the maneuver name.

Returns:

the maneuver name