fr.cnes.genopus.events

Class GPRecurrentRelativeDateDetector

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genopus.events.GPEventDetectorAbstract

fr.cnes.genopus.events.GPTriggeredEventDetectorAbstract

fr.cnes.genopus.events.GPRecurrentRelativeDateDetector

All Implemented Interfaces:

fr.cnes.genius.main.GClear, fr.cnes.genius.main.GCondensedStatusInterface, fr.cnes.genius.main.GDisplay, fr.cnes.genius.main.GListener, fr.cnes.genius.main.GReadWrite, GPPatrius<CustomEventDetector>, MouseWheelListener, EventListener

public class GPRecurrentRelativeDateDetector
extends GPTriggeredEventDetectorAbstract

Widget representing a recurrent date detector: it detects every date t from a reference date t0 such as t - t0 = p.(elapsed seconds) with p being the time period of the detector.

Author:

Emmanuel Bignon

Nested Class Summary

Nested classes/interfaces inherited from class fr.cnes.genius.main.GComponent

fr.cnes.genius.main.GComponent.CopyPasteOperation, fr.cnes.genius.main.GComponent.DisplayIndicatorStatus, fr.cnes.genius.main.GComponent.ItemType, fr.cnes.genius.main.GComponent.Operation

Field Summary

Fields inherited from class fr.cnes.genopus.events.GPEventDetectorAbstract

ACTION, DETECTOR_ERROR

Fields inherited from class fr.cnes.genius.main.GComponent

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GPRecurrentRelativeDateDetector() Empty constructor.
GPRecurrentRelativeDateDetector(String widgetId) Constructor.
GPRecurrentRelativeDateDetector(String label, CustomRecurrentRelativeDateDetector relativeDateDetector, fr.cnes.sirius.patrius.events.EventDetector.Action... actionsToShow) Constructor.
GPRecurrentRelativeDateDetector(String label, fr.cnes.sirius.patrius.events.EventDetector.Action... actionsToShow) Constructor without default relative date detector.
GPRecurrentRelativeDateDetector(String widgetId, String label, CustomRecurrentRelativeDateDetector relativeDateDetector, fr.cnes.sirius.patrius.events.EventDetector.Action... actionsToShow) Constructor.
GPRecurrentRelativeDateDetector(String widgetId, String label, fr.cnes.sirius.patrius.events.EventDetector.Action... actionsToShow) Constructor without default relative date detector.

Method Summary

Modifier and Type	Method and Description
void	after(fr.cnes.genius.main.GEvent e)
void	before(fr.cnes.genius.main.GEvent e)
void	display()
void	generic()
GPDateOffset	getGPDateOffset() Getter for the GPDateOffset defining the target relative date of the event detector.
CustomEventDetector	getPatriusObject() Returns the PATRIUS object associated to a GENOPUS widget.
fr.cnes.sirius.patrius.time.AbsoluteDate	getReferenceDate() Method to get the reference date for the relative date detector.
fr.cnes.sirius.patrius.time.TimeScale	getReferenceTimeScale() Method to get the reference time scale.
fr.cnes.genius.highLevel.GEntryReal	getStep() Getter for the detector time step.
fr.cnes.genius.main.GComponent	getSubComponent(int position)
protected GPItemType	getXMLTag() Getter for the tag to be used int the XML configuration file.
boolean	isModified()
boolean	isNativeEventDetector(CustomEventDetector eventDetector) Check if a given event detector is defined in the native type of event detector of the widget.
void	setConstraint(int labelGap, int subWidgetGap) Setter for the constraints of the Event Detector widget.
void	setDefaultEventDetector(CustomEventDetector defaultEventDetector) Setter for the default event detector.
void	setDisplayIsModifiedIndicatorAll(fr.cnes.genius.main.GComponent.DisplayIndicatorStatus displayIndicatorStatus) Controls the display of the isModified indicator of all sub-widgets.
void	setEnabled(boolean b)
void	setEventDetector(CustomEventDetector eventDetector) Setter for the event detector.
void	setReferenceDate(fr.cnes.sirius.patrius.time.AbsoluteDate refDate, fr.cnes.sirius.patrius.time.TimeScale timeScale) Method to set the reference date for the relative date detector.
void	setSavedEventDetector(CustomEventDetector savedEventDetector) Setter for the reference event detector.
void	setWidgetId(String widgetId)
void	updateCondensedStatus(fr.cnes.genius.main.GCondensedStatus condensedStatus)

Methods inherited from class fr.cnes.genopus.events.GPTriggeredEventDetectorAbstract

buildWrapper, getGEntryIntTriggerAt, getGEntryIntTriggerFrom, getGEntryIntTriggerStep, getGEntryIntTriggerTo, getTriggerFrom, getTriggerStep, getTriggerTo, setAbstractClassDefaultValue, setAbstractClassSavedValue, setAbstractClassValue

Methods inherited from class fr.cnes.genopus.events.GPEventDetectorAbstract

attachCopyPasteMenu, clear, getAvailableActions, getGCheckBoxExpertConfig, getGComboBoxAction, getGEntryRealMaxCheck, getGEntryRealThreshold, getGLabel, getSelectedAction, initMaxCheckAndThresholdGEntryReals, isEnabled, read, setAvailableActions, setDefaultConstraint, setDisplayExpertConfig, updateIsModifiedIndicator, updateStatus, write

Methods inherited from class fr.cnes.genius.lowLevel.GContainer

put

Methods inherited from class fr.cnes.genius.main.GComponent

activateConstraintsByType, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getComponent, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isForcedStatus, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDefaultConstraints, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setStringConstraint, setToolTipText, setWidth, setWindowBusyCursor, writeCollection, writeCollection, writeCollection, writeCollection, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem

Methods inherited from class java.lang.Object

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

Constructor Detail

GPRecurrentRelativeDateDetector

public GPRecurrentRelativeDateDetector()

Empty constructor.

GPRecurrentRelativeDateDetector

public GPRecurrentRelativeDateDetector(String widgetId)

Constructor.

Parameters:

widgetId - widget identifier, if null an identifier will be automatically created.

GPRecurrentRelativeDateDetector

public GPRecurrentRelativeDateDetector(String label,
                                       fr.cnes.sirius.patrius.events.EventDetector.Action... actionsToShow)

Constructor without default relative date detector. The widgetId will be assigned automatically.

Parameters:

label - text to display in the label.

actionsToShow - list of actions to show in the widget. If null or empty all actions will be available.

GPRecurrentRelativeDateDetector

public GPRecurrentRelativeDateDetector(String widgetId,
                                       String label,
                                       fr.cnes.sirius.patrius.events.EventDetector.Action... actionsToShow)

Constructor without default relative date detector.

Parameters:

widgetId - widget identifier, if null an identifier will be automatically created.

label - text to display in the label.

actionsToShow - list of actions to show in the widget. If null or empty all actions will be available.

GPRecurrentRelativeDateDetector

public GPRecurrentRelativeDateDetector(String label,
                                       CustomRecurrentRelativeDateDetector relativeDateDetector,
                                       fr.cnes.sirius.patrius.events.EventDetector.Action... actionsToShow)

Constructor. The widgetId will be assigned automatically.

Parameters:

label - text to display in the label.

relativeDateDetector - relative date detector to set.

actionsToShow - list of actions to show in the widget. If null or empty all actions will be available.

GPRecurrentRelativeDateDetector

public GPRecurrentRelativeDateDetector(String widgetId,
                                       String label,
                                       CustomRecurrentRelativeDateDetector relativeDateDetector,
                                       fr.cnes.sirius.patrius.events.EventDetector.Action... actionsToShow)

Constructor.

Parameters:

widgetId - widget identifier, if null an identifier will be automatically created.

label - text to display in the label.

relativeDateDetector - relative date detector to set.

actionsToShow - list of actions to show in the widget. If null or empty all actions will be available.

Method Detail

setWidgetId

public final void setWidgetId(String widgetId)

Overrides:

setWidgetId in class GPTriggeredEventDetectorAbstract

getGPDateOffset

public GPDateOffset getGPDateOffset()

Getter for the GPDateOffset defining the target relative date of the event detector.

Returns:

the GPAbsoluteDate defining the target relative date of the event detector.

getStep

public fr.cnes.genius.highLevel.GEntryReal getStep()

Getter for the detector time step.

Returns:

the detector time step

setReferenceDate

public void setReferenceDate(fr.cnes.sirius.patrius.time.AbsoluteDate refDate,
                             fr.cnes.sirius.patrius.time.TimeScale timeScale)
                      throws fr.cnes.genius.exception.GArithmeticException

Method to set the reference date for the relative date detector.

Parameters:

refDate - reference date

timeScale - time scale for the relative date

Throws:

fr.cnes.genius.exception.GArithmeticException - if refDate contains NaNs.

getReferenceDate

public fr.cnes.sirius.patrius.time.AbsoluteDate getReferenceDate()
                                                          throws GPEventException

Method to get the reference date for the relative date detector.

Returns:

reference date

Throws:

GPEventException - if the reference date is undefined.

getReferenceTimeScale

public fr.cnes.sirius.patrius.time.TimeScale getReferenceTimeScale()
                                                            throws GPEventException

Method to get the reference time scale. This is the time scale in which the relative date is expressed in.

Returns:

reference time scale

Throws:

GPEventException - if the reference time scale is undefined.

getPatriusObject

public CustomEventDetector getPatriusObject()
                                     throws GPEventException

Returns the PATRIUS object associated to a GENOPUS widget.

Specified by:

getPatriusObject in interface GPPatrius<CustomEventDetector>

Specified by:

getPatriusObject in class GPEventDetectorAbstract

Returns:

the PATRIUS object associated to the widget.

Throws:

GPEventException - if reference date or the reference time scale are undefined.

setEventDetector

public final void setEventDetector(CustomEventDetector eventDetector)
                            throws GPEventException,
                                   fr.cnes.genius.exception.GArithmeticException

Setter for the event detector. Event detector can only be set if it is compatible with the widget.

Specified by:

setEventDetector in class GPEventDetectorAbstract

Parameters:

eventDetector - event detector to set.

Throws:

fr.cnes.genius.exception.GArithmeticException - if relative date in eventDetector is NaN.

GPEventException - if the given event detector is not compatible with the widget.

setDefaultEventDetector

public final void setDefaultEventDetector(CustomEventDetector defaultEventDetector)
                                   throws GPEventException,
                                          fr.cnes.genius.exception.GArithmeticException

Setter for the default event detector. Event detector can only be set if it is compatible with the widget.

Specified by:

setDefaultEventDetector in class GPEventDetectorAbstract

Parameters:

defaultEventDetector - default event detector to set.

Throws:

fr.cnes.genius.exception.GArithmeticException - if relative date in defaultEventDetector is NaN.

GPEventException - if the given event detector is not compatible with the widget.

setSavedEventDetector

public final void setSavedEventDetector(CustomEventDetector savedEventDetector)
                                 throws GPEventException,
                                        fr.cnes.genius.exception.GArithmeticException

Setter for the reference event detector. Event detector can only be set if it is compatible with the widget.

Specified by:

setSavedEventDetector in class GPEventDetectorAbstract

Parameters:

savedEventDetector - reference event detector to set.

Throws:

fr.cnes.genius.exception.GArithmeticException - if relative date in savedEventDetector is NaN.

GPEventException - if the given event detector is not compatible with the widget.

setConstraint

public void setConstraint(int labelGap,
                          int subWidgetGap)

Setter for the constraints of the Event Detector widget.

Overrides:

setConstraint in class GPTriggeredEventDetectorAbstract

Parameters:

labelGap - left gap from panel border to display the label of the event.

subWidgetGap - left gap from panel border to display the sub-widgets of the event.

setDisplayIsModifiedIndicatorAll

public void setDisplayIsModifiedIndicatorAll(fr.cnes.genius.main.GComponent.DisplayIndicatorStatus displayIndicatorStatus)

Controls the display of the isModified indicator of all sub-widgets.

Overrides:

setDisplayIsModifiedIndicatorAll in class GPTriggeredEventDetectorAbstract

Parameters:

displayIndicatorStatus - if Always the modifiedStatusIndicator is always shown, if Never the modifiedStatusIndicator is always shown, if Automatic the modifiedStatusIndicator is shown as needed.

isNativeEventDetector

public boolean isNativeEventDetector(CustomEventDetector eventDetector)

Check if a given event detector is defined in the native type of event detector of the widget.

Specified by:

isNativeEventDetector in class GPEventDetectorAbstract

Parameters:

eventDetector - the event detector to be checked.

Returns:

true if the given event detector is defined in the native type of event detector of the widget.

setEnabled

public void setEnabled(boolean b)

Overrides:

setEnabled in class GPTriggeredEventDetectorAbstract

isModified

public boolean isModified()

Overrides:

isModified in class GPTriggeredEventDetectorAbstract

generic

public void generic()
             throws fr.cnes.genius.exception.GException

Overrides:

generic in class GPTriggeredEventDetectorAbstract

Throws:

fr.cnes.genius.exception.GException

display

public void display()
             throws fr.cnes.genius.exception.GException

Specified by:

display in interface fr.cnes.genius.main.GDisplay

Overrides:

display in class GPTriggeredEventDetectorAbstract

Throws:

fr.cnes.genius.exception.GException

before

public void before(fr.cnes.genius.main.GEvent e)

after

public void after(fr.cnes.genius.main.GEvent e)
           throws GPEventException

Specified by:

after in interface fr.cnes.genius.main.GListener

Overrides:

after in class GPTriggeredEventDetectorAbstract

Throws:

GPEventException

getXMLTag

protected GPItemType getXMLTag()

Getter for the tag to be used int the XML configuration file.

Specified by:

getXMLTag in class GPEventDetectorAbstract

Returns:

the tag to be used int the XML configuration file

getSubComponent

public fr.cnes.genius.main.GComponent getSubComponent(int position)
                                               throws fr.cnes.genius.exception.GComponentException

Overrides:

getSubComponent in class GPTriggeredEventDetectorAbstract

Throws:

fr.cnes.genius.exception.GComponentException

updateCondensedStatus

public void updateCondensedStatus(fr.cnes.genius.main.GCondensedStatus condensedStatus)

Specified by:

updateCondensedStatus in interface fr.cnes.genius.main.GCondensedStatusInterface

Overrides:

updateCondensedStatus in class GPTriggeredEventDetectorAbstract