fr.cnes.genopus.nonWidget.events

Class CustomEventDetectorTrigger

java.lang.Object

fr.cnes.genopus.nonWidget.events.CustomEventDetectorTrigger

All Implemented Interfaces:

Serializable

public class CustomEventDetectorTrigger
extends Object
implements Serializable

Complex trigger for event detectors where should be triggered or not depending on the occurrence number or on the slope of the switching function around event. With respect to the occurrence number, the event can be triggered from a given detection, until another given detection and every a given number of detections. Regarding the slope of the switching function, the CustomEventDetectorTrigger.TriggeringType enum offers the three possibilities CustomEventDetectorTrigger.TriggeringType.INCREASING, CustomEventDetectorTrigger.TriggeringType.DECREASING or CustomEventDetectorTrigger.TriggeringType.BOTH. Note that switching function increasing/decreasing nature is measured with respect to physical time, not with respect to propagation time which may go backwards.

Author:

ffsm

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomEventDetectorTrigger.TriggeringType Choices for triggering the events.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALT_DEC_STR
static String	ALT_INC_STR
static String	AOL_DEC_STR
static String	AOL_INC_STR
static String	APS_DEC_STR
static String	APS_INC_STR
static String	DAT_DEC_STR
static String	DAT_INC_STR
static String	ECL_DEC_STR
static String	ECL_INC_STR
static String	LTM_DEC_STR
static String	LTM_INC_STR
static String	NOD_DEC_STR
static String	NOD_INC_STR
static String	RDA_DEC_STR
static String	RDA_INC_STR
static String	VFS_DEC_STR
static String	VFS_INC_STR

Constructor Summary

Constructors

Constructor and Description
CustomEventDetectorTrigger(int triggerFrom, Integer triggerStep, Integer triggerTo, CustomEventDetectorTrigger.TriggeringType triggerType, org.orekit.propagation.events.EventDetector.Action action) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
org.orekit.propagation.events.EventDetector.Action	eventOccurred(boolean increasing) Handle an event detection and choose what to do next.
org.orekit.propagation.events.EventDetector.Action	getAction() Getter for the action to be performed in case of event triggering.
fr.cnes.sirius.patrius.events.CodingEventDetector	getGenericCodingEventDetector(CustomEventDetector eventDetector, String incEventString, String decEventString) Get the coding event detector associated to this event 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 choice.
boolean	shouldBeRemoved() This method is called after eventOccurred(boolean) has been triggered.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ALT_INC_STR

public static final String ALT_INC_STR

See Also:

Constant Field Values

ALT_DEC_STR

public static final String ALT_DEC_STR

See Also:

Constant Field Values

AOL_INC_STR

public static final String AOL_INC_STR

See Also:

Constant Field Values

AOL_DEC_STR

public static final String AOL_DEC_STR

See Also:

Constant Field Values

APS_INC_STR

public static final String APS_INC_STR

See Also:

Constant Field Values

APS_DEC_STR

public static final String APS_DEC_STR

See Also:

Constant Field Values

DAT_INC_STR

public static final String DAT_INC_STR

See Also:

Constant Field Values

DAT_DEC_STR

public static final String DAT_DEC_STR

See Also:

Constant Field Values

ECL_INC_STR

public static final String ECL_INC_STR

See Also:

Constant Field Values

ECL_DEC_STR

public static final String ECL_DEC_STR

See Also:

Constant Field Values

LTM_INC_STR

public static final String LTM_INC_STR

See Also:

Constant Field Values

LTM_DEC_STR

public static final String LTM_DEC_STR

See Also:

Constant Field Values

NOD_INC_STR

public static final String NOD_INC_STR

See Also:

Constant Field Values

NOD_DEC_STR

public static final String NOD_DEC_STR

See Also:

Constant Field Values

RDA_INC_STR

public static final String RDA_INC_STR

See Also:

Constant Field Values

RDA_DEC_STR

public static final String RDA_DEC_STR

See Also:

Constant Field Values

VFS_INC_STR

public static final String VFS_INC_STR

See Also:

Constant Field Values

VFS_DEC_STR

public static final String VFS_DEC_STR

See Also:

Constant Field Values

Constructor Detail

CustomEventDetectorTrigger

public CustomEventDetectorTrigger(int triggerFrom,
                          Integer triggerStep,
                          Integer triggerTo,
                          CustomEventDetectorTrigger.TriggeringType triggerType,
                          org.orekit.propagation.events.EventDetector.Action action)

Constructor.

Parameters:

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.

triggerType - indicates the slope of the switching function that must have an event detection in order to be triggered.

action - action to be performed when the event is triggered.

Method Detail

getTriggerFrom

public int getTriggerFrom()

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

Returns:

the count from which the event must be triggered.

getTriggerStep

public 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

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.

Returns:

the count until 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 triggering.

Returns:

the action to be performed in case of event triggering.

shouldBeRemoved

public boolean shouldBeRemoved()

This method is called after eventOccurred(boolean) has been triggered. It returns true if the current detector should be removed after last event detection.

Returns:

true if the current detector should be removed after last event detection

eventOccurred

public org.orekit.propagation.events.EventDetector.Action eventOccurred(boolean increasing)

Handle an event detection and choose what to do next.

Parameters:

increasing - if true, the value of the switching function increases when time increases around event (note that increase is measured with respect to physical time, not with respect to propagation which may go backward in time)

Returns:

EventDetector.Action#CONTINUE if the event is triggered or the event action if it is triggered.

getGenericCodingEventDetector

public fr.cnes.sirius.patrius.events.CodingEventDetector getGenericCodingEventDetector(CustomEventDetector eventDetector,
                                                                              String incEventString,
                                                                              String decEventString)

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

Parameters:

eventDetector - this event (it will be copied to avoid changing the original action).

incEventString - message for the log when the detector is triggered with increasing g function

decEventString - message for the log when the detector is triggered with decreasing g function

Returns:

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

toString

public String toString()

Overrides:

toString in class Object

getTriggerType

public CustomEventDetectorTrigger.TriggeringType getTriggerType()

Getter for the trigger choice.

Returns:

the trigger choice