fr.cnes.genopus.forces

Class GPOceanTidesForceModel

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genopus.forces.GPOceanTidesForceModel

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<fr.cnes.sirius.patrius.forces.gravity.tides.OceanTides>, GPPatriusWithObjects<fr.cnes.sirius.patrius.forces.gravity.tides.OceanTides>, MouseWheelListener, EventListener

public class GPOceanTidesForceModel
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.gravity.tides.OceanTides>

Class containing the widget to define the Ocean Tides force model. It is limited to the GINS2004 Tides standard convention.

Author:

ffsm

Default Constraint(s):

Index	Class	Item	Constraint
0	GCheckBoxWithIndicator	oceanTidesCheckBox	0, 0, 0 => "newline , gapleft 0 , split 2" 0, 0, 1 => (null) 0, 1 => (null)
1	GEntryReal	waterDensityEntryReal	1, 0, 0 => "newline , gapleft 20 , split 2" 1, 0, 1 => (null) 1, 1 => "split 2" 1, 2 => (null)
2	GEntryInt	orderOceanTidesEntryInt	2, 0, 0 => "newline , gapleft 20 , split 2" 2, 0, 1 => (null) 2, 1 => (null)
3	GEntryInt	degreeOceanTidesEntryInt	3, 0, 0 => "newline , gapleft 20 , split 2" 3, 0, 1 => (null) 3, 1 => (null)
4	GCheckBoxWithIndicator	withAdmittanceCheckBox	4, 0, 0 => "newline , gapleft 20 , split 2" 4, 0, 1 => (null) 4, 1 => (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.genius.main.GComponent

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GPOceanTidesForceModel() Empty constructor.
GPOceanTidesForceModel(String widgetId, String label) 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()
fr.cnes.sirius.patrius.frames.Frame	getEarthFrame() Getter for the Earth frame.
Double	getEqRadius() Getter for the Earth equatorial radius.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxForceModel() Getter for the GCheckBoxWithIndicator defining if the force model is active.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxWithAdmittance() Getter for the GCheckBoxWithIndicator defining the usage of admittance.
fr.cnes.genius.highLevel.GEntryInt	getGEntryIntTidesDegree() Getter for the GEntryInt defining the tides degree.
fr.cnes.genius.highLevel.GEntryInt	getGEntryIntTidesOrder() Getter for the GEntryInt defining the tides order.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealWaterDensity() Getter for the GEntryReal defining the water density.
fr.cnes.genius.highLevel.GLabelWithIndicator	getGLabel() Getter for the GLabel of the widget.
Double	getMu() Getter for the Earth gravitational constant.
fr.cnes.sirius.patrius.forces.gravity.tides.OceanTides	getPatriusObject() Returns the PATRIUS object associated to a GENOPUS widget.
fr.cnes.sirius.patrius.forces.gravity.tides.OceanTides	getPatriusObject(Object... args) Returns the PATRIUS object associated to a GENOPUS widget.
fr.cnes.genius.main.GComponent	getSubComponent(int position)
boolean	isEnabled()
boolean	isModified()
boolean	isSelected() Checks if the ocean tides force is selected.
void	read()
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 mu) Setter for the Earth frame.
void	setEnabled(boolean b)
void	setEqRadius(Double eqRadius) Setter for the Earth equatorial radius.
void	setMu(Double mu) Setter for the Earth gravitational constant.
void	updateCondensedStatus(fr.cnes.genius.main.GCondensedStatus condensedStatus)
protected void	updateIsModifiedIndicator()
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

Constructor Detail

GPOceanTidesForceModel

public GPOceanTidesForceModel()

Empty constructor.

GPOceanTidesForceModel

public GPOceanTidesForceModel(String widgetId,
                              String label)

Constructor.

Parameters:

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

label - text to display in the label.

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.

getGLabel

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

Getter for the GLabel of the widget.

Returns:

the GLabel of the widget

getGCheckBoxForceModel

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

Getter for the GCheckBoxWithIndicator defining if the force model is active.

Returns:

the GCheckBoxWithIndicator defining if the force model is active

getGEntryRealWaterDensity

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

Getter for the GEntryReal defining the water density.

Returns:

the GEntryReal defining the water density

getGEntryIntTidesOrder

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

Getter for the GEntryInt defining the tides order.

Returns:

the GEntryInt defining the tides order

getGEntryIntTidesDegree

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

Getter for the GEntryInt defining the tides degree.

Returns:

the GEntryInt defining the tides degree

getGCheckBoxWithAdmittance

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

Getter for the GCheckBoxWithIndicator defining the usage of admittance.

Returns:

the GCheckBoxWithIndicator defining the usage of admittance

setMu

public void setMu(Double mu)
           throws fr.cnes.genius.exception.GArithmeticException

Setter for the Earth gravitational constant. Requiered for the force model.

Parameters:

mu - the Earth gravitational constant to be set.

Throws:

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

getMu

public Double getMu()

Getter for the Earth gravitational constant. Requiered for the force model.

Returns:

the internal Earth gravitational constant.

setEqRadius

public void setEqRadius(Double eqRadius)
                 throws fr.cnes.genius.exception.GArithmeticException

Setter for the Earth equatorial radius. Requiered for the force model.

Parameters:

eqRadius - the Earth equatorial radius to be set.

Throws:

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

getEqRadius

public Double getEqRadius()

Getter for the Earth equatorial radius. Requiered for the force model.

Returns:

the internal Earth equatorial radius.

setEarthFrame

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

Setter for the Earth frame. Requiered for the force model.

Parameters:

mu - the Earth frame to be set.

getEarthFrame

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

Getter for the Earth frame. Requiered for the force model.

Returns:

the internal Earth 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

getPatriusObject

public fr.cnes.sirius.patrius.forces.gravity.tides.OceanTides getPatriusObject()
                                                                        throws GPForcesException

Returns the PATRIUS object associated to a GENOPUS widget.

Specified by:

getPatriusObject in interface GPPatrius<fr.cnes.sirius.patrius.forces.gravity.tides.OceanTides>

Returns:

the PATRIUS object associated to the widget.

Throws:

GPForcesException - if mu, the equatorial radius or the Earth frame have not been initialized or if there is a problem getting the coefficients provider

getPatriusObject

public fr.cnes.sirius.patrius.forces.gravity.tides.OceanTides 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.gravity.tides.OceanTides>

Parameters:

args - The parameters are 0: Double, 1: Double, 2: 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.

isSelected

public boolean isSelected()

Checks if the ocean tides force is selected.

Returns:

true if the ocean tides force is selected, false otherwise.

isModified

public boolean isModified()

Overrides:

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

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

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

updateCondensedStatus

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

Specified by:

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

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