org.orekit.forces.maneuvers.trigger

Class IntervalEventTrigger<T extends AbstractDetector<T>>

java.lang.Object

org.orekit.forces.maneuvers.trigger.AbstractManeuverTriggers

org.orekit.forces.maneuvers.trigger.IntervalEventTrigger<T>

Type Parameters:

T - type of the interval detector

All Implemented Interfaces:

ManeuverTriggers

Direct Known Subclasses:

DateBasedManeuverTriggers

public abstract class IntervalEventTrigger<T extends AbstractDetector<T>>
extends AbstractManeuverTriggers

Maneuver triggers based on a single event detector that defines firing intervals.

Firing intervals correspond to time spans with positive value of the event detector g function.

Since:

11.1

Author:

Luc Maisonobe

See Also:

StartStopEventsTrigger

Constructor Summary

Constructors

Constructor and Description
IntervalEventTrigger(T prototypeFiringIntervalDetector) Simple constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract <D extends FieldEventDetector<S>,S extends CalculusFieldElement<S>> FieldAbstractDetector<D,S>	convertIntervalDetector(Field<S> field, T detector) Convert a primitive firing intervals detector into a field firing intervals detector.
Stream<EventDetector>	getEventsDetectors() Get the event detectors associated with the triggers.
<S extends CalculusFieldElement<S>> Stream<FieldEventDetector<S>>	getFieldEventsDetectors(Field<S> field) Get the event detectors associated with the triggers.
T	getFiringIntervalDetector() Getter for the firing interval detector.
protected boolean	isFiringOnInitialState(SpacecraftState initialState, boolean isForward) Method to check if the thruster is firing on initialization.

Methods inherited from class org.orekit.forces.maneuvers.trigger.AbstractManeuverTriggers

addResetter, addResetter, applyResetters, applyResetters, getFirings, init, init, initializeResetters, initializeResetters, isFiring, isFiring, notifyResetters, notifyResetters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.orekit.forces.maneuvers.trigger.ManeuverTriggers

getName, getParametersDrivers

Constructor Detail

IntervalEventTrigger

public IntervalEventTrigger(T prototypeFiringIntervalDetector)

Simple constructor.

Note that the intervalDetector passed as an argument is used only as a prototype from which a new detector will be built using its withHandler method to set up an internal handler. The original event handler from the prototype will be ignored and never called.

If the trigger is used in a field-based propagation, the detector will be automatically converted to a field equivalent. Beware however that the eventOccurred of the converted propagator will call the method with the same name in the prototype detector, in order to get the correct return value.

Parameters:

prototypeFiringIntervalDetector - prototype detector for firing interval

Method Detail

getFiringIntervalDetector

public T getFiringIntervalDetector()

Getter for the firing interval detector.

Returns:

firing interval detector

isFiringOnInitialState

protected boolean isFiringOnInitialState(SpacecraftState initialState,
                                         boolean isForward)

Method to check if the thruster is firing on initialization. can be called by sub classes

Specified by:

isFiringOnInitialState in class AbstractManeuverTriggers

Parameters:

initialState - initial spacecraft state

isForward - if true, propagation will be in the forward direction

Returns:

true if firing in propagation direction

getEventsDetectors

public Stream<EventDetector> getEventsDetectors()

Get the event detectors associated with the triggers.

Returns:

the event detectors

getFieldEventsDetectors

public <S extends CalculusFieldElement<S>> Stream<FieldEventDetector<S>> getFieldEventsDetectors(Field<S> field)

Get the event detectors associated with the triggers.

Type Parameters:

S - type of the field elements

Parameters:

field - field to which the state belongs

Returns:

the event detectors

convertIntervalDetector

protected abstract <D extends FieldEventDetector<S>,S extends CalculusFieldElement<S>> FieldAbstractDetector<D,S> convertIntervalDetector(Field<S> field,
                                                                                                                                          T detector)

Convert a primitive firing intervals detector into a field firing intervals detector.

There is not need to set up withMaxCheck, withThreshold, or withHandler in the converted detector, this will be done by caller.

A skeleton implementation of this method to convert some XyzDetector into FieldXyzDetector, considering these detectors are created from a date and a number parameter is:

     protected <D extends FieldEventDetector<S>, S extends CalculusFieldElement<S>>
         FieldAbstractDetector<D, S> convertIntervalDetector(final Field<S> field, final XyzDetector detector) {

         final FieldAbsoluteDate<S> date  = new FieldAbsoluteDate<>(field, detector.getDate());
         final S                    param = field.getZero().newInstance(detector.getParam());

         final FieldAbstractDetector<D, S> converted = (FieldAbstractDetector<D, S>) new FieldXyzDetector<>(date, param);
         return converted;

     }
 
 

Type Parameters:

D - type of the event detector

S - type of the field elements

Parameters:

field - field to which the state belongs

detector - primitive firing intervals detector to convert

Returns:

converted firing intervals detector