fr.cnes.genopus.forces

Class GPEarthPotentialForceModel

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genopus.forces.GPEarthPotentialForceModel

All Implemented Interfaces:

fr.cnes.genius.main.GClear, fr.cnes.genius.main.GCondensedIsModifiedInterface, fr.cnes.genius.main.GCondensedStatusInterface, fr.cnes.genius.main.GDisplay, fr.cnes.genius.main.GListener, fr.cnes.genius.main.GReadWrite, GPPatrius<fr.cnes.sirius.patrius.forces.ForceModel>, GPPatriusWithObjects<fr.cnes.sirius.patrius.forces.ForceModel>, MouseWheelListener, EventListener

public class GPEarthPotentialForceModel
extends fr.cnes.genius.lowLevel.GContainer
implements fr.cnes.genius.main.GDisplay, fr.cnes.genius.main.GReadWrite, fr.cnes.genius.main.GClear, fr.cnes.genius.main.GListener, fr.cnes.genius.main.GCondensedStatusInterface, GPPatriusWithObjects<fr.cnes.sirius.patrius.forces.ForceModel>, fr.cnes.genius.main.GCondensedIsModifiedInterface

Class containing the widget to define the Earth Potential force model.

Author:

ffsm

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabelWithIndicator	earthPotentialLabel	0, 0 => "newline , gapleft 0 , split 2" 0, 1 => (null)
1	GChoice	attractionModelChoice	1, 0, 0 => "newline , gapleft 20 , split 2" 1, 0, 1 => (null) 1, 1 => "split"
2	GComboBoxWithLabel	earthPotentialFileComboBox	2, 0, 0 => "newline , gapleft 20 , split 2" 2, 0, 1 => (null) 2, 1 => (null)
3	GEntryInt	maxOrdDegEntryInt	3, 0, 0 => "newline , gapleft 20 , split 2" 3, 0, 1 => (null) 3, 1 => (null)
4	GEntryInt	degreeEntryInt	4, 0, 0 => "newline , gapleft 20 , split 2" 4, 0, 1 => (null) 4, 1 => (null)
5	GEntryInt	orderEntryInt	5, 0, 0 => "newline , gapleft 20 , split 2" 5, 0, 1 => (null) 5, 1 => (null)
6	GEntryInt	degreeOptionalEntryInt	6, 0, 0 => "newline , gapleft 20 , split 2" 6, 0, 1 => (null) 6, 1 => (null)
7	GEntryInt	orderOptionalEntryInt	7, 0, 0 => "newline , gapleft 20 , split 2" 7, 0, 1 => (null) 7, 1 => (null)
8	GChoice	coeffsComputedOnceChoice	8, 0, 0 => "newline , gapleft 20 , split 2" 8, 0, 1 => (null) 8, 1 => "split"

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GPEarthPotentialForceModel.AttractionModelsEnum Enumerate for normalized/unnormalized attraction models.

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

Modifier and Type	Field and Description
static String	VARIABLE_POTENTIAL_FILENAME EIGEN GRGS default filename.

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

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GPEarthPotentialForceModel() Empty constructor.
GPEarthPotentialForceModel(String widgetId, String label, GPEarthPotentialForceModel.AttractionModelsEnum initialAttractionModel, GPEarthPotentialForceModel.AttractionModelsEnum... earthPotentialTypeChoicesToShow) Constructor.

Method Summary

Modifier and Type	Method and Description
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()
GPEarthPotentialForceModel.AttractionModelsEnum[]	getAvailableAttractionModels() Getter for the list of available Earth potential choices in the widget.
fr.cnes.sirius.patrius.frames.Frame	getEarthFrame() Getter for the Earth rotating frame to be used for the force model creation.
fr.cnes.genius.highLevel.GChoice	getGChoiceAttractionModel() Getter for the GChoice defining the attraction model.
fr.cnes.genius.highLevel.GChoice	getGChoiceCoeffsComputedOnce() Getter for the GChoice defining the coefficients computation option.
fr.cnes.genius.highLevel.GComboBoxWithLabel	getGComboBoxEarthPotentialFile() Getter for the GComboBoxWithLabel defining the earth potential filename.
fr.cnes.genius.highLevel.GEntryInt	getGEntryIntMaxDegreeAndOrder() Getter for the GEntryInt defining the maximal degree and order.
fr.cnes.genius.highLevel.GEntryInt	getGEntryIntOptionalTesseral() Getter for the GEntryInt defining the tesseral optional order.
fr.cnes.genius.highLevel.GEntryInt	getGEntryIntOptionalZonal() Getter for the GEntryInt defining the zonal optional degree.
fr.cnes.genius.highLevel.GEntryInt	getGEntryIntTesseral() Getter for the GEntryInt defining the tesseral order.
fr.cnes.genius.highLevel.GEntryInt	getGEntryIntZonal() Getter for the GEntryInt defining the zonal degree.
fr.cnes.genius.highLevel.GLabelWithIndicator	getGLabelForceModel() Getter for the label of the force model.
double	getMu() Get the Mu constant used in the Earth potential force model.
fr.cnes.sirius.patrius.forces.ForceModel	getPatriusObject() Returns the PATRIUS object associated to a GENOPUS widget.
fr.cnes.sirius.patrius.forces.ForceModel	getPatriusObject(Object... args) Returns the PATRIUS object associated to a GENOPUS widget.
GPEarthPotentialForceModel.AttractionModelsEnum	getSelectedAttractionModel() Get selected attraction model as a GPEarthPotentialForceModel.AttractionModelsEnum enum value.
fr.cnes.genius.main.GComponent	getSubComponent(int position)
boolean	isEnabled()
boolean	isModified()
void	read()
void	setAvailableAttractionModels(GPEarthPotentialForceModel.AttractionModelsEnum... attractionModelsToShow) Setter for the list of available Earth potential choices in the widget.
void	setConstraint(int widgetGap) Setter for the constraints of the widget.
void	setDefaultConstraints() Method to set the default constraints for the layout.
void	setEarthFrame(fr.cnes.sirius.patrius.frames.Frame earthFrame) Setter for the Earth rotating frame to be used for force model creation.
void	setEnabled(boolean b)
void	updateCondensedStatus(fr.cnes.genius.main.GCondensedStatus condensedStatus)
void	updateIsModified(fr.cnes.genius.main.GCondensedIsModified condensedIsModified)
protected void	updateIsModifiedIndicator()
void	updateStatus() Update the 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, 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, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setStringConstraint, setToolTipText, setWidgetId, 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

Field Detail

VARIABLE_POTENTIAL_FILENAME

public static final String VARIABLE_POTENTIAL_FILENAME

EIGEN GRGS default filename.

See Also:

Constant Field Values

Constructor Detail

GPEarthPotentialForceModel

public GPEarthPotentialForceModel()

Empty constructor.

GPEarthPotentialForceModel

public GPEarthPotentialForceModel(String widgetId,
                                  String label,
                                  GPEarthPotentialForceModel.AttractionModelsEnum initialAttractionModel,
                                  GPEarthPotentialForceModel.AttractionModelsEnum... earthPotentialTypeChoicesToShow)

Constructor.

Parameters:

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

label - text to display in the label.

initialAttractionModel - initial attraction model for the Earth potential.

earthPotentialTypeChoicesToShow - list of Earth potential choices to show in the widget (array of GPEarthPotentialForceModel.AttractionModelsEnum ). If only one, the attraction model choice is not shown.

Method Detail

setDefaultConstraints

public void setDefaultConstraints()

Method to set the default constraints for the layout.

Overrides:

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

setConstraint

public void setConstraint(int widgetGap)

Setter for the constraints of the widget.

Parameters:

widgetGap - left gap from panel border to display the label of the widget.

getGLabelForceModel

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

Getter for the label of the force model.

Returns:

the label of the force model

getGChoiceAttractionModel

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

Getter for the GChoice defining the attraction model.

Returns:

the GChoice defining the attraction model

getGComboBoxEarthPotentialFile

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

Getter for the GComboBoxWithLabel defining the earth potential filename.

Returns:

the GComboBoxWithLabel defining the earth potential filename

getGEntryIntMaxDegreeAndOrder

public fr.cnes.genius.highLevel.GEntryInt getGEntryIntMaxDegreeAndOrder()

Getter for the GEntryInt defining the maximal degree and order.

Returns:

the GEntryInt defining the maximal degree and order

getGEntryIntZonal

public fr.cnes.genius.highLevel.GEntryInt getGEntryIntZonal()

Getter for the GEntryInt defining the zonal degree.

Returns:

the GEntryInt defining the zonal degree

getGEntryIntTesseral

public fr.cnes.genius.highLevel.GEntryInt getGEntryIntTesseral()

Getter for the GEntryInt defining the tesseral order.

Returns:

the GEntryInt defining the tesseral order

getGEntryIntOptionalZonal

public fr.cnes.genius.highLevel.GEntryInt getGEntryIntOptionalZonal()

Getter for the GEntryInt defining the zonal optional degree.

Returns:

the GEntryInt defining the zonal optional degree

getGEntryIntOptionalTesseral

public fr.cnes.genius.highLevel.GEntryInt getGEntryIntOptionalTesseral()

Getter for the GEntryInt defining the tesseral optional order.

Returns:

the GEntryInt defining the tesseral optional order

getGChoiceCoeffsComputedOnce

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

Getter for the GChoice defining the coefficients computation option.

Returns:

the GChoice defining the coefficients computation option

setEarthFrame

public void setEarthFrame(fr.cnes.sirius.patrius.frames.Frame earthFrame)

Setter for the Earth rotating frame to be used for force model creation. Requiered for the force model.

Parameters:

earthFrame - the Earth rotating frame to be set.

getEarthFrame

public fr.cnes.sirius.patrius.frames.Frame getEarthFrame()

Getter for the Earth rotating frame to be used for the force model creation. Requiered for the force model.

Returns:

the internal Earth rotating frame.

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

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

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

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

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

getPatriusObject

public fr.cnes.sirius.patrius.forces.ForceModel getPatriusObject()
                                                          throws GPForcesException

Returns the PATRIUS object associated to a GENOPUS widget.

Specified by:

getPatriusObject in interface GPPatrius<fr.cnes.sirius.patrius.forces.ForceModel>

Returns:

the PATRIUS object associated to the widget.

Throws:

GPForcesException - if the Earth frame has not been initialized or if the potential provider or the C and S coefficients for the potential force model cannot be computed

getPatriusObject

public fr.cnes.sirius.patrius.forces.ForceModel getPatriusObject(Object... args)
                                                          throws fr.cnes.genius.exception.GException

Returns the PATRIUS object associated to a GENOPUS widget.

Specified by:

getPatriusObject in interface GPPatriusWithObjects<fr.cnes.sirius.patrius.forces.ForceModel>

Parameters:

args - The parameters are 0: Frame.

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.

getSelectedAttractionModel

public GPEarthPotentialForceModel.AttractionModelsEnum getSelectedAttractionModel()

Get selected attraction model as a GPEarthPotentialForceModel.AttractionModelsEnum enum value.

Returns:

the selected attraction model

getMu

public double getMu()
             throws GPForcesException

Get the Mu constant used in the Earth potential force model.

Returns:

the Mu constant

Throws:

GPForcesException - if the Earth potential force model cannot be created.

setAvailableAttractionModels

public void setAvailableAttractionModels(GPEarthPotentialForceModel.AttractionModelsEnum... attractionModelsToShow)
                                  throws GPForcesException

Setter for the list of available Earth potential choices in the widget. If the list of choices is null or empty, all of them will be shown. If only one is set, the attraction model selector will not be displayed.

Parameters:

attractionModelsToShow - an array of GPEarthPotentialForceModel.AttractionModelsEnum with the list of available Earth potential choices in the widget. If null: all choices will be shown.

Throws:

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

getAvailableAttractionModels

public GPEarthPotentialForceModel.AttractionModelsEnum[] getAvailableAttractionModels()

Getter for the list of available Earth potential choices in the widget.

Returns:

an array of GPEarthPotentialForceModel.AttractionModelsEnum with the list of available Earth potential choices in the widget.

updateCondensedStatus

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

Specified by:

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

isModified

public boolean isModified()

Overrides:

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

Returns:

the boolean stating if the widget is modified

updateIsModifiedIndicator

protected void updateIsModifiedIndicator()

Overrides:

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

attachCopyPasteMenu

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

Overrides:

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

updateStatus

public void updateStatus()

Update the status of 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

updateIsModified

public void updateIsModified(fr.cnes.genius.main.GCondensedIsModified condensedIsModified)

Specified by:

updateIsModified in interface fr.cnes.genius.main.GCondensedIsModifiedInterface