fr.cnes.genopus.events

Class GPVisibilityFromStationDetector

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

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>, MouseWheelListener, EventListener

public class GPVisibilityFromStationDetector
extends GPTriggeredEventDetectorAbstract
implements fr.cnes.genius.main.GReadWrite, GPPatriusWithObjects<CustomEventDetector>

Widget representing an Orekit's VisibilityFromStationDetector.

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	GButton	setStationsButton	"newline , gapleft 10 , spanx 3"
	(undefined)	(undefined)	(undefined)
7	GComboBoxWithLabel	comboBoxStation	"newline"
8	GComponentList	mStationComponentList	"newline , gapleft 0 , spanx 3" (see table below)
9	GStandardPanelDialog	mStationListDialog	"newline , pushx , pushy , growx , growy"
10	GChoice	choiceVisibilityDetector	10, 0, 0 => "newline , gapleft 30 , split 2" 10, 0, 1 => (null) 10, 1 => "split" *

Default Constraint(s) for mStationComponentList:

Index	Class	Item	Constraint
4, 0	GHeaderPanel	header	"hmin 40" (see table below)
4, 1	GLabel	spaceLabel	"newline , height 0"

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GPVisibilityFromStationDetector.GPStationsComponentList Widget to define a list of ground stations with required methods to deny the introduction of two stations with the same name.
static class	GPVisibilityFromStationDetector.VisibilityDetectionChoice Choices for visibility from station events detection.

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
GPVisibilityFromStationDetector() Empty constructor.
GPVisibilityFromStationDetector(String widgetId) Constructor.
GPVisibilityFromStationDetector(String label, CustomVisibilityFromStationDetector visibilityFromStationDetector, fr.cnes.sirius.patrius.events.EventDetector.Action... actionsToShow) Constructor.
GPVisibilityFromStationDetector(String label, fr.cnes.sirius.patrius.events.EventDetector.Action... actionsToShow) Constructor without default visibilityFromStation detector.
GPVisibilityFromStationDetector(String widgetId, String label, CustomVisibilityFromStationDetector visibilityFromStationDetector, fr.cnes.sirius.patrius.events.EventDetector.Action... actionsToShow) Constructor.
GPVisibilityFromStationDetector(String widgetId, String label, fr.cnes.sirius.patrius.events.EventDetector.Action... actionsToShow) Constructor without default visibilityFromStation 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()
fr.cnes.genius.highLevel.GChoice	getGChoiceVisibilityDetector() Getter for the GChoice representing visibility detector choice (0-entering FoW, 1-exiting FoW, 2-entering or exiting FoW)visibility detector choice (0-entering FoW, 1-exiting FoW, 2-entering or exiting FoW).
ArrayList<GPGroundStation>	getGroundStationsList() Get ground stations list.
CustomEventDetector	getPatriusObject() Returns the PATRIUS object associated to a GENOPUS widget.
CustomEventDetector	getPatriusObject(Object... args) Returns the PATRIUS object associated to a GENOPUS widget.
GPGroundStation	getSelectedStation()
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	read()
void	setBodyShape(fr.cnes.sirius.patrius.bodies.OneAxisEllipsoid ellipsoid) Setter for the OneAxisEllipsoid defining the central ellipsoid for the event detector.
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	setGroundStationsList(ArrayList<fr.cnes.genius.main.GComponent> stationList) Set ground stations list.
void	setSavedEventDetector(CustomEventDetector savedEventDetector) Setter for the reference event detector.
void	setWidgetId(String widgetId)
void	updateCondensedStatus(fr.cnes.genius.main.GCondensedStatus condensedStatus)
void	write()

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, setAvailableActions, setDefaultConstraint, setDisplayExpertConfig, updateIsModifiedIndicator, updateStatus

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

GPVisibilityFromStationDetector

public GPVisibilityFromStationDetector()

Empty constructor.

GPVisibilityFromStationDetector

public GPVisibilityFromStationDetector(String widgetId)

Constructor.

Parameters:

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

GPVisibilityFromStationDetector

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

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

GPVisibilityFromStationDetector

public GPVisibilityFromStationDetector(String label,
                                       CustomVisibilityFromStationDetector visibilityFromStationDetector,
                                       fr.cnes.sirius.patrius.events.EventDetector.Action... actionsToShow)

Constructor. The widgetId will be assigned automatically.

Parameters:

label - text to display in the label.

visibilityFromStationDetector - visibilityFromStation detector to set.

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

GPVisibilityFromStationDetector

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

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

GPVisibilityFromStationDetector

public GPVisibilityFromStationDetector(String widgetId,
                                       String label,
                                       CustomVisibilityFromStationDetector visibilityFromStationDetector,
                                       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.

visibilityFromStationDetector - visibilityFromStation 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

getGChoiceVisibilityDetector

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

Getter for the GChoice representing visibility detector choice (0-entering FoW, 1-exiting FoW, 2-entering or exiting FoW)visibility detector choice (0-entering FoW, 1-exiting FoW, 2-entering or exiting FoW).

Returns:

the visibility detector choice (0-entering FoW, 1-exiting FoW, 2-entering or exiting FoW).

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: OneAxisEllipsoid.

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.

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 EOP data is not initialized

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:

GPEventException - if the given event detector is not compatible with the widget. If body shape defined in given visibilityFromStation 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 latitude, longitude or altitude in the geodeticPoint in eventDetector are NaN or if if eq. radius or flatness in ellipsoid in eventDetector are NaN.

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:

GPEventException - If body shape defined in given visibilityFromStation 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 latitude, longitude or altitude in the geodeticPoint in defaultEventDetector are NaN or if if eq. radius or flatness in ellipsoid in defaultEventDetector are NaN.

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:

GPEventException - If body shape defined in given visibilityFromStation 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 latitude, longitude or altitude in the geodeticPoint in savedEventDetector are NaN or if if eq. radius or flatness in ellipsoid in savedEventDetector are NaN.

setBodyShape

public void setBodyShape(fr.cnes.sirius.patrius.bodies.OneAxisEllipsoid ellipsoid)
                  throws GPEventException,
                         fr.cnes.genius.exception.GArithmeticException

Setter for the OneAxisEllipsoid defining the central ellipsoid for the event detector. When it is set with this method, the GPOneAxisEllipsoid widget is no further visible. If the input ellipsoid is null, the GPOneAxisEllipsoid widget is forced to be visible.

Parameters:

ellipsoid - the OneAxisEllipsoid defining the central body shape for the event detector.

Throws:

GPEventException - if frame contained in the ellipsoid is not available in the GPOneAxisEllipsoid frame selector

fr.cnes.genius.exception.GArithmeticException - if eq. radius or flatness in ellipsoid are 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

read

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

Specified by:

read in interface fr.cnes.genius.main.GReadWrite

Overrides:

read in class GPEventDetectorAbstract

Throws:

fr.cnes.genius.exception.GException

write

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

Specified by:

write in interface fr.cnes.genius.main.GReadWrite

Overrides:

write in class GPEventDetectorAbstract

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

getGroundStationsList

public ArrayList<GPGroundStation> getGroundStationsList()

Get ground stations list.

Returns:

the station list

setGroundStationsList

public void setGroundStationsList(ArrayList<fr.cnes.genius.main.GComponent> stationList)
                           throws fr.cnes.genius.exception.GComponentListException

Set ground stations list.

Parameters:

stationList - stations list

Throws:

fr.cnes.genius.exception.GComponentListException - problem to set ground station list

getSelectedStation

public GPGroundStation getSelectedStation()

Returns:

the selectedStation