fr.cnes.genopus.nonWidget.events

Interface CustomTriggeredEventDetector

All Superinterfaces:

CustomEventDetector, org.orekit.propagation.events.EventDetector, Serializable

All Known Implementing Classes:

CustomAltitudeDetector, CustomAOLDetector, CustomApsideDetector, CustomEclipseDetector, CustomLocalTimeDetector, CustomNodeDetector, CustomVisibilityFromStationDetector

public interface CustomTriggeredEventDetector
extends CustomEventDetector

Interface to be implemented by custom detectors that can be triggered after a number of ocurrences.

Author:

ffsm

Nested Class Summary

Nested classes/interfaces inherited from interface org.orekit.propagation.events.EventDetector

org.orekit.propagation.events.EventDetector.Action

Field Summary

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

DECREASING, INCREASING, INCREASING_DECREASING

Method Summary

Methods

Modifier and Type	Method and Description
int	getTriggerFrom() Getter for the count from which the event must be triggered.
Integer	getTriggerStep() Getter for the step every which the event must be triggered.
Integer	getTriggerTo() Getter for the count until which the event must be triggered.
CustomEventDetectorTrigger.TriggeringType	getTriggerType() Getter for the trigger type, that is, the slope of the switching function that must trigger the event.

Methods inherited from interface fr.cnes.genopus.nonWidget.events.CustomEventDetector

copy, getAction, getCodingEventDetector

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

eventOccurred, g, getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, init, resetState, shouldBeRemoved

Method Detail

getTriggerFrom

int getTriggerFrom()

Getter for the count from which the event must be triggered.

Returns:

the count from which the event must be triggered.

getTriggerStep

Integer getTriggerStep()

Getter for the step every which the event must be triggered. If null the event is triggered only once.

Returns:

the step every which the event must be triggered.

getTriggerTo

Integer getTriggerTo()

Getter for the count until which the event must be triggered. If null, the event is triggered until the end of propagation.

Returns:

the count until which the event must be triggered.

getTriggerType

CustomEventDetectorTrigger.TriggeringType getTriggerType()

Getter for the trigger type, that is, the slope of the switching function that must trigger the event. The options are CustomEventDetectorTrigger.TriggeringType.INCREASING for increasing slope, CustomEventDetectorTrigger.TriggeringType.DECREASING for decreasing slope and CustomEventDetectorTrigger.TriggeringType.BOTH for increasing or decreasing slope of the switching function.

Returns:

the trigger type.