fr.cnes.genopus.events

Class GPLocalTimeDetector

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

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>

public class GPLocalTimeDetector
extends GPTriggeredEventDetectorAbstract

Widget representing an Orekit's LocalTimeDetector.

Author:

aadt

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabelWithIndicator	label	0, 0 => "newline , gapleft 0 , split 2" 0, 1 => (null)
1	GComboBoxWithLabel	comboBoxAction	1, 0, 0 => "newline , gapleft 30 , split 2" 1, 0, 1 => (null) 1, 1 => (null)
2	GCheckBox	checkBoxExpertConfig	"newline , gapleft 30 , split 2"
3	GEntryReal	entryRealMaxCheck	3, 0, 0 => "newline , gapleft 30 , split 2" 3, 0, 1 => (null) 3, 1 => "split 2" 3, 2 => (null)
4	GEntryReal	entryRealThreshold	4, 0, 0 => "newline , gapleft 30 , split 2" 4, 0, 1 => (null) 4, 1 => "split 2" 4, 2 => (null)
5	GEntryInt	triggerCount	5, 0, 0 => "newline , gapleft 30 , split 2" 5, 0, 1 => (null) 5, 1 => (null)
6	GEntryReal	entryRealLocalTime	6, 0, 0 => "newline , gapleft 30 , split 2" 6, 0, 1 => (null) 6, 1 => "split 2" 6, 2 => (null)
7	GPFrame	bodyFrame	"newline" (see table below)

Default Constraint(s) for bodyFrame:

Index	Class	Item	Constraint
7, 0	GComboBoxWithLabel	comboBoxRefFrame	7, 0, 0, 0 => "newline , gapleft 30 , split 2" 7, 0, 0, 1 => (null) 7, 0, 1 => "split 4"
7, 1	GCheckBoxWithIndicator	checkBoxEOP	7, 1, 0, 0 => (null) 7, 1, 0, 1 => (null) 7, 1, 1 => (null)
7, 2	GPAbsoluteDate	absoluteDateH0	"newline" (see table below)
7, 3	GEntryReal	entryRealN	7, 3, 0, 0 => "newline , gapleft 50 , split 2" 7, 3, 0, 1 => (null) 7, 3, 1 => "split 2" 7, 3, 2 => (null)
7, 4	GEntryReal	entryRealLon	7, 4, 0, 0 => "newline , gapleft 50 , split 2" 7, 4, 0, 1 => (null) 7, 4, 1 => "split 2" 7, 4, 2 => (null)

Default Constraint(s) for absoluteDateH0:

Index	Class	Item	Constraint
7, 2, 0	GLabelWithIndicator	label	7, 2, 0, 0 => "newline , gapleft 50 , split 2" 7, 2, 0, 1 => (null)
7, 2, 1	GPDateField	dateField	"spanx 2 , split 5"
7, 2, 2	GPopupListWithLabel	popupListTimeScales	7, 2, 2, 0, 0 => "split 4" 7, 2, 2, 0, 1 => (null) 7, 2, 2, 1 => (null)
7, 2, 3	GButton	buttonRelativeDate	(null)

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
GPLocalTimeDetector(String label, CustomLocalTimeDetector localTimeDetector, org.orekit.propagation.events.EventDetector.Action... actionsToShow) Constructor.
GPLocalTimeDetector(String label, org.orekit.propagation.events.EventDetector.Action... actionsToShow) Constructor without default localTime detector.
GPLocalTimeDetector(String widgetId, String label, CustomLocalTimeDetector localTimeDetector, org.orekit.propagation.events.EventDetector.Action... actionsToShow) Constructor.
GPLocalTimeDetector(String widgetId, String label, org.orekit.propagation.events.EventDetector.Action... actionsToShow) Constructor without default localTime detector.

Method Summary

Methods

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()
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealLocalTime() Getter for the GEntryReal defining the target localTime of the event detector.
GPFrame	getGPFrameBodyFrame() Getter for the GPFrame defining the central body frame for the event detector.
CustomLocalTimeDetector	getPatriusObject() Returns the PATRIUS object associated to a GENOPUS widget.
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	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

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, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getComponent, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getSimpleWidgetId, getStatus, getStringConstraint, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, launchInvalidPositionException, parseSimpleConstraint, processGEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDisplayIsModifiedIndicator, setElement, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setNameAndCommentInConfigFile, setNameInConfigFile, setStatus, setStringConstraint, setToolTipText, setWidth, 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

GPLocalTimeDetector

public GPLocalTimeDetector(String label,
                   org.orekit.propagation.events.EventDetector.Action... actionsToShow)

Constructor without default localTime 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.

GPLocalTimeDetector

public GPLocalTimeDetector(String label,
                   CustomLocalTimeDetector localTimeDetector,
                   org.orekit.propagation.events.EventDetector.Action... actionsToShow)

Constructor. The widgetId will be assigned automatically.

Parameters:

label - text to display in the label.

localTimeDetector - localTime detector to set.

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

GPLocalTimeDetector

public GPLocalTimeDetector(String widgetId,
                   String label,
                   org.orekit.propagation.events.EventDetector.Action... actionsToShow)

Constructor without default localTime 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.

GPLocalTimeDetector

public GPLocalTimeDetector(String widgetId,
                   String label,
                   CustomLocalTimeDetector localTimeDetector,
                   org.orekit.propagation.events.EventDetector.Action... actionsToShow)

Constructor.

Parameters:

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

label - text to display in the label.

localTimeDetector - localTime 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 void setWidgetId(String widgetId)

Overrides:

setWidgetId in class GPTriggeredEventDetectorAbstract

getGEntryRealLocalTime

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

Getter for the GEntryReal defining the target localTime of the event detector.

Returns:

the GEntryReal defining the target localTime of the event detector.

getGPFrameBodyFrame

public GPFrame getGPFrameBodyFrame()

Getter for the GPFrame defining the central body frame for the event detector.

Returns:

the GPFrame defining the central body frame for the event detector.

getPatriusObject

public CustomLocalTimeDetector 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 EOP data is not initialized or if Sun ephemeris cannot be loaded

setEventDetector

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

GPEventException - if the given event detector is not compatible with the widget. If body shape defined in given localTime detector is not a one axis ellipsoid or if ellipsoid's frame is not available in the frame selector.

fr.cnes.genius.exception.GArithmeticException - if the target local time in eventDetector is NaN.

setDefaultEventDetector

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

GPEventException - If body shape defined in given localTime detector is not a one axis ellipsoid or if ellipsoid's frame is not available in the frame selector.

fr.cnes.genius.exception.GArithmeticException - if the target local time in defaultEventDetector is NaN.

setSavedEventDetector

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

GPEventException - If body shape defined in given localTime detector is not a one axis ellipsoid or if ellipsoid's frame is not available in the frame selector.

fr.cnes.genius.exception.GArithmeticException - if the target local time in savedEventDetector is NaN.

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