public class CustomEclipseDetector extends org.orekit.propagation.events.EclipseDetector implements CustomTriggeredEventDetector
| Modifier and Type | Class and Description |
|---|---|
static class |
CustomEclipseDetector.EclipseDetectionChoice
Choices for eclipse events detection.
|
| Constructor and Description |
|---|
CustomEclipseDetector(CustomEclipseDetector.EclipseDetectionChoice eclipseDetectionChoice,
double occultingBodyRadius,
int triggerFrom,
Integer triggerStep,
Integer triggerTo)
Constructor with target eclipse and trigger. maxCheck (600 s), threshold (1.0e-6 s) and action
(RESET_STATE) by default.
|
CustomEclipseDetector(CustomEclipseDetector.EclipseDetectionChoice eclipseDetectionChoice,
double occultingBodyRadius,
int triggerFrom,
Integer triggerStep,
Integer triggerTo,
double maxCheck,
double threshold,
org.orekit.propagation.events.EventDetector.Action action)
Constructor with complete data.
|
| Modifier and Type | Method and Description |
|---|---|
org.orekit.propagation.events.EventDetector |
copy()
Returns a new instance of the current type of
CustomEventDetector with the same attributes but
for the action which is set to Action#CONTINUE. |
org.orekit.propagation.events.EventDetector.Action |
eventOccurred(org.orekit.propagation.SpacecraftState s,
boolean increasing,
boolean forward) |
org.orekit.propagation.events.EventDetector.Action |
getAction()
Getter for the action to be performed in case of event detection.
|
fr.cnes.sirius.patrius.events.CodingEventDetector |
getCodingEventDetector(String incEventString,
String decEventString)
Get the generic coding event detectors for a given increasing and decreasing messages.
|
CustomEclipseDetector.EclipseDetectionChoice |
getEclipseDetectionChoice()
Returns the eclipse detection choice as an item of the
CustomEclipseDetector.EclipseDetectionChoice enum. |
double |
getOccultingBodyRadius()
Getter for the occulting body radius (the Earth).
|
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.
|
org.orekit.propagation.SpacecraftState |
resetState(org.orekit.propagation.SpacecraftState oldState) |
String |
toString() |
g, getOcculted, getOccultedDirection, getOccultedRadius, getOcculting, isTotalEclipse, shouldBeRemovedgetMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, initpublic CustomEclipseDetector(CustomEclipseDetector.EclipseDetectionChoice eclipseDetectionChoice, double occultingBodyRadius, int triggerFrom, Integer triggerStep, Integer triggerTo) throws ArithmeticException
eclipseDetectionChoice - eclipse detection choiceoccultingBodyRadius - the occulting body radius (m)triggerFrom - count at/from which the single/multiple event must be triggered.triggerStep - step every which the multiple event must be triggered. If null, the event will be triggered
only once at the occurrence given by triggerFrom.triggerTo - count until which the multiple event must be triggered. If null, the event will be triggered
until the end of propagation.ArithmeticException - if occultingBodyRadius is NaN.public CustomEclipseDetector(CustomEclipseDetector.EclipseDetectionChoice eclipseDetectionChoice, double occultingBodyRadius, int triggerFrom, Integer triggerStep, Integer triggerTo, double maxCheck, double threshold, org.orekit.propagation.events.EventDetector.Action action) throws ArithmeticException
eclipseDetectionChoice - eclipse detection choiceoccultingBodyRadius - the occulting body radius (m)triggerFrom - count at/from which the single/multiple event must be triggered.triggerStep - step every which the multiple event must be triggered. If null, the event will be triggered
only once at the occurrence given by triggerFrom.triggerTo - count until which the multiple event must be triggered. If null, the event will be triggered
until the end of propagation.maxCheck - maximum checking interval (s).threshold - convergence threshold (s).action - action to be performed in case of event detection.ArithmeticException - if occultingBodyRadius is NaN.public CustomEclipseDetector.EclipseDetectionChoice getEclipseDetectionChoice()
CustomEclipseDetector.EclipseDetectionChoice enum.CustomEclipseDetector.EclipseDetectionChoice.Entry,
CustomEclipseDetector.EclipseDetectionChoice.Exit or CustomEclipseDetector.EclipseDetectionChoice.Bothpublic double getOccultingBodyRadius()
public int getTriggerFrom()
getTriggerFrom in interface CustomTriggeredEventDetectorpublic org.orekit.propagation.events.EventDetector.Action getAction()
getAction in interface CustomEventDetectorpublic org.orekit.propagation.events.EventDetector.Action eventOccurred(org.orekit.propagation.SpacecraftState s,
boolean increasing,
boolean forward)
throws org.orekit.errors.OrekitException
eventOccurred in interface org.orekit.propagation.events.EventDetectoreventOccurred in class org.orekit.propagation.events.EclipseDetectororg.orekit.errors.OrekitExceptionpublic org.orekit.propagation.SpacecraftState resetState(org.orekit.propagation.SpacecraftState oldState)
resetState in interface org.orekit.propagation.events.EventDetectorresetState in class org.orekit.propagation.events.AbstractDetectorpublic Integer getTriggerStep()
getTriggerStep in interface CustomTriggeredEventDetectorpublic Integer getTriggerTo()
getTriggerTo in interface CustomTriggeredEventDetectorpublic org.orekit.propagation.events.EventDetector copy()
CustomEventDetector with the same attributes but
for the action which is set to Action#CONTINUE. It is intended to be used to create the
CodingEventDetector.copy in interface CustomEventDetectorAction#CONTINUEpublic fr.cnes.sirius.patrius.events.CodingEventDetector getCodingEventDetector(String incEventString, String decEventString)
getCodingEventDetector in interface CustomEventDetectorincEventString - message for the log when the detector is triggered with increasing g functiondecEventString - message for the log when the detector is triggered with decreasing g functionpublic CustomEventDetectorTrigger.TriggeringType getTriggerType()
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.getTriggerType in interface CustomTriggeredEventDetectorCopyright © 2017. All rights reserved.