fr.cnes.genopus.events

Class GPEclipseDetector

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

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>, GPPatriusWithObjects<CustomEventDetector>

public class GPEclipseDetector
extends GPTriggeredEventDetectorAbstract
implements GPPatriusWithObjects<CustomEventDetector>

Widget representing an Orekit's EclipseDetector.

Author:

ffsm

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	GChoice	choiceEventType	6, 0, 0 => "newline , gapleft 30 , split 2" 6, 0, 1 => (null) 6, 1 => "split"
7	GPEntryEarthEqRad	entryEarthEqRad	"newline" (see table below)

Default Constraint(s) for entryEarthEqRad:

Index	Class	Item	Constraint
7, 0	GLabelWithIndicator	label	7, 0, 0 => "newline , gapleft 30 , split 2" 7, 0, 1 => (null)
7, 1	GRealField	textField	(null)
7, 2	GPopupList	units	(null)
7, 3	GConstantSelector	constantSelector	"newline" (see table below)

Default Constraint(s) for constantSelector:

Index	Class	Item	Constraint
7, 3, 0	GButton	button	"split 2"
7, 3, 1	GConstantSelelectorDialog	dialog	"newline , pushx , pushy , growx , growy" (see table below)

Default Constraint(s) for dialog:

Index	Class	Item	Constraint
7, 3, 1, 0	GComboBoxWithLabel	combobox	7, 3, 1, 0, 0, 0 => "split 3" 7, 3, 1, 0, 0, 1 => (null) 7, 3, 1, 0, 1 => (null)
7, 3, 1, 1	GLabel	label	"newline , split 3"
7, 3, 1, 2	GLabel	valueLabel	(null)
7, 3, 1, 3	GLabel	unitLabel	(null)
7, 3, 1, 4	GButton	selectButton	"newline , pushx , pushy"
7, 3, 1, 5	GButton	cancelButton	(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

Nested classes/interfaces inherited from interface fr.cnes.genopus.main.GPPatriusWithObjects

GPPatriusWithObjects.ArgsChecker

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
GPEclipseDetector(String label, CustomEclipseDetector eclipseDetector, org.orekit.propagation.events.EventDetector.Action... actionsToShow) Constructor.
GPEclipseDetector(String label, org.orekit.propagation.events.EventDetector.Action... actionsToShow) Constructor without default eclipse detector.
GPEclipseDetector(String widgetId, String label, CustomEclipseDetector eclipseDetector, org.orekit.propagation.events.EventDetector.Action... actionsToShow) Constructor.
GPEclipseDetector(String widgetId, String label, org.orekit.propagation.events.EventDetector.Action... actionsToShow) Constructor without default eclipse 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	clear()
void	display()
void	generic()
double	getBodyEqRad() Getter for the body's equatorial radius for the event detector.
fr.cnes.genius.highLevel.GChoice	getGChoiceEventType() Getter for the Gchoice defining the type of event, entering or exiting the eclipse.
GPEntryEarthEqRad	getGPEntryEarthEqRad() Getter for the GPEntryEarthEqRad defining the equatorial radius for the Earth (occulting radius for the ecclipse).
CustomEclipseDetector	getPatriusObject() Returns the PATRIUS object associated to a GENOPUS widget.
CustomEventDetector	getPatriusObject(Object... args) 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	setBodyEqRad(Double bodyEqRad) Setter for the body's equatorial radius for the event detector.
void	setBodyEqRadWidgetVisible(boolean b) Method to force the GPEntryEarthEqRad widget to be visible/invisible.
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, 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

GPEclipseDetector

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

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

GPEclipseDetector

public GPEclipseDetector(String label,
                 CustomEclipseDetector eclipseDetector,
                 org.orekit.propagation.events.EventDetector.Action... actionsToShow)

Constructor. The widgetId will be assigned automatically.

Parameters:

label - text to display in the label.

eclipseDetector - eclipse detector to set.

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

GPEclipseDetector

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

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

GPEclipseDetector

public GPEclipseDetector(String widgetId,
                 String label,
                 CustomEclipseDetector eclipseDetector,
                 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.

eclipseDetector - eclipse 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

getGChoiceEventType

public fr.cnes.genius.highLevel.GChoice getGChoiceEventType()

Getter for the Gchoice defining the type of event, entering or exiting the eclipse.

Returns:

the Gchoice defining the type of event, entering or exiting the eclipse.

getGPEntryEarthEqRad

public GPEntryEarthEqRad getGPEntryEarthEqRad()

Getter for the GPEntryEarthEqRad defining the equatorial radius for the Earth (occulting radius for the ecclipse).

Returns:

the GPEntryEarthEqRad defining the equatorial radius for the Earth.

setBodyEqRadWidgetVisible

public void setBodyEqRadWidgetVisible(boolean b)

Method to force the GPEntryEarthEqRad widget to be visible/invisible.

Parameters:

b - if true the widget will be visible, if false it will not.

setBodyEqRad

public void setBodyEqRad(Double bodyEqRad)
                  throws fr.cnes.genius.exception.GArithmeticException

Setter for the body's equatorial radius for the event detector. When it is set with this method, the GPEntryEarthEqRad widget is no further visible. If the input radius is null, the GPEntryEarthEqRad widget is forced to be visible.

Parameters:

bodyEqRad - the body's equatorial radius for the event detector.

Throws:

fr.cnes.genius.exception.GArithmeticException - if bodyEqRad is NaN.

getBodyEqRad

public double getBodyEqRad()

Getter for the body's equatorial radius for the event detector.

Returns:

the body's equatorial radius for the event detector.

getPatriusObject

public CustomEclipseDetector getPatriusObject()

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.

getPatriusObject

public CustomEventDetector getPatriusObject(Object... args)
                                     throws fr.cnes.genius.exception.GException

Returns the PATRIUS object associated to a GENOPUS widget.

Specified by:

getPatriusObject in interface GPPatriusWithObjects<CustomEventDetector>

Parameters:

args - The parameters are 0: ExtendedOneAxisEllipsoid.

Returns:

the PATRIUS object associated to the widget.

Throws:

fr.cnes.genius.exception.GException - if the PATRIUS object cannot be created from the widget data.

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 eclipse 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 occulting radious 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 eclipse 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 occulting radious 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 eclipse 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 occulting radious 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

clear

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

Specified by:

clear in interface fr.cnes.genius.main.GClear

Overrides:

clear in class GPEventDetectorAbstract

Throws:

fr.cnes.genius.exception.GException

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)

Specified by:

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

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