fr.cnes.genopus.frames
Class GPFramesConfiguration

java.lang.Object
  fr.cnes.genius.main.GComponent
      fr.cnes.genius.lowLevel.GContainer
          fr.cnes.genopus.frames.GPFramesConfiguration

All Implemented Interfaces:

fr.cnes.genius.main.GClear, fr.cnes.genius.main.GDisplay, fr.cnes.genius.main.GListener, fr.cnes.genius.main.GReadWrite, GPPatrius<org.orekit.frames.configuration.FramesConfiguration>

public class GPFramesConfiguration
extends fr.cnes.genius.lowLevel.GContainer
implements fr.cnes.genius.main.GReadWrite, fr.cnes.genius.main.GListener, fr.cnes.genius.main.GDisplay, fr.cnes.genius.main.GClear, GPPatrius<org.orekit.frames.configuration.FramesConfiguration>

Widget representing an OREKIT FramesConfiguration.

Author:

ffsm

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabelWithIndicator	label	0, 0 => "newline , spanx 2 , split 2" 0, 1 => (null)
1	GComboBoxWithLabel	comboBoxFrameConfs	1, 0, 0 => "newline , gapleft 30 , split 2" 1, 0, 1 => (null) 1, 1 => (null)
2	GChoice	choiceCustom	2, 0, 0 => "newline , gapleft 30 , split 2" 2, 0, 1 => (null) 2, 1 => "split"
3	GLabel	labelPolarMotionSection	"newline , gapleft 30 , split 2"
4	GCheckBoxWithIndicator	checkBoxPolarMotionTidesCorrection	4, 0, 0 => "newline , gapleft 60 , split 2" 4, 0, 1 => (null) 4, 1 => (null)
5	GChoice	choicePolarMotionTidesInterpOption	5, 0, 0 => "newline , gapleft 90 , split 2" 5, 0, 1 => (null) 5, 1 => "split"
6	GCheckBoxWithIndicator	checkBoxPolarMotionLibrationCorrection	6, 0, 0 => "newline , gapleft 60 , split 2" 6, 0, 1 => (null) 6, 1 => (null)
7	GCheckBoxWithIndicator	checkBoxSpCorrection	7, 0, 0 => "newline , gapleft 60 , split 2" 7, 0, 1 => (null) 7, 1 => (null)
8	GCheckBoxWithIndicator	checkBoxEopsForPolarMotion	8, 0, 0 => "newline , gapleft 60 , split 2" 8, 0, 1 => (null) 8, 1 => (null)
9	GLabel	labelDiurnalRotationSection	"newline , gapleft 30 , split 2"
10	GCheckBoxWithIndicator	checkBoxDiurnalRotationTidesCorrection	10, 0, 0 => "newline , gapleft 60 , split 2" 10, 0, 1 => (null) 10, 1 => (null)
11	GChoice	choiceDiurnalRotationTidesInterpOption	11, 0, 0 => "newline , gapleft 90 , split 2" 11, 0, 1 => (null) 11, 1 => "split"
12	GCheckBoxWithIndicator	checkBoxDiurnalRotationLibrationCorrection	12, 0, 0 => "newline , gapleft 60 , split 2" 12, 0, 1 => (null) 12, 1 => (null)
13	GLabel	labelPrecNutSection	"newline , gapleft 30 , split 2"
14	GCheckBoxWithIndicator	checkBoxPrecNutCorrection	14, 0, 0 => "newline , gapleft 60 , split 2" 14, 0, 1 => (null) 14, 1 => (null)
15	GCheckBoxWithIndicator	checkBoxConstantRotation	15, 0, 0 => "newline , gapleft 90 , split 2" 15, 0, 1 => (null) 15, 1 => (null)
16	GChoice	choicePrecNutInterpOption	16, 0, 0 => "newline , gapleft 90 , split 2" 16, 0, 1 => (null) 16, 1 => "split"
17	GCheckBoxWithIndicator	checkBoxEopsForNutation	17, 0, 0 => "newline , gapleft 60 , split 2" 17, 0, 1 => (null) 17, 1 => (null)
18	GLabel	labelEopsHistoryData	"newline , gapleft 30 , split 2"
19	GCheckBoxWithIndicator	checkBoxEopsCorrection	19, 0, 0 => "newline , gapleft 60 , split 2" 19, 0, 1 => (null) 19, 1 => (null)
20	GChoice	eOPsInterpolator	20, 0, 0 => "newline , gapleft 90 , split 2" 20, 0, 1 => (null) 20, 1 => "split"

Nested Class Summary

static class	GPFramesConfiguration.GPFrameConfs Available frame configurations.
static class	GPFramesConfiguration.GPModes Available modes.

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.genius.main.GComponent

NAME_ATTRIBUTE

Constructor Summary

GPFramesConfiguration(GPFramesConfiguration.GPFrameConfs frameConf, String label, GPFramesConfiguration.GPFrameConfs... frameConfsToShow)
Constructor.

GPFramesConfiguration(String label)
Constructor without frames configuration and without list of frame configurations for the widget (all from GPFramesConfiguration.GPFrameConfs will be shown).

GPFramesConfiguration(String label, GPFramesConfiguration.GPFrameConfs... frameConfsToShow)
Constructor without frames configuration.

GPFramesConfiguration(String label, GPFramesConfiguration.GPFrameConfs frameConf)
Constructor without list of frame configurations for the widget (all from GPFramesConfiguration.GPFrameConfs will be shown).

GPFramesConfiguration(String widgetId, GPFramesConfiguration.GPFrameConfs frameConf, String label)
Constructor without list of frame configurations for the widget (all from GPFramesConfiguration.GPFrameConfs will be shown).

GPFramesConfiguration(String widgetId, GPFramesConfiguration.GPFrameConfs frameConf, String label, GPFramesConfiguration.GPFrameConfs... frameConfsToShow)
Constructor.

GPFramesConfiguration(String widgetId, String label)
Constructor without frames configuration and without list of frame configurations for the widget (all from GPFramesConfiguration.GPFrameConfs will be shown).

GPFramesConfiguration(String widgetId, String label, GPFramesConfiguration.GPFrameConfs... frameConfsToShow)
Constructor without frames configuration.

Method Summary

void	after(fr.cnes.genius.main.GEvent e)
void	attachCopyPasteMenu(String label, fr.cnes.genius.main.GComponent.CopyPasteOperation... operationList)
void	before(fr.cnes.genius.main.GEvent e)
void	clear()
void	display()
void	generic()
GPFramesConfiguration.GPFrameConfs[]	getAvailableFrameConfs() Getter for the list of frame configurations available in the widget.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxEopsCorrection() Getter for the EoPs 2000 history checkbox.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxEopsForNutation() Getter for the checkbox to apply or not EoPs correction to the Nutation.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxEopsForPolarMotion() Getter for the checkbox to apply or not EoPs correction to the Polar Motion.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxLibrationCorrectionDiurnalRotation() Getter for the libration correction for Diurnal Rotation checkbox.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxLibrationCorrectionPolarMotion() Getter for the libration correction for Polar Motion checkbox.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxPrecNutConstantRotation() Getter for the "constant rotation" checkbox for the tides correction.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxPrecNutCorrection() Getter for the precession nutation correction checkbox.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxSpCorrection() Getter for the s prime correction checkbox.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxTidesCorrectionDiurnalRotation() Getter for the tides correction for Diurnal Rotation checkbox.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxTidesCorrectionPolarMotion() Getter for the tides correction for Polar Motion checkbox.
fr.cnes.genius.highLevel.GChoice	getGChoiceCustom() Getter for the widget mode choice.
fr.cnes.genius.highLevel.GChoice	getGChoiceInterpolator() Getter for the EoPs 2000 interpolator choice.
fr.cnes.genius.highLevel.GChoice	getGChoicePrecNutInterpOption() Getter for the "interpolation option" checkbox for the tides correction.
fr.cnes.genius.highLevel.GChoice	getGChoiceTidesInterpOptionDiurnalRotation() Getter for the "interpolation option" checkbox for the tides correction for Diurnal Rotation.
fr.cnes.genius.highLevel.GChoice	getGChoiceTidesInterpOptionPolarMotion() Getter for the "interpolation option" checkbox for the tides correction for Polar Motion.
fr.cnes.genius.highLevel.GComboBoxWithLabel	getGComboBoxFrameConfs() Getter for the frames configuration combobox.
fr.cnes.genius.highLevel.GLabelWithIndicator	getGLabel() Getter for the widget label.
org.orekit.frames.configuration.FramesConfiguration	getPatriusObject() Returns the PATRIUS object associated to a GENOPUS widget.
fr.cnes.genius.main.GComponent	getSubComponent(int position)
boolean	isEnabled()
boolean	isModified()
void	read()
void	setAvailableFrameConfs(GPFramesConfiguration.GPFrameConfs... frameConfsToShow) Setter for the list of frame configurations available in the widget.
void	setConstraints(int gap) Setter for the constraint of the widget.
void	setDefaultFramesConfiguration(GPFramesConfiguration.GPFrameConfs defaultFrameConf) Setter for the default frames configuration.
void	setEnabled(boolean b)
void	setFramesConfiguration(GPFramesConfiguration.GPFrameConfs frameConf) Frames configuration setter.
void	setSavedFramesConfiguration(GPFramesConfiguration.GPFrameConfs savedFrameConf) Setter for the saved frames configuration.
protected void	updateIsModifiedIndicator() Updates the isModified indicator with the composed status of the widget.
void	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, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getSimpleWidgetId, getStatus, getStringConstraint, getWidgetId, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, launchInvalidPositionException, parseSimpleConstraint, processGEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDisplayIsModifiedIndicator, setElement, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setNameAndCommentInConfigFile, setNameInConfigFile, setStatus, setStringConstraint, setToolTipText, setWidgetId, 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

GPFramesConfiguration

public GPFramesConfiguration(String label)

Constructor without frames configuration and without list of frame configurations for the widget (all from GPFramesConfiguration.GPFrameConfs will be shown). The widgetId will be assigned automatically.

Parameters:

label - label.

GPFramesConfiguration

public GPFramesConfiguration(String label,
                             GPFramesConfiguration.GPFrameConfs... frameConfsToShow)

Constructor without frames configuration. The widgetId will be assigned automatically.

Parameters:

label - label.

frameConfsToShow - list of frame configurations to show in the widget.

GPFramesConfiguration

public GPFramesConfiguration(String widgetId,
                             String label)

Constructor without frames configuration and without list of frame configurations for the widget (all from GPFramesConfiguration.GPFrameConfs will be shown).

Parameters:

widgetId - widget id.

label - label.

GPFramesConfiguration

public GPFramesConfiguration(String widgetId,
                             String label,
                             GPFramesConfiguration.GPFrameConfs... frameConfsToShow)

Constructor without frames configuration.

Parameters:

widgetId - widget id.

label - label.

frameConfsToShow - list of frame configurations to show in the widget.

GPFramesConfiguration

public GPFramesConfiguration(String label,
                             GPFramesConfiguration.GPFrameConfs frameConf)

Constructor without list of frame configurations for the widget (all from GPFramesConfiguration.GPFrameConfs will be shown). The widgetId will be assigned automatically.

Parameters:

label - label.

frameConf - initial frame configuration. It must be a frame configuration available in the widget, otherwise it will throw a GRuntimeException.

GPFramesConfiguration

public GPFramesConfiguration(GPFramesConfiguration.GPFrameConfs frameConf,
                             String label,
                             GPFramesConfiguration.GPFrameConfs... frameConfsToShow)

Constructor. The widgetId will be assigned automatically.

Parameters:

label - label.

frameConf - initial frame configuration. It must be a frame configuration available in the widget, otherwise it will throw a GRuntimeException.

frameConfsToShow - list of frame configurations to show in the widget.

GPFramesConfiguration

public GPFramesConfiguration(String widgetId,
                             GPFramesConfiguration.GPFrameConfs frameConf,
                             String label)

Constructor without list of frame configurations for the widget (all from GPFramesConfiguration.GPFrameConfs will be shown).

Parameters:

widgetId - widget id.

label - label.

frameConf - initial frame configuration. It must be a frame configuration available in the widget, otherwise it will throw a GRuntimeException.

GPFramesConfiguration

public GPFramesConfiguration(String widgetId,
                             GPFramesConfiguration.GPFrameConfs frameConf,
                             String label,
                             GPFramesConfiguration.GPFrameConfs... frameConfsToShow)

Constructor.

Parameters:

widgetId - widget id.

label - label.

frameConf - initial frame configuration. It must be a frame configuration available in the widget, otherwise it will throw a GRuntimeException.

frameConfsToShow - list of frame configurations to show in the widget.

Method Detail

getGLabel

public fr.cnes.genius.highLevel.GLabelWithIndicator getGLabel()

Getter for the widget label.

Returns:

the widget label.

getGComboBoxFrameConfs

public fr.cnes.genius.highLevel.GComboBoxWithLabel getGComboBoxFrameConfs()

Getter for the frames configuration combobox.

Returns:

the frames configuration combobox.

getGChoiceCustom

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

Getter for the widget mode choice.

Returns:

the widget mode choice

getGCheckBoxTidesCorrectionPolarMotion

public fr.cnes.genius.highLevel.GCheckBoxWithIndicator getGCheckBoxTidesCorrectionPolarMotion()

Getter for the tides correction for Polar Motion checkbox.

Returns:

the tides correction for Polar Motion checkbox

getGChoiceTidesInterpOptionPolarMotion

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

Getter for the "interpolation option" checkbox for the tides correction for Polar Motion.

Returns:

the "interpolation option" checkbox for the tides correction for Polar Motion

getGCheckBoxLibrationCorrectionPolarMotion

public fr.cnes.genius.highLevel.GCheckBoxWithIndicator getGCheckBoxLibrationCorrectionPolarMotion()

Getter for the libration correction for Polar Motion checkbox.

Returns:

the libration correction for Polar Motion checkbox

getGCheckBoxSpCorrection

public fr.cnes.genius.highLevel.GCheckBoxWithIndicator getGCheckBoxSpCorrection()

Getter for the s prime correction checkbox.

Returns:

the s prime correction checkbox

getGCheckBoxEopsForPolarMotion

public fr.cnes.genius.highLevel.GCheckBoxWithIndicator getGCheckBoxEopsForPolarMotion()

Getter for the checkbox to apply or not EoPs correction to the Polar Motion.

Returns:

the checkbox to apply or not EoPs correction to the Polar Motion

getGCheckBoxTidesCorrectionDiurnalRotation

public fr.cnes.genius.highLevel.GCheckBoxWithIndicator getGCheckBoxTidesCorrectionDiurnalRotation()

Getter for the tides correction for Diurnal Rotation checkbox.

Returns:

the tides correction for Diurnal Rotation checkbox

getGChoiceTidesInterpOptionDiurnalRotation

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

Getter for the "interpolation option" checkbox for the tides correction for Diurnal Rotation.

Returns:

the "interpolation option" checkbox for the tides correction for Diurnal Rotation

getGCheckBoxLibrationCorrectionDiurnalRotation

public fr.cnes.genius.highLevel.GCheckBoxWithIndicator getGCheckBoxLibrationCorrectionDiurnalRotation()

Getter for the libration correction for Diurnal Rotation checkbox.

Returns:

the libration correction for Diurnal Rotation checkbox

getGCheckBoxPrecNutCorrection

public fr.cnes.genius.highLevel.GCheckBoxWithIndicator getGCheckBoxPrecNutCorrection()

Getter for the precession nutation correction checkbox.

Returns:

the precession nutation correction checkbox

getGCheckBoxPrecNutConstantRotation

public fr.cnes.genius.highLevel.GCheckBoxWithIndicator getGCheckBoxPrecNutConstantRotation()

Getter for the "constant rotation" checkbox for the tides correction.

Returns:

the "constant rotation" checkbox for the tides correction

getGChoicePrecNutInterpOption

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

Getter for the "interpolation option" checkbox for the tides correction.

Returns:

the "interpolation option" checkbox for the tides correction

getGCheckBoxEopsForNutation

public fr.cnes.genius.highLevel.GCheckBoxWithIndicator getGCheckBoxEopsForNutation()

Getter for the checkbox to apply or not EoPs correction to the Nutation.

Returns:

the checkbox to apply or not EoPs correction to the Nutation

getGCheckBoxEopsCorrection

public fr.cnes.genius.highLevel.GCheckBoxWithIndicator getGCheckBoxEopsCorrection()

Getter for the EoPs 2000 history checkbox.

Returns:

the EoPs 2000 history checkbox

getGChoiceInterpolator

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

Getter for the EoPs 2000 interpolator choice.

Returns:

the EoPs 2000 interpolator choice

getPatriusObject

public org.orekit.frames.configuration.FramesConfiguration getPatriusObject()
                                                                     throws GPFrameException

Returns the PATRIUS object associated to a GENOPUS widget.

Specified by:

getPatriusObject in interface GPPatrius<org.orekit.frames.configuration.FramesConfiguration>

Returns:

the PATRIUS object associated to the widget.

Throws:

GPFrameException

setAvailableFrameConfs

public void setAvailableFrameConfs(GPFramesConfiguration.GPFrameConfs... frameConfsToShow)
                            throws GPFrameException

Setter for the list of frame configurations available in the widget. The current selected frame configuration must be one of them. If the list of frame configurations is null, all of them will be shown.

Parameters:

frameConfsToShow - an array of GPFrameConfs with the list of frame configurations to show in the widget. If null: all frame configurations will be shown.

Throws:

GPFrameException - if the new list of frame configurations is empty.

getAvailableFrameConfs

public GPFramesConfiguration.GPFrameConfs[] getAvailableFrameConfs()

Getter for the list of frame configurations available in the widget.

Returns:

an array of GPFrameConfs with the list of frame configurations available in the widget.

setFramesConfiguration

public void setFramesConfiguration(GPFramesConfiguration.GPFrameConfs frameConf)
                            throws GPFrameException

Frames configuration setter. It is only available for the PATRIUS FramesConfigurationFactory choices.

Parameters:

frameConf - patrius FramesConfiguration object

Throws:

GPFrameException - in case the frames configuration type is not available in the widget.

setDefaultFramesConfiguration

public void setDefaultFramesConfiguration(GPFramesConfiguration.GPFrameConfs defaultFrameConf)
                                   throws GPFrameException

Setter for the default frames configuration. It is only available for the PATRIUS FramesConfigurationFactory choices.

Parameters:

defaultFrameConf - patrius FramesConfiguration object to be set as default one.

Throws:

GPFrameException - in case the FramesConfiguration cannot be set.

setSavedFramesConfiguration

public void setSavedFramesConfiguration(GPFramesConfiguration.GPFrameConfs savedFrameConf)
                                 throws GPFrameException

Setter for the saved frames configuration.

Parameters:

savedFrameConf - patrius FramesConfiguration object to be set as saved one.

Throws:

GPFrameException - in case the FramesConfiguration cannot be set.

attachCopyPasteMenu

public void attachCopyPasteMenu(String label,
                                fr.cnes.genius.main.GComponent.CopyPasteOperation... operationList)

Overrides:

attachCopyPasteMenu in class fr.cnes.genius.main.GComponent

isModified

public boolean isModified()

Overrides:

isModified in class fr.cnes.genius.main.GComponent

updateIsModifiedIndicator

protected void updateIsModifiedIndicator()

Updates the isModified indicator with the composed status of the widget.

Overrides:

updateIsModifiedIndicator in class fr.cnes.genius.main.GComponent

isEnabled

public boolean isEnabled()

Overrides:

isEnabled in class fr.cnes.genius.main.GComponent

setEnabled

public void setEnabled(boolean b)

Overrides:

setEnabled in class fr.cnes.genius.main.GComponent

clear

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

Specified by:

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

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

Throws:

fr.cnes.genius.exception.GException

before

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

Specified by:

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

Throws:

fr.cnes.genius.exception.GException

after

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

Specified by:

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

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

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

Throws:

fr.cnes.genius.exception.GException

generic

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

Specified by:

generic in class fr.cnes.genius.lowLevel.GContainer

Throws:

fr.cnes.genius.exception.GException

setConstraints

public void setConstraints(int gap)

Setter for the constraint of the widget.

Parameters:

gap - left gap for the widget

getSubComponent

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

Overrides:

getSubComponent in class fr.cnes.genius.main.GComponent

Throws:

fr.cnes.genius.exception.GComponentException