fr.cnes.genopus.forces

Class GPThirdBodyForceModel

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genopus.forces.GPThirdBodyForceModel

All Implemented Interfaces:

fr.cnes.genius.main.GClear, fr.cnes.genius.main.GDisplay, fr.cnes.genius.main.GListener, fr.cnes.genius.main.GReadWrite, GPPatrius<fr.cnes.sirius.patrius.forces.gravity.ThirdBodyAttraction[]>, GPPatriusWithObjects<fr.cnes.sirius.patrius.forces.gravity.ThirdBodyAttraction[]>

public class GPThirdBodyForceModel
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, GPPatriusWithObjects<fr.cnes.sirius.patrius.forces.gravity.ThirdBodyAttraction[]>

Class containing the widget to define the Third body force models for the Sun, the Moon, Venus, Mars and Jupiter.

Author:

ffsm

Default Constraint(s):

Index	Class	Item	Constraint
0	GCheckBoxWithIndicator	thirdBodyCheckBox	0, 0, 0 => "newline , gapleft 0 , split 2" 0, 0, 1 => (null) 0, 1 => (null)
1	GCheckBoxWithIndicator	thirdBodyMoonCheckBox	1, 0, 0 => "newline , gapleft 20 , split 2" 1, 0, 1 => (null) 1, 1 => (null)
2	GCheckBoxWithIndicator	thirdBodySunCheckBox	2, 0, 0 => "newline , gapleft 20 , split 2" 2, 0, 1 => (null) 2, 1 => (null)
3	GCheckBoxWithIndicator	thirdBodyVenusCheckBox	3, 0, 0 => "newline , gapleft 20 , split 2" 3, 0, 1 => (null) 3, 1 => (null)
4	GCheckBoxWithIndicator	thirdBodyMarsCheckBox	4, 0, 0 => "newline , gapleft 20 , split 2" 4, 0, 1 => (null) 4, 1 => (null)
5	GCheckBoxWithIndicator	thirdBodyJupiterCheckBox	5, 0, 0 => "newline , gapleft 20 , split 2" 5, 0, 1 => (null) 5, 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
GPThirdBodyForceModel(String widgetId, String label) Constructor.

Method Summary

Methods

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.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxForceModel() Getter for the GCheckBoxWithIndicator defining if the force model is active.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxJupiter() Getter for the Jupiter checkbox.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxMars() Getter for the Mars checkbox.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxMoon() Getter for the Moon checkbox.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxSun() Getter for the Sun checkbox.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxVenus() Getter for the Venus checkbox.
fr.cnes.genius.highLevel.GLabelWithIndicator	getGLabel() Getter for the GLabel of the widget.
fr.cnes.sirius.patrius.forces.gravity.ThirdBodyAttraction	getJupiterForceModel() Get the jupiter perturbation force model.
fr.cnes.sirius.patrius.forces.gravity.ThirdBodyAttraction	getMarsForceModel() Get the mars perturbation force model.
fr.cnes.sirius.patrius.bodies.CelestialBody	getMoon() Getter for the Moon celestial body.
fr.cnes.sirius.patrius.forces.gravity.ThirdBodyAttraction	getMoonForceModel() Get the moon perturbation force model.
fr.cnes.sirius.patrius.forces.gravity.ThirdBodyAttraction[]	getPatriusObject() Returns the PATRIUS object associated to a GENOPUS widget.
fr.cnes.sirius.patrius.forces.gravity.ThirdBodyAttraction[]	getPatriusObject(Object... args) Returns the PATRIUS object associated to a GENOPUS widget.
fr.cnes.genius.main.GComponent	getSubComponent(int position)
fr.cnes.sirius.patrius.bodies.CelestialBody	getSun() Getter for the Sun celestial body.
fr.cnes.sirius.patrius.forces.gravity.ThirdBodyAttraction	getSunForceModel() Get the sun perturbation force model.
fr.cnes.sirius.patrius.forces.gravity.ThirdBodyAttraction	getVenusForceModel() Get the venus perturbation force model.
boolean	isEnabled()
boolean	isModified()
boolean	isMoonSelected() Checks if the third body Moon force is selected.
boolean	isSelected() Checks if the third body force is selected.
boolean	isSunSelected() Checks if the third body Sun 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	setEnabled(boolean b)
void	setMoon(fr.cnes.sirius.patrius.bodies.CelestialBody moon) Setter for the Moon celestial body.
void	setSun(fr.cnes.sirius.patrius.bodies.CelestialBody sun) Setter for the Sun celestial body.
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, parseSimpleConstraint, processGEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDisplayIsModifiedIndicator, setElement, setForcedStatus, 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

GPThirdBodyForceModel

public GPThirdBodyForceModel(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

getGCheckBoxMoon

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

Getter for the Moon checkbox.

Returns:

the Moon checkbox

getGCheckBoxSun

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

Getter for the Sun checkbox.

Returns:

the Sun checkbox

getGCheckBoxVenus

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

Getter for the Venus checkbox.

Returns:

the Venus checkbox

getGCheckBoxMars

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

Getter for the Mars checkbox.

Returns:

the Mars checkbox

getGCheckBoxJupiter

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

Getter for the Jupiter checkbox.

Returns:

the Jupiter checkbox

setMoon

public void setMoon(fr.cnes.sirius.patrius.bodies.CelestialBody moon)

Setter for the Moon celestial body. Requiered for the Moon third body attraction force model.

Parameters:

moon - the Moon celestial body to be used.

getMoon

public fr.cnes.sirius.patrius.bodies.CelestialBody getMoon()

Getter for the Moon celestial body. Requiered for the Moon third body attraction force model.

Returns:

the internal Moon celestial body.

setSun

public void setSun(fr.cnes.sirius.patrius.bodies.CelestialBody sun)

Setter for the Sun celestial body. Requiered for the Sun third body attraction force model.

Parameters:

sun - the Sun celestial body to be used.

getSun

public fr.cnes.sirius.patrius.bodies.CelestialBody getSun()

Getter for the Sun celestial body. Requiered for the Sun third body attraction force model.

Returns:

the internal Sun celestial body.

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

isSelected

public boolean isSelected()

Checks if the third body force is selected.

Returns:

true if the third body force is selected, false otherwise.

isMoonSelected

public boolean isMoonSelected()

Checks if the third body Moon force is selected.

Returns:

true if the third body Moon force is selected, false otherwise.

isSunSelected

public boolean isSunSelected()

Checks if the third body Sun force is selected.

Returns:

true if the third body Sun force is selected, false otherwise.

getMoonForceModel

public fr.cnes.sirius.patrius.forces.gravity.ThirdBodyAttraction getMoonForceModel()
                                                                            throws GPForcesException

Get the moon perturbation force model.

Returns:

the moon perturbation force model

Throws:

GPForcesException - if the moon body has not been initialized

getSunForceModel

public fr.cnes.sirius.patrius.forces.gravity.ThirdBodyAttraction getSunForceModel()
                                                                           throws GPForcesException

Get the sun perturbation force model.

Returns:

the sun perturbation force model

Throws:

GPForcesException - if the sun body has not been initialized

getVenusForceModel

public fr.cnes.sirius.patrius.forces.gravity.ThirdBodyAttraction getVenusForceModel()
                                                                             throws GPForcesException

Get the venus perturbation force model.

Returns:

the venus perturbation force model or null if venus is not selected.

Throws:

GPForcesException - if the celestial body cannot be built

getMarsForceModel

public fr.cnes.sirius.patrius.forces.gravity.ThirdBodyAttraction getMarsForceModel()
                                                                            throws GPForcesException

Get the mars perturbation force model.

Returns:

the mars perturbation force model

Throws:

GPForcesException - if the celestial body cannot be built

getJupiterForceModel

public fr.cnes.sirius.patrius.forces.gravity.ThirdBodyAttraction getJupiterForceModel()
                                                                               throws GPForcesException

Get the jupiter perturbation force model.

Returns:

the jupiter perturbation force model

Throws:

GPForcesException - if the celestial body cannot be built

getPatriusObject

public fr.cnes.sirius.patrius.forces.gravity.ThirdBodyAttraction[] getPatriusObject()
                                                                             throws fr.cnes.genius.exception.GException

Returns the PATRIUS object associated to a GENOPUS widget.

Specified by:

getPatriusObject in interface GPPatrius<fr.cnes.sirius.patrius.forces.gravity.ThirdBodyAttraction[]>

Returns:

the PATRIUS object associated to the widget.

Throws:

fr.cnes.genius.exception.GException

getPatriusObject

public fr.cnes.sirius.patrius.forces.gravity.ThirdBodyAttraction[] 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.ThirdBodyAttraction[]>

Parameters:

args - The parameters are 0: CelestialBody, 1: CelestialBody.

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.

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

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