fr.cnes.genopus.nonWidget.events

Class CustomLocalTimeDetector

java.lang.Object

org.orekit.propagation.events.AbstractDetector

org.orekit.propagation.events.LocalTimeDetector

fr.cnes.genopus.nonWidget.events.CustomLocalTimeDetector

All Implemented Interfaces:

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

public class CustomLocalTimeDetector
extends org.orekit.propagation.events.LocalTimeDetector
implements CustomTriggeredEventDetector

Sub-class of Orekit's LocalTimeDetector class to be able to change the action to be performed in case of event detection.

Author:

aadt

See Also:

Serialized Form

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 class org.orekit.propagation.events.AbstractDetector

DEFAULT_MAXCHECK, DEFAULT_THRESHOLD

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

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

Constructors

Constructor and Description
CustomLocalTimeDetector(double localTime, org.orekit.frames.Frame bodyFrame, int triggerFrom, Integer triggerStep, Integer triggerTo) Constructor with target local time and body shape. maxCheck (600 s), threshold (1.0e-6 s) and action (RESET_STATE) by default.
CustomLocalTimeDetector(double localTime, org.orekit.frames.Frame bodyFrame, int triggerFrom, Integer triggerStep, Integer triggerTo, double maxCheck, double threshold, org.orekit.propagation.events.EventDetector.Action action) Constructor with complete data.

Method Summary

Methods

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)
static String	formatHMS(double localTime) Formats a given local time in hours, minutes and seconds string format.
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 coding event detector for some given increasing and decreasing messages.
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()

Methods inherited from class org.orekit.propagation.events.LocalTimeDetector

g, getBodyFrame, getTime, init, shouldBeRemoved

Methods inherited from class org.orekit.propagation.events.AbstractDetector

getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

CustomLocalTimeDetector

public CustomLocalTimeDetector(double localTime,
                       org.orekit.frames.Frame bodyFrame,
                       int triggerFrom,
                       Integer triggerStep,
                       Integer triggerTo)
                        throws org.orekit.errors.OrekitException,
                               ArithmeticException

Constructor with target local time and body shape. maxCheck (600 s), threshold (1.0e-6 s) and action (RESET_STATE) by default.

Parameters:

localTime - satellite local time triggering the event (rad).

bodyFrame - the central body attached frame (in witch the local Time is defined).

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.

Throws:

org.orekit.errors.OrekitException - error when loading the ephemeris files

ArithmeticException - if there is a problem building the Sun body.

CustomLocalTimeDetector

public CustomLocalTimeDetector(double localTime,
                       org.orekit.frames.Frame bodyFrame,
                       int triggerFrom,
                       Integer triggerStep,
                       Integer triggerTo,
                       double maxCheck,
                       double threshold,
                       org.orekit.propagation.events.EventDetector.Action action)
                        throws org.orekit.errors.OrekitException,
                               ArithmeticException

Constructor with complete data.

Parameters:

localTime - satellite local time triggering the event (rad).

bodyFrame - the central body attached frame (in witch the local Time is defined).

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.

Throws:

org.orekit.errors.OrekitException - error when loading the ephemeris files

ArithmeticException - if there is a problem building the Sun body.

Method Detail

getTriggerFrom

public int getTriggerFrom()

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

Specified by:

getTriggerFrom in interface CustomTriggeredEventDetector

Returns:

the count from which the event must be triggered.

getAction

public org.orekit.propagation.events.EventDetector.Action getAction()

Getter for the action to be performed in case of event detection.

Specified by:

getAction in interface CustomEventDetector

Returns:

the action to be performed in case of event detection.

eventOccurred

public org.orekit.propagation.events.EventDetector.Action eventOccurred(org.orekit.propagation.SpacecraftState s,
                                                               boolean increasing,
                                                               boolean forward)
                                                                 throws org.orekit.errors.OrekitException

Specified by:

eventOccurred in interface org.orekit.propagation.events.EventDetector

Overrides:

eventOccurred in class org.orekit.propagation.events.LocalTimeDetector

Throws:

org.orekit.errors.OrekitException

resetState

public org.orekit.propagation.SpacecraftState resetState(org.orekit.propagation.SpacecraftState oldState)

Specified by:

resetState in interface org.orekit.propagation.events.EventDetector

Overrides:

resetState in class org.orekit.propagation.events.AbstractDetector

toString

public String toString()

Overrides:

toString in class Object

getTriggerStep

public Integer getTriggerStep()

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

Specified by:

getTriggerStep in interface CustomTriggeredEventDetector

Returns:

the step every which the event must be triggered.

getTriggerTo

public Integer getTriggerTo()

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

Specified by:

getTriggerTo in interface CustomTriggeredEventDetector

Returns:

the count until which the event must be triggered.

copy

public 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. It is intended to be used to create the CodingEventDetector.

Specified by:

copy in interface CustomEventDetector

Returns:

a new instance with equal attributes but with Action#CONTINUE

getCodingEventDetector

public fr.cnes.sirius.patrius.events.CodingEventDetector getCodingEventDetector(String incEventString,
                                                                       String decEventString)

Description copied from interface: CustomEventDetector

Get the coding event detector for some given increasing and decreasing messages.

Specified by:

getCodingEventDetector in interface CustomEventDetector

Parameters:

incEventString - message to be included at the beginning of the message log when the detector is triggered with increasing g function

decEventString - message to be included at the beginning of the message log when the detector is triggered with decreasing g function

Returns:

the generic coding event detector with equal attributes as the original event detector.

getTriggerType

public 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.

Specified by:

getTriggerType in interface CustomTriggeredEventDetector

Returns:

the trigger type.

formatHMS

public static String formatHMS(double localTime)
                        throws ArithmeticException

Formats a given local time in hours, minutes and seconds string format.

Parameters:

localTime - local time in rad.

Returns:

the local time in hours, minutes and seconds format.

Throws:

ArithmeticException - if localTime is NaN