fr.cnes.genopus.nonWidget.events

Class CustomGenericCodingEventDetector

java.lang.Object

fr.cnes.genopus.nonWidget.events.CustomGenericCodingEventDetector

All Implemented Interfaces:

fr.cnes.sirius.patrius.events.EventDetector, fr.cnes.sirius.patrius.events.postprocessing.CodingEventDetector, Serializable

public class CustomGenericCodingEventDetector
extends Object
implements fr.cnes.sirius.patrius.events.postprocessing.CodingEventDetector

This class represents an implementation of the CodingEventDetector interface for event detectors that can be triggered from a given occurrence until a given occurrence and every a given number of occurrences.
It works using the EventDetector provided in the constructor. This detector is able to build a CodedEvent for a given date. It does not support phenomena.

Author:

ffsm

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface fr.cnes.sirius.patrius.events.EventDetector

fr.cnes.sirius.patrius.events.EventDetector.Action

Field Summary

Fields inherited from interface fr.cnes.sirius.patrius.events.EventDetector

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

Constructors

Constructor and Description
CustomGenericCodingEventDetector(fr.cnes.sirius.patrius.events.EventDetector eventDetectorIn, String increasingCodeIn, String decreasingCodeIn) Constructor for a CustomGenericCodingEventDetector.

Method Summary

Modifier and Type	Method and Description
fr.cnes.sirius.patrius.events.postprocessing.CodedEvent	buildCodedEvent(fr.cnes.sirius.patrius.propagation.SpacecraftState s, boolean increasing)
fr.cnes.sirius.patrius.events.postprocessing.CodedEvent	buildDelayedCodedEvent(fr.cnes.sirius.patrius.propagation.SpacecraftState s, boolean increasing) Unsupported method for CustomGenericCodingEventDetector.
fr.cnes.sirius.patrius.events.postprocessing.CodedEvent	buildOccurrenceCodedEvent(fr.cnes.sirius.patrius.propagation.SpacecraftState s, boolean increasing)
fr.cnes.sirius.patrius.events.EventDetector	copy()
fr.cnes.sirius.patrius.events.EventDetector.Action	eventOccurred(fr.cnes.sirius.patrius.propagation.SpacecraftState s, boolean increasing, boolean forward)
boolean	filterEvent(fr.cnes.sirius.patrius.propagation.SpacecraftState state, boolean increasing, boolean forward)
double	g(fr.cnes.sirius.patrius.propagation.SpacecraftState s)
String	getEventType()
double	getMaxCheckInterval()
int	getMaxIterationCount()
String	getPhenomenonCode()
int	getSlopeSelection()
double	getThreshold()
void	init(fr.cnes.sirius.patrius.propagation.SpacecraftState s0, fr.cnes.sirius.patrius.time.AbsoluteDate t)
boolean	positiveSignMeansActive()
fr.cnes.sirius.patrius.propagation.SpacecraftState	resetState(fr.cnes.sirius.patrius.propagation.SpacecraftState oldState)
boolean	shouldBeRemoved()

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomGenericCodingEventDetector

public CustomGenericCodingEventDetector(fr.cnes.sirius.patrius.events.EventDetector eventDetectorIn,
                                        String increasingCodeIn,
                                        String decreasingCodeIn)

Constructor for a CustomGenericCodingEventDetector. No delays and occurrence numbers from the eventDetectorIn are associated to the events detected by this detector.

Parameters:

eventDetectorIn - the EventDetector of the current event

increasingCodeIn - code identifying the "increasing" event

decreasingCodeIn - code identifying the "decreasing" event

See Also:

CodingEventDetector, EventDetector

Method Detail

g

public final double g(fr.cnes.sirius.patrius.propagation.SpacecraftState s)
               throws fr.cnes.sirius.patrius.utils.exception.PatriusException

Specified by:

g in interface fr.cnes.sirius.patrius.events.EventDetector

Throws:

fr.cnes.sirius.patrius.utils.exception.PatriusException

eventOccurred

public final fr.cnes.sirius.patrius.events.EventDetector.Action eventOccurred(fr.cnes.sirius.patrius.propagation.SpacecraftState s,
                                                                              boolean increasing,
                                                                              boolean forward)
                                                                       throws fr.cnes.sirius.patrius.utils.exception.PatriusException

Specified by:

eventOccurred in interface fr.cnes.sirius.patrius.events.EventDetector

Throws:

fr.cnes.sirius.patrius.utils.exception.PatriusException

shouldBeRemoved

public boolean shouldBeRemoved()

Specified by:

shouldBeRemoved in interface fr.cnes.sirius.patrius.events.EventDetector

resetState

public final fr.cnes.sirius.patrius.propagation.SpacecraftState resetState(fr.cnes.sirius.patrius.propagation.SpacecraftState oldState)
                                                                    throws fr.cnes.sirius.patrius.utils.exception.PatriusException

Specified by:

resetState in interface fr.cnes.sirius.patrius.events.EventDetector

Throws:

fr.cnes.sirius.patrius.utils.exception.PatriusException

getThreshold

public final double getThreshold()

Specified by:

getThreshold in interface fr.cnes.sirius.patrius.events.EventDetector

getMaxCheckInterval

public final double getMaxCheckInterval()

Specified by:

getMaxCheckInterval in interface fr.cnes.sirius.patrius.events.EventDetector

getMaxIterationCount

public final int getMaxIterationCount()

Specified by:

getMaxIterationCount in interface fr.cnes.sirius.patrius.events.EventDetector

buildCodedEvent

public final fr.cnes.sirius.patrius.events.postprocessing.CodedEvent buildCodedEvent(fr.cnes.sirius.patrius.propagation.SpacecraftState s,
                                                                                     boolean increasing)

Specified by:

buildCodedEvent in interface fr.cnes.sirius.patrius.events.postprocessing.CodingEventDetector

buildDelayedCodedEvent

public final fr.cnes.sirius.patrius.events.postprocessing.CodedEvent buildDelayedCodedEvent(fr.cnes.sirius.patrius.propagation.SpacecraftState s,
                                                                                            boolean increasing)

Unsupported method for CustomGenericCodingEventDetector.

Specified by:

buildDelayedCodedEvent in interface fr.cnes.sirius.patrius.events.postprocessing.CodingEventDetector

buildOccurrenceCodedEvent

public final fr.cnes.sirius.patrius.events.postprocessing.CodedEvent buildOccurrenceCodedEvent(fr.cnes.sirius.patrius.propagation.SpacecraftState s,
                                                                                               boolean increasing)

Specified by:

buildOccurrenceCodedEvent in interface fr.cnes.sirius.patrius.events.postprocessing.CodingEventDetector

positiveSignMeansActive

public final boolean positiveSignMeansActive()

Specified by:

positiveSignMeansActive in interface fr.cnes.sirius.patrius.events.postprocessing.CodingEventDetector

getPhenomenonCode

public final String getPhenomenonCode()

Specified by:

getPhenomenonCode in interface fr.cnes.sirius.patrius.events.postprocessing.CodingEventDetector

getEventType

public final String getEventType()

Specified by:

getEventType in interface fr.cnes.sirius.patrius.events.postprocessing.CodingEventDetector

init

public void init(fr.cnes.sirius.patrius.propagation.SpacecraftState s0,
                 fr.cnes.sirius.patrius.time.AbsoluteDate t)
          throws fr.cnes.sirius.patrius.utils.exception.PatriusException

Specified by:

init in interface fr.cnes.sirius.patrius.events.EventDetector

Throws:

fr.cnes.sirius.patrius.utils.exception.PatriusException

getSlopeSelection

public int getSlopeSelection()

Specified by:

getSlopeSelection in interface fr.cnes.sirius.patrius.events.EventDetector

copy

public fr.cnes.sirius.patrius.events.EventDetector copy()

Specified by:

copy in interface fr.cnes.sirius.patrius.events.EventDetector

filterEvent

public boolean filterEvent(fr.cnes.sirius.patrius.propagation.SpacecraftState state,
                           boolean increasing,
                           boolean forward)
                    throws fr.cnes.sirius.patrius.utils.exception.PatriusException

Specified by:

filterEvent in interface fr.cnes.sirius.patrius.events.EventDetector

Throws:

fr.cnes.sirius.patrius.utils.exception.PatriusException