fr.cnes.genopus.forces

Class GPSRPForceModel

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genopus.forces.GPSRPForceModel

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.radiation.SolarRadiationPressureEllipsoid>, GPPatriusWithObjects<fr.cnes.sirius.patrius.forces.radiation.SolarRadiationPressureEllipsoid>

public class GPSRPForceModel
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.radiation.SolarRadiationPressureEllipsoid>

Class containing the widget to define the Solar Radiation Pressure force model.

Author:

ffsm

Default Constraint(s):

Index	Class	Item	Constraint
0	GCheckBoxWithIndicator	sRPCheckBox	0, 0, 0 => "newline , gapleft 0 , split 2" 0, 0, 1 => (null) 0, 1 => (null)
1	GEntryReal	refDistEntryReal	1, 0, 0 => "newline , gapleft 20 , split 2" 1, 0, 1 => (null) 1, 1 => "split 2" 1, 2 => (null)
2	GEntryReal	refPressureEntryReal	2, 0, 0 => "newline , gapleft 20 , split 2" 2, 0, 1 => (null) 2, 1 => "split 2" 2, 2 => (null)
3	GEntryReal	multipSRPEntryReal	3, 0, 0 => "newline , gapleft 20 , split 2" 3, 0, 1 => (null) 3, 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

Modifier and Type	Field and Description
static fr.cnes.genius.unit.GMetricUnit[]	UNITS_DISTANCE Distance units.
static fr.cnes.genius.unit.GMetricUnit[]	UNITS_FORCE_BY_SURF Force units.

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

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GPSRPForceModel(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.sirius.patrius.assembly.Assembly	getAssembly() Getter for the assembly.
fr.cnes.sirius.patrius.bodies.ExtendedOneAxisEllipsoid	getEarthBodyShape() Getter for the Earth shape.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxForceModel() Getter for the GCheckBoxWithIndicator defining if the force model is active.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealMultip() Getter for the GEntryReal defining the multiplicative factor.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealReferenceDistance() Getter for the GEntryReal defining the reference distance.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealReferencePressure() Getter for the GEntryReal defining the reference pressure.
fr.cnes.genius.highLevel.GLabelWithIndicator	getGLabel() Getter for the GLabel of the widget.
double	getMultiplicativeFactor() Get multiplicative factor for SRP.
fr.cnes.sirius.patrius.forces.radiation.SolarRadiationPressureEllipsoid	getPatriusObject() Returns the PATRIUS object associated to a GENOPUS widget.
fr.cnes.sirius.patrius.forces.radiation.SolarRadiationPressureEllipsoid	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.
boolean	isEnabled()
boolean	isModified()
boolean	isSelected() Checks if the SRP force is selected.
void	read()
void	setAssembly(fr.cnes.sirius.patrius.assembly.Assembly assembly) Setter for the assembly.
void	setConstraint(int widgetGap) Setter for the constraints of the widget.
void	setDefaultConstraints() Method to set the default constraints for the layout.
void	setEarthBodyShape(fr.cnes.sirius.patrius.bodies.ExtendedOneAxisEllipsoid earthBodyShape) Setter for the Earth shape.
void	setEnabled(boolean b)
void	setMultiplicativeFactor(double multiplicativeFactor) Set multiplicative factor for SRP.
void	setSun(fr.cnes.sirius.patrius.bodies.CelestialBody sun) Setter for the Sun celestial bod.
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, 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

Field Detail

UNITS_DISTANCE

public static final fr.cnes.genius.unit.GMetricUnit[] UNITS_DISTANCE

Distance units.

UNITS_FORCE_BY_SURF

public static final fr.cnes.genius.unit.GMetricUnit[] UNITS_FORCE_BY_SURF

Force units.

Constructor Detail

GPSRPForceModel

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

getGEntryRealReferenceDistance

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

Getter for the GEntryReal defining the reference distance.

Returns:

the GEntryReal defining the reference distance

getGEntryRealReferencePressure

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

Getter for the GEntryReal defining the reference pressure.

Returns:

the GEntryReal defining the reference pressure

getGEntryRealMultip

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

Getter for the GEntryReal defining the multiplicative factor.

Returns:

the GEntryReal defining the multiplicative factor

setAssembly

public void setAssembly(fr.cnes.sirius.patrius.assembly.Assembly assembly)

Setter for the assembly. Requiered for the force model.

Parameters:

assembly - the assembly to be set.

getAssembly

public fr.cnes.sirius.patrius.assembly.Assembly getAssembly()

Getter for the assembly. Requiered for the force model.

Returns:

the internal assembly.

setEarthBodyShape

public void setEarthBodyShape(fr.cnes.sirius.patrius.bodies.ExtendedOneAxisEllipsoid earthBodyShape)
                       throws fr.cnes.genius.exception.GArithmeticException

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

Parameters:

earthBodyShape - the Earth shape to be set.

Throws:

fr.cnes.genius.exception.GArithmeticException - if equatorial radius or flatness in earthBodyShape are NaN

getEarthBodyShape

public fr.cnes.sirius.patrius.bodies.ExtendedOneAxisEllipsoid getEarthBodyShape()

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

Returns:

the internal Earth shape.

setSun

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

Setter for the Sun celestial bod. Requiered for the 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 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

getPatriusObject

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

Returns the PATRIUS object associated to a GENOPUS widget.

Specified by:

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

Returns:

the PATRIUS object associated to the widget.

Throws:

GPForcesException - if the assembly, the Earth shape or the Sun body have not been initialized or if the Sun celestial body cannot be built

getPatriusObject

public fr.cnes.sirius.patrius.forces.radiation.SolarRadiationPressureEllipsoid 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.radiation.SolarRadiationPressureEllipsoid>

Parameters:

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

isSelected

public boolean isSelected()

Checks if the SRP force is selected.

Returns:

true if the SRP force is selected, false otherwise.

setMultiplicativeFactor

public void setMultiplicativeFactor(double multiplicativeFactor)
                             throws fr.cnes.genius.exception.GArithmeticException

Set multiplicative factor for SRP.

Parameters:

multiplicativeFactor - the multiplicativeFactor to set

Throws:

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

getMultiplicativeFactor

public double getMultiplicativeFactor()

Get multiplicative factor for SRP.

Returns:

the multiplicativeFactor

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